File: QMWedit Doxygen Guidelines.doc QMWEdit

Date: 11/01/2005 - jn

Doxygen Documentation Guidelines

1General Guidelines

2Classes

Required Tags

Voluntary Tags

\brief

Brief description of the class

\bug

Describe a bug in the class

\author

Author of the class

\todo

TODO list

\date

Date the class was written



\version

Version of the class







Example : file.hpp

///////////////////////////////////////////////////////////////////////////////

///

/// \class ExampleClass

/// \brief Brief description (one line)

///

/// Detailed description, probably on

/// multiple lines

///

/// \author Juergen P. Messerer

/// \date 30.02.2004

/// \version 0.1

///

///////////////////////////////////////////////////////////////////////////////

///

/// Project : QMWEdit

/// License : Gnu Public License (GPL)

/// Copyright(c) : Juergen P. Messerer 2001.

/// Revised on :

///

///////////////////////////////////////////////////////////////////////////////

class ExampleClass

{

...
}

Example file.cpp

/////////////////////////////////////////////////////////////////////

//

// File : file.cpp

// Class : GeneralOption

// Description : This class reads, writes and stores the option

// informations.

// Author : Juergen P. Messerer

// Release Date : 21th April 2003

// File Version : 0.1

//

// Project : Qmwedit

// License : Gnu Public License (GPL)

// Copyright(c) Juergen P. Messerer 2001.

// Revised on :

//

//////////////////////////////////////////////////////////////////////

ExampleClass::ExampleClass()

{

...
}

Functions

Required Tags

Voluntary Tags

\brief

Brief description of the function

\pre

Precondition

\param

Description of the parameters

\post

Postcondition

\return

Description of the return value (use “\return Nothing (void)” for methods of type void)







Example

////////////////////////////////////////////////////////////////////////////////// \brief Brief description (one line)

///

/// Detailed description, probably on

/// multiple lines

///

/// \pre This is a pre-condition description

/// \post A post-condition description could be write down here.

///

/// \param p1 First parameter

/// \param p2 Second parameter

/// \return Description of the return value

///

private int add(int p1, int p2)

{

...
}

3Variables


Example

////////////////////////////////////////////////////////////////////////////////// Brief description only

private int var1;



////////////////////////////////////////////////////////////////////////////////// \brief Brief description and...

///

/// detailed description, probably on

/// multiple lines

private int var2;


4Enums


Example

///////////////////////////////////////////////////////////////////////////////

/// \brief Brief description

///

/// Detailed description, probably

/// multiple lines

///

enum AnotherEnum

{

V1, /*!< description of V1 */

V2 /*!< description of V2 */

};



Page 3 of 3