Документирование псевдонима типа создания экземпляра шаблона в заголовке с помощью DoxygenC++

Программы на C++. Форум разработчиков
Ответить
Anonymous
 Документирование псевдонима типа создания экземпляра шаблона в заголовке с помощью Doxygen

Сообщение Anonymous »

У меня есть файл include/Interface.h, который выглядит примерно так:

Код: Выделить всё

/**
* @file Interface.h
* @brief This is an interface file.
*/

namespace MyNamespace {
/**
* @brief Template struct representing a generic signal.
* @tparam SIGNAL_TYPE The data type of the signal value (e.g., double, float, uint8_t, etc.).
*/
template  struct Signal
{
bool valid = false;   ///< Indicates the signal is valid.
SIGNAL_TYPE value = 0 ///< The signal's value

/**
* @brief Equality operator for Signal.
* @param other The other Signal to compare against.
* @return If both signals are available, compares their values.
* If not available, checks if the other is also not available.
*/
bool operator==(const Signal& other) const
{
return (available ? other.available && value == other.value : !other.available);
}
};

/**
* @brief Struct representing a double Signal.
*/
using DoubleSignal = Signal;

}
При использовании mkdocs с плагином mkdoxy я создаю документацию по вышеуказанному интерфейсу, но DoubleSignal не отображается.
Это конфигурация для вышеуказанного проекта в mkdocs.yml:

Код: Выделить всё

       doxy-cfg:
FILE_PATTERNS: "*.cpp *.h* *.md"
RECURSIVE: YES
INPUT: include
GENERATE_XML: YES
EXTRACT_ALL: YES
Я пробовал добавить @typedef DoubleSignal раньше, но это не сработало (даже когда я изменил using на typedef).
Есть мысли, как заставить doxygen генерировать этот тип в интерфейсе?
И если да, могу ли я каким-то образом сказать doxygen включить документацию Signal в DoubleSignal с двойным в качестве typename?
РЕДАКТИРОВАТЬ
В соответствии с просьбой в комментариях я добавил изображение того, как сайт выглядит при запуске mkdocs :
Изображение


Подробнее здесь: https://stackoverflow.com/questions/798 ... -a-doxygen
Ответить

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

Вернуться в «C++»