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

Create doc-cmt tool #51

Open
lpw25 opened this issue Jun 9, 2015 · 1 comment
Open

Create doc-cmt tool #51

lpw25 opened this issue Jun 9, 2015 · 1 comment

Comments

@lpw25
Copy link
Collaborator

lpw25 commented Jun 9, 2015

Doc-ock will work with OCaml 4.02.2 when it is released. However, it will not work for people using camlp4.

There needs to be a tool based on the original docs patch for creating "enhanced" cmt files containing doc strings.

The tool would also allow support for versions 4.02.0 and 4.02.1 but, since those are essentially deprecated by 4.02.2, it is probably not worth the trouble.

@dsheets
Copy link
Contributor

dsheets commented Sep 7, 2015

It appears that there is basically no support for interfaces compiled with camlp4. This prevents prose documentation generation for core, async, and mirage libraries in general. Could you detail what, exactly, this tool would do? It sounds like it may be a better user experience to modify camlp4 to help it retain documentation comments. I don't know how painful that modification would be, though.

Also, the title of this issue is a bit misleading. Maybe "support camlp4"?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants