search

darioteixeira / lambdoc

Lambdoc is a library providing support for semantically complex documents in Ocsigen web applications
GNU General Public License v2.0
17 stars 1 forks source link

API docs generated by OCamldoc missing internal references #32

Open darioteixeira opened 9 years ago

darioteixeira commented 9 years ago

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.

agarwal commented 9 years ago

Just wait for codoc.

darioteixeira commented 9 years ago

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

Drup commented 9 years ago

+1, wait for codoc.

agarwal commented 9 years ago

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.