Dokumentowanie funkcji w C++ przy użyciu Doxygen

Question

Mam projekt, w którym używam Doxygen do generowania dokumentacji. Dokumentacja zajęć jest w porządku, ale mam także kilka funkcji, których używam w main() do tworzenia obiektów itp. Chciałbym również je włączyć do mojej dokumentacji, ale nie miałem pojęcia, jak to zrobić. Jakieś sugestie?

Answer 1

Zastosowanie \fn gdzie można inaczej wykorzystać \class w \\*!*\ bloku

http://www.doxygen.nl/docblocks.html
szukać "Dokumentacja w innych miejscach"

http://www.doxygen.nl/commands.html#cmdfn
To działa podobnie jak dokumentowanie funkcje składowe

Answer 2

ten wzór działał dobrze dla nas.

/*! 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

Lubię ten wzór

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

Answer 4

podmioty, które są członkami klas są udokumentowane tylko jeśli ich klasa jest udokumentowane. Elementy zadeklarowane w zasięgu obszaru nazw są udokumentowane tylko wtedy, gdy ich przestrzeń nazw jest udokumentowana. Encje zadeklarowane w zasięgu pliku są udokumentowane tylko wtedy, gdy ich plik jest udokumentowany.

więc udokumentować bezpłatną funkcję w globalnej przestrzeni nazw trzeba też taką linię gdzieś w pliku nagłówka, w którym została zadeklarowana:

/** @file */ 

Albo jak ten:

/*! \file */