Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API docs generated by OCamldoc missing internal references #32

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

API docs generated by OCamldoc missing internal references #32

darioteixeira opened this issue Mar 26, 2015 · 4 comments

Comments

@darioteixeira
Copy link
Owner

@darioteixeira 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 API docs generated by OCamldoc is missing internal references API docs generated by OCamldoc missing internal references Mar 26, 2015
@agarwal
Copy link

@agarwal agarwal commented Mar 26, 2015

Just wait for codoc.

@darioteixeira
Copy link
Owner Author

@darioteixeira 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
Copy link
Contributor

@Drup Drup commented Mar 26, 2015

+1, wait for codoc.

@agarwal
Copy link

@agarwal 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
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.