Installation

$ sudo apt-get install doxygen doxygen-gui doxygen-doc graphviz

Ubuntu User Wiki: Doxygen

Konfiguration

MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = NO

Dokumentation

Hauptseite

/** @mainpage XCTL 
 *  
 *  @section sec1 Einleitung 
 *  Hier folgt eine kurze Einleitung... 
 * 
 *  @section sec2 Subsysteme 
 *  @subsection sec2_1 Motorsteuerung 
 *  @subsection sec2_2 Ablaufsteuerung  
 */

Klassen

/** Klasse realisiert Beispiel2.  
 *   
 *  @author David Damm  
 *  @date 2.7.2004 
 * 
 *  @version 0.2 
 *  Toten Code entfernt. 
 * 
 *  @version 0.1 
 *  Kommentare hinzugefügt (Doxygen). 
 */
class Beispiel2
{
} 

Funktionen

/** Klasse realisiert Beispiel3.  
 *  
 *  @author David Damm 
 *  @date 2.7.2004 
 */
class Beispiel3
{
  public:
  /** Addiert zwei ganze Zahlen.  
   *  @param[in] a Die erste Zahl. 
   *  @param[in] b Die zweite Zahl.  
   *  @return Die Summe der beiden Zahlen a und b.  
   *  @see Addiere(double,double)  
   */
  int Addiere(int a, int b);
  double Addiere(double a, double b);
}

Strukturen

/**
 * @brief Use brief, otherwise the index won't have a brief explanation.
 *
 * Detailed explanation.
 */
typedef struct BoxStruct_struct {
  int a;    /**< Some documentation for the member BoxStruct#a. */
  int b;    /**< Some documentation for the member BoxStruct#b. */
  double c; /**< Etc. */
} BoxStruct;

oder

/**
 * @struct BoxStruct_struct
 * @brief  brief explanation
 *
 * @var    BoxStruct_struct::a
 * @brief  Some documentation for the member
 */

Links

Doxygen
David Damm: Dokumentationswerkzeug Doxygen
Doxygen usage example (for C)
Document the code with Doxygen