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

Camlp4 preprocessing messes up the documentation. #4545

Closed
vicuna opened this issue May 2, 2008 · 3 comments
Closed

Camlp4 preprocessing messes up the documentation. #4545

vicuna opened this issue May 2, 2008 · 3 comments

Comments

@vicuna
Copy link

vicuna commented May 2, 2008

Original bug ID: 4545
Reporter: @Chris00
Assigned to: @bobzhang
Status: closed (set by @damiendoligez on 2015-01-09T18:05:08Z)
Resolution: suspended
Priority: normal
Severity: minor
Version: 3.10.1
Target version: undecided
Category: -for Camlp4 use https://github.com/ocaml/camlp4/issues
Related to: #4346 #4713
Monitored by: @hcarty "Richard Jones"

Bug description

When I am generating the documentation on a file that is preprocessed with camlp4

/usr/bin/ocamldoc -pp "camlp4o pa_macro.cmo" -html -d doc/fftw3/html -I /usr/lib/ocaml/3.10.1/camlp4 fftw3.mli

random bits of documentation disappear or are otherwise misplaced. Everything works fine if I remove -pp "camlp4o pa_macro.cmo" (and the conditional inclusion inside the mli). To try it yourself, just checkout the library

svn co https://ocaml-fftw.svn.sourceforge.net/svnroot/ocaml-fftw ocaml-fftw

and issue "make doc". You can browse the code at

http://ocaml-fftw.svn.sourceforge.net/viewvc/ocaml-fftw/

Let me know if I can be of further help.

File attachments

@vicuna
Copy link
Author

vicuna commented May 10, 2008

Comment author: @Chris00

I have attached a very simple example. The problem shows when the doc is generated with "ocamldoc -html -pp "camlp4o pa_macro.cmo" doc.mli" (despite the total absence of macros).

@vicuna
Copy link
Author

vicuna commented Jul 28, 2013

Comment author: @bobzhang

Hi, Christophe Troestler, I can not reproduce your minimal example, would you confirm that the problem is resolved? thanks

@vicuna
Copy link
Author

vicuna commented Jan 9, 2015

Comment author: @damiendoligez

Transferred to the camlp4 github tracker:
camlp4/camlp4#64

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

No branches or pull requests

1 participant