Software Development Methodology> Coding standards > C++ classes documentation

Release Information

Project: Siconos
Internal Release Number: 1.0
Last update: September 15, 2005
Related Documents:


next upprevious

C++ classes documentation

All the header files have to be documented using Doxygen tags, in English.

For each class, at the top of the header file, one should find the following information:

/
** \class class name
   * \brief short description of the object role
   * \author author of the first version of this class
   * \version current version
   * \date Date of creation of the first version : mm/dd/yyyy
   *
   *describe here  the main features of the class more in details 
   *
   * \bug list of potential bugs (one per line)
   * \warning list of warnings (one per line)
   * \todo add here any comment about possible improvements
   */

In the same way, each function/method has to be described as following:

 /** \fn double example(char c, int n) - Complete signature
   * method
   * \brief short description of the function purpose
   * \param char c : ... - use/origin of each parameter
   * \param int n    : ... 
   * \exception which exception(s) can be thrown
   * \return return value type
   */ 

double example(char c, int *n)


Moreover, any commentary in the .cpp file will be welcomed !!

  • Give a short description of any variable.
  • Describe all the main steps of the function process (give titles)
  • ...

next up previous