This is the mail archive of the
xconq7@sources.redhat.com
mailing list for the Xconq project.
Documenting while making changes
- From: "Stanley Sutton" <sutton at t-surf dot com>
- To: <xconq7 at sources dot redhat dot com>
- Date: Thu, 25 Jul 2002 08:47:34 -0500
- Subject: Documenting while making changes
You might consider adding Doxygen commenting to functions,
macros,variables, and the like while you make changes.
Functions and macro definitions look like:
/*! \brief Is Controlled?
*
* Check to see if the cell(x,y) is controlled by a side.
* \see control_side_at.
* \param x is the x location.
* \param y is the y location.
* \return
* - TRUE if Side number is not \ref NOCONTROL;
* _ FALSE otherwise.
*/
#define controlled(x,y) (control_side_at(x,y) != NOCONTROL)
<\brief> short description
blank line
Long description
<\see> list of functions/macros used in function
<\param> name followed by description of parameter, repeated for each
parameter.
<\return> description of return value
- The <sp><sp><-><sp> is a bulleted list, " -# " is a numbered list.
a multi-level list can be created by indenting lines more, all items at
the same indentation level belong to the same list.
<\ref> has two forms
\ref name
\ref name "phrase"
It's basically a hyper link.
Some predifined references:
\Unit - reference to Unit data structure, use for pointers to a_unit,
not types.
\Units - same as \Unit, just a plural.
\Side - reference to a pointer to the a_side data structure.
\Sides
\Player - reference to a pointer to a_player data structure.
\Players
\Object - refernce to a pointer to a_obj data sturcture.
\Objects
The reference manual for Doxygen is available online at:
http://www.stack.nl/~dimitri/doxygen/index.html
The refeence to the manual is in the upper right corner of the home
page.