,----
| Documentation style for Kinkatta
`----

Kinkatta uses doxygen <http://www.doxygen.org> to generate online and
hardcopy documentation.  Lots of information on the use of doxygen can
be found on the website; what follows is what you need to know in
order to document Kinkatta.

/**
 * Class brief description (one sentence).
 * Class long description.  Multiple sentences.
 * @author Joe Class Author
 */
class Foo;

/**
 * Brief structure description (one sentence)
 * Long structure description.  Multiple sentences.
 * @author Joe Struct Fewl
*/
struct nark;

/// Function (member, private, slot, signal, etc.) declaration description

/**
 * Function definition description.  Mutliple lines, sentences etc.
 * @param foo the foo parameter
 * @returns whatever the function returns
 */

int bar( int foo )
{
...
}

/// variables, member data, other stuff documentation

If you have questions, contact Adam Keys (IM: drhpbaldy email:<akeys@mail.smu.edu>)