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-01 (19:52) |
From: | Arnaud Spiwack <Arnaud.Spiwack@l...> |
Subject: | Re: [Caml-list] Documenting submodules ? |
As far as I'm aware, the HTML output of ocamldoc documents submodules as hyperlinks. By clicking on them you then get to a documentation of the submodule itself. This is already something. Arnaud Spiwack David Teller a écrit : > Dear list, > > As mentioned previously, I'm working on a derivative of ExtLib > (promised, I'll submit the changes within a few days). I've put together > most of the features I want for now, but I'm faced with a problem of > documentation. Essentially, I have a few big modules containing each a > few smaller modules -- each smaller module being defined in one file. > > When invoking ocamldoc, either directly or through ocamlbuild + .odocl, > the generated documentation only contains the name of modules, without > any of the comments or even the values. > > Is there any ocamldoc plug-in or ocamlbuild plug-in or anything else > that could help me document my code without having to rewrite everything > and/or to copy and paste thousands of lines of .mli ? > > Cheers, > David > >