Jason Horman's WikiDoclet

(Back in 2003 I ran a moderately popular tech blog on the Radio UserLand platform. This is an archived version of a post from that blog. You can view an index of all the archived posts.)

Wednesday, 9 April 2003

Found a link to WikiDoclet on Erik Thauvin's weblog. This is a custom doclet that allows one to write JavaDoc comments with TWiki-style markup rather than HTML markup. For example, one could write:

/**
 * First Para.
 *
 * Second Para.
 *    * bullet one
 *       * _sub_ bullet
 *    * bullet two
 */

instead of:

/**
 * First Para.
 * <p/>
 * Second Para.
 * <ul>
 *   <li>
 *    bullet one
 *    <ul>
 *     <li><i>sub</i> bullet</li>
 *    </ul>
 *   </li>
 *   <li>bullet two</li>
 * </ul>
 */

Neat, huh? Wish I'd thought of that.

I haven't tried it yet, but it seems like a really useful tool for those who find that HTML formatting within JavaDoc comments interrupts the flow of coding.


This page was generated at 9:56 PM on 15 Jan 2016.
Copyright © 1999 - 2016 Rodney Waldhoff.