Documentare le funzioni in C++ con Doxygen

Question

Ho un progetto che sto utilizzando Doxygen per generare documentazione. La documentazione delle classi va bene, ma ho anche alcune funzioni che uso in main() per creare oggetti, ecc. Mi piacerebbe anche averli nella mia documentazione, ma non ho capito come farlo. Eventuali suggerimenti?

Answer 1

Usa \fn dove altrimenti utilizzare \class nel \\*!*\ blocco

http://www.doxygen.nl/docblocks.html
look per "Documentazione in altri luoghi"

http://www.doxygen.nl/commands.html#cmdfn
Funziona in modo analogo a documentare le funzioni di membro

Answer 2

Questo il modello ha funzionato bene per noi.

/*! Convert counts to kg for the reservoir. 
    \param counts The A/D counts to convert.` 
    \return The calculated kg based on the parameter. 
*/ 
float RES_ConvertCountsToValue(uint_16 counts); 

Answer 3

mi piace questo modello

/////////////////////////////////////////////////////////////////////// 
    /// \brief setX 
    /// \param x offset of the image. 
    /// \return a new image as an QImage. 
    ///////////////////////////////////////////////////////////////////////// 
    QImage setX(int x); 

Answer 4

entità che sono membri di classi sono documentati solo se la loro classe è documentata. Le entità dichiarate nello spazio dei nomi sono documentate solo se il loro spazio dei nomi è documentato. Le entità dichiarate nell'ambito del file sono documentate solo se il loro file è documentato.

Quindi, per documentare una funzione libera nel namespace globale è necessario anche una linea come questa da qualche parte nel file di intestazione in cui si dichiara:

/** @file */ 

O come questa:

/*! \file */