Re: [was: generation of ocamldoc HTML documentation for libs (via cdbs)] OCaml policy for documentation
On Sun, 2007-08-26 at 17:55 +0000, Sylvain Le Gall wrote:
BTW: a note on Ocamldoc .. unless it has been fixed, this
program is still bugged and cannot generate proper documentation.
In particular, whilst variant tags can be annotated, no documentation
is generated for polymorphic variant tags.
It is also unclear what happens when camlp4/5 is used.
Functions shared by implementations in a library
may exist which are not intended to be public, there should be
some standard annotation for this (ocamldoc still documents
the function, but with a standardised 'implementation detail'
annotation).
Also I have no idea what happens if -pack is used (a poorly
thought out feature IMHO).
--
John Skaller <skaller at users dot sf dot net>
Felix, successor to C++: http://felix.sf.net
Reply to: