При использовании C ++ с doxygen я хотел бы добавить описание класса изнутри функции. Я в основном хочу добавить информацию о вызовах функций, которые я делаю.
class_name.h
/**
* This is the overall description of the class
*/
class ClassName
{
...
}
class_name. cpp:
void ClassName::randomFunction()
{
/**
* @class ClassName
*
* calls testData on stuff (this should be appended to the class description)
*/
testData(stuff);
}
Выход кислорода:
<b>Detailed Description</b>
<br>
This is the overall description of the class
<br>
calls testData on stuff
Этот метод работает, когда я помещаю комментарий вне функции, но нигде не отображается, если я помещаю его в randomFunction, как показано в примере. В конце я хотел бы, чтобы читатель документации увидел описание класса, за которым последовал фрагмент, который я имею в примере. Это облегчает синхронизацию моей документации с кодом и немедленно сообщает пользователю о важных функциях, которые я вызываю.
Причина, по которой я хочу это сделать, заключается в документировании сетевых сообщений о том, что класс делает в одном месте вместо поиска пользователем документации по нескольким функциям-членам.
РЕДАКТИРОВАТЬ: версия doxygen составляет 1.8.5
добавлено уточнение