Как показать стиль C ++, включающий синтаксис в doxygen - PullRequest
1 голос
/ 16 апреля 2019

Я помещаю комментарий doxygen в мой файл.Когда я генерирую HTML-файлы (используя приложение doxygen), я вижу

MyClass Class Reference

#include <myclass.hpp>

, который я хочу отобразить как

Справочник по классам MyClass

#include <MyClass>

Я пробовал разные варианты, но не повезло.Я попытался \ file MyClass, но все еще показывает ту же (вышеупомянутую) строку.

Вот комментарий doxygen

/**
 * \class MyClass
 *
 * \ingroup demo
 *
 * \brief Provide an example
 *
 * This class is meant as an example.  It is not useful by itself
 * rather its usefulness is only a function of how much it helps
 * the reader.  It is in a sense defined by the person who reads it
 * and otherwise does not exist in any real form. 
 *
 * \file MyClass
 *
 * Contact: abc@abc.com
 *
 * Created on: Wed Apr 13 18:39:37 2005
 *
 */

1 Ответ

3 голосов
/ 16 апреля 2019

С Doxygen FAQ :

Вы также можете задокументировать свой класс следующим образом

/*! \class MyClassName include.h path/include.h
 *
 *  Docs for MyClassName
 */

Чтобы сделать кислород, положите

#include <path/include.h>

в документации класса MyClassName независимо от имени фактического заголовочного файла, в котором определение MyClassName содержал.

Итак, я бы попробовал:

/**
* \class MyClass myclass.hpp MyClass
...
*/
...