From: John Kaurin <jkaurin@...>
Date: 2001-07-07T12:27:39+09:00
Subject: [ruby-talk:17446] Re: RubyDoc.  was /* */ comments

FYI:

JavaDoc is not real restrictive in its formatting requirements,
some of the things I have done in the past (maybe good, maybe
not-so-good). Although I have not done any Java programming
in quite awhile. All the below are just blocks I grabbed from
some old code. JavaDoc processes them with no trouble.

Never liked the normal JavaDoc formatting requirements:

/**
 *
 *
 */

The above is hard to maintain for reasons noted in "Code Complete".

Snipets follow.

/***********************************************************************************************************************************

Handles the program's Graphics Status panel.

@author  John Kaurin
@version 1.0.0

***********************************************************************************************************************************/


/***********************************************************************************************************************************

   Returns the component's maximum allowable layout size.<pre></pre>

   @return A <code>Dimension</code> object that indicates the maximum size of this component.

***********************************************************************************************************************************/


   /** The AboutDialog title. **/
   public static final String TITLE = "About";


/***********************************************************************************************************************************

   Calculates the component's maximum, minimum, and perferred sizes.<pre></pre>

   This component uses all of the area remaining and not used by the other screen components.

   @return A <code>Dimension</code> object that indicates the size of this component.

***********************************************************************************************************************************/


/***********************************************************************************************************************************

   Presents a Page Setup dialog and handles the user's choices.<pre></pre>

   @param ae The <code>ActionEvent</code> taking place.

***********************************************************************************************************************************/