[mercury-users] automatic documentation for mercury programs

[Julien Fischer]

On Tue, 30 Oct 2007, Barney Fisher wrote:

> Does anyone know of (or has written) any programs which generate
> documentation of Mercury source code? For example, one which can draw
> a module dependency graph? I'm just looking for something to provide
> an abstract view of the code that, together with a few words, I can
> give to someone else so they have some understanding of how the
> program is organised and how it works.

The compiler's --imports-graph option can be used to write out the
module dependency graph.

There's `--make-xml-doc' option that will write an XML representation
of a module with comments attached to various items.  (The intention
is to provide stylesheets that would transform this into documentation
of various formats, but we haven't done that yet.)

Cheers,
Julien.
--------------------------------------------------------------------------
mercury-users mailing list
Post messages to:       mercury-users at csse.unimelb.edu.au
Administrative Queries: owner-mercury-users at csse.unimelb.edu.au
Subscriptions:          mercury-users-request at csse.unimelb.edu.au
--------------------------------------------------------------------------