Re: [Caml-list] [ANN] Argot: 1.0 release

[forum@x9c.fr]

Gerd Stolpmann <info@gerd-stolpmann.de> a écrit :

> Excellent! I'll definitely use it.
>
> Another idea for a feature: more options how classes and modules are
> shown. For example, I once had the problem that I wanted an included
> module also to be included in-place in the documentation (rather than by
> reference/link). I modified the ocamldoc generator to get this effect,
> and the result is here:
>
> http://projects.camlcity.org/projects/dl/pxp-1.2.1/doc/manual/html/ref/Pxp_types.html
>
> The grey box contains actually the included definitions. This is much
> easier to understand for the casual reader. The feature is accompanied
> by a link rewriter, so the ocamldoc-generated links point to the
> including module rather the included module.
>
> A similar problem occurs for inherited class types. Of course, one wants
> to enable this on a case-by-case basis.
>
> I blogged about this some years ago:
> http://blog.camlcity.org/blog/pxp121.html
>
> The generator (very specific to this case):
> https://godirepo.camlcity.org/svn/lib-pxp/tags/pxp-1.2.1/tools/src/odoc/chtml.ml


This is an interesting feature; it may be implemented by
using some "folding" in order to have the best of both
worlds (short name by default, and unfolding upon request).


Regards,

Xavier Clerc