API docs generated by OCamldoc missing internal references #32

Open
darioteixeira opened this Issue Mar 26, 2015 · 4 comments

Comments

Projects
None yet
3 participants
@darioteixeira
Owner

darioteixeira commented Mar 26, 2015

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 darioteixeira changed the title from API docs generated by OCamldoc is missing internal references to API docs generated by OCamldoc missing internal references Mar 26, 2015

@agarwal

This comment has been minimized.

Show comment
Hide comment
@agarwal

agarwal Mar 26, 2015

Just wait for codoc.

agarwal commented Mar 26, 2015

Just wait for codoc.

@darioteixeira

This comment has been minimized.

Show comment
Hide comment
@darioteixeira

darioteixeira Mar 26, 2015

Owner

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

Owner

darioteixeira commented Mar 26, 2015

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

@Drup

This comment has been minimized.

Show comment
Hide comment
@Drup

Drup Mar 26, 2015

Contributor

+1, wait for codoc.

Contributor

Drup commented Mar 26, 2015

+1, wait for codoc.

@agarwal

This comment has been minimized.

Show comment
Hide comment
@agarwal

agarwal Mar 26, 2015

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 commented Mar 26, 2015

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment