Re: Generating documentation from source code

[xueyue]

swarmdoc will make documentation jobs easy, just like we do with
javadoc. However, there are too many supporting packages
needed to be installed by each user when he wants to configurate
swarmdoc-1.4, I am wandering if there is a version
that has put all these required supporting packages such into 
one. Just like the javadoc package. For example, for linux Red Hat, if
there is a swarmdoc.rpm which includes all required 
files, then it will make things easy. 


Marcus G. Daniels wrote:
> 
> >>>>> "SL" == Sorin Lerner <address@hidden> writes:
> 
> SL> The documentation on the web seems to have been generated, at
> SL> least in part, directly from comments in the Swarm header
> SL> files. Is this the case, and if so is the tool that was used
> SL> publicly available?
> 
> Yeah, that's how it works.  It's consists of several components: an
> elisp program to parse the protocol files, elisp to generate DocBook
> SGML, and Scheme code, a.k.a. DSSSL to describe the transformation
> between the abstract SGML documentation to various presentations
> (HTML, TeX, RTF).
> 
> The (custom) parsing code is for parsing Objective C method, variable,
> function, typedefs, and macro declarations using our literate
> programming tagging conventions.  It might be useful as a tool for
> describing large Swarm models if it was repackaged a bit, though.
> 
> This stuff is in swarmdocs-1.4.1.tar.gz.
> 
>                   ==================================
>    Swarm-Support is for discussion of the technical details of the day
>    to day usage of Swarm.  For list administration needs (esp.
>    [un]subscribing), please send a message to <address@hidden>
>    with "help" in the body of the message.

-- 
Dr Xueyue Huang
Center for Transport Studies
Imperial College 
London SW7 2BU

(+-44) 171 594 6037

vcard.vcf
Description: Card for Xueyue Huang