Clever Geek Handbook

Creating class-like diagrams for OCaml

I have a large OCaml codebase and would like to get some UML class / module diagrams from it, similar to some Java reverse engineering tools.

These diagrams do not have to be formal UML diagrams, but being able to see at least the function / type names defined in each module signature will be very helpful to help you understand the basics of OCaml code. It's even better if it can be combined with associations between modules.

Can this be done with ocamldoc

? I know it is capable of generating DOT dependency plots between modules, but I couldn't find out if it can generate information about each type / function defined in a module.

+3


source to share


2 answers


No, ocamldoc

it cannot do this unless you write the appropriate plugin yourself. As far as I know, the closest match to your needs is Facebook Pfff . It does not generate UML, but it has a dependency renderer that displays the required information as a matrix of the project structure.



+4


source


opam install odoc-depgraph

should do whatever you need if I understand the question correctly.



+1


source






More articles:


All Articles