[Chicken-users] Re: Missing documentation for eggs

[Mario Domenech Goulart]

Hi

I've made a very ugly and lame program to generate initial wiki
documentation for eggs based on the .meta file and on the module file.
It's at http://parenteses.org/mario/quickdoc/quickdoc.scm (needs
matchable).  It is far from perfect and has more flaws than features,
but if you are lucky, it can safe you some work when generating initial
wiki documentation for your egg.

To use it, just point it to your egg dir (i.e., the dir where it can
find the .meta file and the module file).


Example:

$ quickdoc ~/src/chicken-eggs/release/4/html-utils/

== html-utils

=== Author

<a href="http://chicken.wiki.br/users/mario-domenech-goulart";>Mario
Domenech Goulart</a>


=== Description

Procedures to ease the generation of some frequently used [X]HTML
structures


=== API

<procedure>(tabularize data #!key table-id table-class quote-procedure
even-row-class odd-row-class)</procedure>

<procedure>(itemize items #!key list-id list-class
quote-procedure)</procedure>

<procedure>(enumerate items #!key list-id list-class
quote-procedure)</procedure>

<procedure>(html-page contents #!key css title (doctype ) (headers )
charset)</procedure>

<procedure>(combo-box name options #!key default id first-empty onchange
onkeyup disabled length multiple selectedindex size tabindex type
class)</procedure>

<procedure>(hidden-input name #!optional value id)</procedure>

<procedure>(text-input name . args)</procedure>

<procedure>(submit-input . args)</procedure>


=== License

BSD


=== Version history


Best wishes
Mario