C++ ile Dozaj fonksiyonları Doxygen ile

Question

Belgeyi oluşturmak için Doxygen kullandığım bir projem var. Sınıfların belgelendirilmesi gayet iyi, ama ben de() nesneler oluşturmak için main() 'da kullandığım bazı işlevlerim var. Bunları da belgelerime eklemek istiyorum. Fakat bunu nasıl yapacağımı hiç düşünmemiştim. Baska öneri? Eğer aksi takdirde "diğer yerlerde Belgeler" için \\*!*\ blokta

http://www.doxygen.nl/docblocks.html
göz \class kullanmak

Answer 1

Kullanım \fn

http://www.doxygen.nl/commands.html#cmdfn
Bu üye fonksiyonları

Answer 2

Bu belgeleyen gibi benzer işleri desen bizim için iyi çalıştı.

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

Bu desenini onların sınıf belgelenmiştir eğer sınıfların üyeleri sadece belgelenmiştir olan

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

Answer 4

Varlıkları gibi. Ad alanı kapsamında bildirilen varlıklar, yalnızca ad alanları belgelendiyse belgelenir. Dosya kapsamında bildirilen varlıklar, yalnızca dosyalarının belgelenmesi durumunda belgelenir.

/** @file */ 

Ya da böyle:

/*! \file */ 

Yani ayrıca beyan edildiği başlık dosyasında bu yerde böyle bir hatta ihtiyacı genel ad bir serbest fonksiyonu belgelemek için