Документация на С++ с Doxygen

У меня есть проект, в котором я использую Doxygen для создания документации. Документация по классам прекрасна, но у меня также есть некоторые функции, которые я использую в main() для создания объектов и т.д. Я также хотел бы иметь их в своей документации, но я не понял, как это сделать. Любые предложения?

Ответ 1

Используйте \fn, где вы в противном случае используете \class в своем блоке \\*! *\

http://www.doxygen.nl/docblocks.html
найдите "Документацию в других местах"

http://www.doxygen.nl/commands.html#cmdfn
Он работает аналогично документированию функций-членов

Ответ 2

Сущности, являющиеся членами классов, документируются только в том случае, если их класс документирован. Объекты, объявленные в области пространства имен, документируются только в том случае, если их пространство имен документировано. Объекты, объявленные в области файла, регистрируются только в том случае, если их файл документирован.

Итак, чтобы документировать свободную функцию в глобальном пространстве имен, вам также нужна строка, подобная этой, в заголовочном файле, в котором она объявлена:

/** @file */

Или вот так:

/*! \file */

Ответ 3

Этот шаблон работал хорошо для нас.

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

Ответ 4

Мне нравится этот шаблон

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