Рассмотрим следующий C++ декларации макроса:Doxygen краткое описание внутри макроподстановкам
#define DECLARE_OBJECT_HANDLE(x) \
typedef struct x##HandleTag *x##Handle; \
typedef struct x##Handle *P##x##Handle
Я хочу, чтобы отметить свою вторую декларацию указателя с некоторыми комментариями Doxygen. В идеале я хотел бы, чтобы второй дескриптор имел ссылку на первую, только с кратким описанием, в котором говорится, что это указатель на этот тип.
Я изменил мой макрос:
#define DECLARE_OBJECT_HANDLE(x) \
typedef struct x##HandleTag *x##Handle; \
/**
* \brief Pointer to x##Handle.
*/ \
typedef struct x##Handle *P##x##Handle
Я был очень удивлен, когда я узнал, что это как-то работает! К сожалению, есть дополнительная секция для каждого typefef с каким-то странным характером:
Я действительно не люблю нижнюю часть, потому что у меня нет ничего больше, чтобы сказать об этом. Является ли это ошибкой в doxygen, что он создает дополнительный раздел, когда я только просил краткое описание?
Есть ли способ предотвратить это?
PS: Я использую doxygen версию 1.8.12 на Window 8.1 64-bit.
Этот странный символ является маркером из неупорядоченного списка. Вы пробовали пропустить '*' перед '\ brief' doxycommand? –
@ Torbjörn Спасибо, это сработало! У вас есть объяснение, почему это происходит или это просто дикая догадка? У меня нет большого опыта работы с doxygen – Gotcha
Это было образованное предположение, поскольку звездочка в начале строки указывает на неупорядоченный список в Markdown. Вы можете выяснить, действительно ли это происходит, когда вы отключите поддержку Markdown в своем Doxyfile. Тогда вы можете сообщить об ошибке для разработчиков Doxygen. –