[fluxus] auto documentation

Dave Griffiths dave at pawfal.org
Tue Dec 5 03:03:56 PST 2006


Hi all,

So I've written an auto documentation system for the plt version of fluxus
(I think this might be hitherto refered to as fluxus2.0 or maybe fluxus
Enterprise Edition) The idea is this will strip out comments from the
binding functions (the definitions of the scheme commands in the C++ code)
and convert them into html for the function index, and also into a format
for an online help system. The idea is that from the repl you'll be able
to type:

fluxus> (help build-sphere)
"(build-sphere f f)
Arguments: Slices Stacks
Returns: Object ID

Description: Makes a polygon sphere primitive, built with the specified
resolution in width and height divisions. Returns the object ID for this
primitive.

Example: (define mysphere (build-sphere 10 10))"

...

This means documents can be checked during livecoding performances ;) It
will also be much easier to keep them up to date with this system. Are
there any more categories for this documentation?

cheers,

dave




More information about the Fluxus mailing list