DocumentationNotes

 Chair for Computer Aided Medical Procedures & Augmented Reality Lehrstuhl für Informatikanwendungen in der Medizin & Augmented Reality

Back to main page.

# DocumentationNotes for the Ubitrack Library

/*
* Ubitrack - Library for Ubiquitous Tracking
* Copyright 2006, Technische Universitaet Muenchen, and individual
* contributors as indicated by the @authors tag. See the
* copyright.txt in the distribution for a full listing of individual
* contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/

/**
* @ingroup UBITRACK_GROUP
* @file
* DESCRIPTION OF THE FILE
*
*/


### Groups

Use groups to categorize files for better overview. Only put classes/functions into groups that you wish to expose to the library user, but no purely internal/helper classes. Groups have to be defined once via @defgroup like this:

/** @defgroup GROUP_NAME SHORT_DESCRIPTION
*  LONG
*  DESCRIPTION
*/


The following groups exist (add new groups here as well if you create them):

• datastructures
• tracking_algorithms
• srg_algorithms
• dataflow_framework
• dataflow_components
• api
• driver_components
• math
Groups are defined in the doxygen.h header file.

### File Description

Use at the beginning of the file.

Document the overall contents, purpose and classification of the file. Also state the primary author of the file.

/**
* @ingroup UBITRACK_GROUP
* @file
* DESCRIPTION OF THE FILE
*
*/


### Class description

/**
* @ingroup UBITRACK_GROUP
* DESCRIPTON
*/


Use @par to have more paragraphs for longer descriptions:

 ...
* @par First Paragraph
* Documentation
*
* @par Second Paragraph
* More Documentation
...


### Function description

Document all functions and methods.

/**
* SHORT DESCRIPTION
* LONGER
* DESCRITON
* behavioral description of the function and its intendet purpose
*
* @param a the first parameter
* @param b the second parameter
* @return the returned value
* @throws what exception and under which conditions
*/


### Misc

You can add mathematical notation in tex synatx using @f$like this:  @f$res=A\times B@f\$


Formatting code (e.g. usage examples) in comments:

   \code ... \endcode


Write parameters of a function in typewriter font:

   The optimization process is controlled by parameter \p p


Writing other words of code:

   Use the function \c testOptimizer to test the optimizer


Edit | Attach | Refresh | Diffs | More | Revision r1.13 - 22 Dec 2008 - 13:49 - PeterKeitler

Lehrstuhl für Computer Aided Medical Procedures & Augmented Reality