C++ - Doxygen | wedi

You are here

C++ - Doxygen

/*! \brief kurze Beschreibung (im vorhinein)
 *  Ergaenzung der kurzen Beschreibung
 *
 *  laengerer Beschreibungstext
 */
int testVar = 0;
 
int testVar = 0;   //!< Beschreibung der Variable, nachfolgend
int testVar = 0;   /*!< Beschreibung der Variable, nachfolgend */
 
 
/*! \class testClass
 *  \brief kurze Beschreibung
 */
class testClass
{
public:
    /*! \fn    testClass
      * \brief Beschreibung des Konstruktors
      */
    testClass();
    /*! \fn    testClass
      * \brief Beschreibung des Destruktors
      */
    ~testClass();
 
    int value1;    //!< Beschreibung der Variable
 
protected:
    /*! \fn   set
     *  \brief Beschreibung von Methoden
     */
    void set(int value);
    /*! \fn   get
     *  \brief Beschreibung von Methoden
     */
    int get(void);
 
    int value2;
private:
    int value3;
};
 
 
/*! \struct    zur Dokumentation einer C-Struktur
 *  \class     zur Dokumentation einer Klasse
 *  \union     zur Dokumentation einer Union
 *  \enum      zur Dokumentation eines Enumeration Typs
 *  \fn        zur Dokumentation einer Funktion
 *  \var       zur Dokumentation einer Variable
 *  \def       zur Dokumentation eines #defines
 *  \typedef   zur Dokumentation einer Typ Definition
 *  \file      zur Dokumentation einer Datei
 *  \namespace zur Dokumentation eines Namensraumes
 */
 
 
/*! \param value1       - Beschreibung von Variablen in Parameterlisten
 *  \param [in] value1  - Beschreibung von Eingabeparametern
 *  \param [out] value1 - Beschreibung von Ausgabeparametern
 *  \return               Beschreibung des Rueckgabewertes
 *  \retval value1      - Beschreibung bestimmter Return Werte
 *  \pre                  Pre-Kondition
 *  \post                 Post-Kondition
 */
 
 
/*! \note    zusaetzliche Notizen
 *  \author  Angaben zum Erzeuger des Codes
 *  \version Version des Codes
 *  \date    Datum der Erstellung
 *  \test    Testbeschreibung
 *  \todo    Aufgaben die noch erledigt gehoeren
 */
 
/*! Erstellung einer Liste
 *  - Aufzaehlung 1
 *  - Aufzaehlung 2
 *      -# verschachtelte numerierte Aufzaehlung 1
 *      -# verschachtelte numerierte Aufzaehlung 2
 */
 
 
/*! verschiedene Textformate
 *  /verbatim Verbatim Textausgabe
 *  /endverbatim
 *
 *  /code     Codeausgabe
 *  /endcode
 */
 
/*! Einbetten einer Formel
 *
 *  \f$\sqrt{f_{under}^{over}}\f$
 *
 *  zwischen den \f$ Marken koennen standard
 *  Latex Formel Beschreibungen eingegeben werden
 */
 
 
/*! \brief <big> es koennen auch HTML Kommandos eingebunden werden </big>
 */