Re: documentation tool

On Jul 2, 2004, at 4:01 PM, Rick Giuly wrote:

> Are there any documentation tools for steve code -- maybe something 
> that generates html?

There is a basic documentation tool included in the breve source used 
for documenting
the internal classes.  If you download the source, go into the 
"docBuild" directory and
type "make", it will build the tool.

You can then use a command line this to create the docs:

	./docExtract [tzfiles] | ./docBuild.pl [output directory]

For example, when documenting the built-in breve class files, I use:

	./docExtract ../lib/classes/*.tz | ./docBuild.pl ../docs/classes

When building the documentation files, comments that begin with "%" (as 
opposed to "#")
are automatically included in the documentation.  See some of the 
built-in breve class
files for more information.


I you need more detailed documentation than this provides, you may want 
to look at
Laurie's suggestion of creating a doxygen filter.

- jon klein

_______________________________________________
breve mailing list
[email protected]
http://www.spiderland.org/mailman/listinfo/breve