lambdoc icon indicating copy to clipboard operation
lambdoc copied to clipboard

API docs generated by OCamldoc missing internal references

Open darioteixeira opened this issue 9 years ago • 4 comments

The good news is that the abandonment of module packs and adoption of a flat hierarchy means that OCamldoc can now be used to generate the API documentation. The bad news is that OCamldoc gets very confused by the module aliases and does not generate proper internal references. Suggestions on how to fix this are welcome.

darioteixeira avatar Mar 26 '15 16:03 darioteixeira

Just wait for codoc.

agarwal avatar Mar 26 '15 16:03 agarwal

@agarwal: Well, if codoc automatically resolves module aliases to their original definition, then i'll be a very happy early adopter...

darioteixeira avatar Mar 26 '15 17:03 darioteixeira

+1, wait for codoc.

Drup avatar Mar 26 '15 17:03 Drup

codoc is very sophisticated. It goes through great effort to resolve module references, practically doing type checking. In any case, whatever it does will supersede ocamldoc, so there's little point in spending any time on ocamldoc.

agarwal avatar Mar 26 '15 17:03 agarwal