Browse thread
Documenting submodules ?
[
Home
]
[ Index:
by date
|
by threads
]
[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
Date: | 2008-05-05 (09:10) |
From: | David Teller <David.Teller@u...> |
Subject: | Re: [Caml-list] Documenting submodules ? |
On Mon, 2008-05-05 at 10:35 +0200, Maxence Guesdon wrote: > Indeed, ocamldoc does not use the comment of sub.ml in the page generated > for main.ml. This is normal behaviour. I'm aware that it's the normal behaviour of ocamldoc. I'm just looking for a work-around or a plug-in. > You could comment the creation of the > Sub module (i.e. Main.Sub) by putting a comment around > module Sub = Sub I wrote that in my first post :) More seriously, it's ok if I have only one or two modules. But if I want to comment both the creation of Sub and the actual contents of Sub, it's not really a good method. Even more so since I have 70+ modules developed separately, which I attempt to present with a consistent Java-style package hierarchy. That would mean copying and pasting about 9000+ lines of code for the moment, with more coming, and nasty bugs lurking whenever the source packages are updated. > This is normal behaviour too. You're redefining a module here, and the > way it is defined is reflected by the html code generated by ocamldoc, with > a link on the Sub.SubSub page. I have a link to an empty Sub.SubSub page. Is that normal behaviour ? Cheers, David -- David Teller Security of Distributed Systems http://www.univ-orleans.fr/lifo/Members/David.Teller Angry researcher: French Universities need reforms, but the LRU act brings liquidations.