element documentation

Eddie Kohler eddietwo at cag.lcs.mit.edu
Sat Aug 5 16:59:03 EDT 2000


The formatting for element documentation has changed a bit. Mostly this was
to add more power and make it like something people already use (Perl POD
documentation, `man perlpod'). The only user-visible change is this:

Don't use `= ' for verbatim text, use `   ' (just some regular indenting).

So where you used to say
/* =e
 * = stuff
 * = bla
 */
now you say
/* =e
 *   stuff
 *   bla
 */

I've changed all the elements in the Click repository to use the new format
and will get to the Mazu elements later today.

Here are some new fun things to try in element documentation:
B<bold text>
I<italic text>
FUCK<fuck text>    (That one is not really true.)

love,
ed



More information about the click mailing list