0004545: Camlp4 preprocessing messes up the documentation.

View Issue Details [ Jump to Notes ]

[ Issue History ] [ Print ]

Project

Category

View Status

Date Submitted

Last Update

0004545

OCaml

Camlp4

public

2008-05-03 00:02

2012-09-15 20:54

Reporter

Christophe Troestler

Assigned To

Priority

normal

Severity

minor

Reproducibility

always

Status

acknowledged

Resolution

open

Platform

OS Version

Product Version

3.10.1

Target Version

4.01.0+dev

Fixed in Version

Summary

0004545: Camlp4 preprocessing messes up the documentation.

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.

Tags

No tags attached.

Attached Files

doc.mli [^] (113 bytes) 2008-05-10 11:08

Relationships

related to	0004713	feedback	dim	Camlp4o messes with comments
related to	0004346	acknowledged		Camlp4 messes up comments within and after records.

Notes
(0004507) Christophe Troestler (reporter) 2008-05-10 11:08	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).

Issue History
Date Modified	Username	Field	Change
2008-05-03 00:02	Christophe Troestler	New Issue
2008-05-10 11:08	Christophe Troestler	Note Added: 0004507
2008-05-10 11:08	Christophe Troestler	File Added: doc.mli
2008-08-01 16:20	xleroy	Assigned To	=> guesdon
2008-08-01 16:20	xleroy	Status	new => assigned
2009-03-11 08:24	guesdon	Assigned To	guesdon => ertai
2012-07-11 15:52	doligez	Relationship added	related to 0004713
2012-07-11 15:52	doligez	Assigned To	ertai =>
2012-07-11 15:52	doligez	Status	assigned => acknowledged
2012-07-11 15:52	doligez	Target Version	=> 4.01.0+dev
2012-07-11 16:06	doligez	Relationship added	related to 0004346
2012-07-31 13:36	doligez	Target Version	4.01.0+dev => 4.00.1+dev
2012-09-15 12:31	doligez	Target Version	4.00.1+dev => 4.01.0+dev