Doxygen: Добавить новый тип или структуру

Question

Я хочу использовать doxygen для документирования c-подобного языка. У меня есть некоторые проблемы для решения ключевых слов, которые неизвестны в контексте.

Одним из примеров, я должен использовать функцию обратного вызова с именем

on timer 
{ 
    //normal c- code 
} 

Мой вопрос сейчас, я могу принять Doxygen принять новое ключевое слово? Я хочу добавить это ключевое слово, например, к функции или переменной acc. в

/** This timer is used for something. */ 
on timer 
{ 
} 

или, может быть,

/** \ontimer This timer is used for something. */ 
on timer 
{ 
} 

Документация Doxygen описывает что-то с псевдонимами или \ xrefitem, но, как я понимаю, я могу только создавать новые разделы для известных типов или я ошибаюсь? На самом деле я окружаю неизвестный код с блоком состояния, чтобы избежать ошибок в сгенерированном выходе.

Answer 1

Как я понимаю, это «на» ключевое слово, которое doxygen не может интерпретировать. Одним из решений может быть объявить ключевое слово on как predfined макрос в doxyile, используя в PREDEFINED тег следующим образом:

PREDEFINED    = on= 

Да, = в конце концов, это не опечатка! Это говорит препроцессору doxygen, чтобы заменить ключевое слово on пустой строкой. Обратите внимание, что вы должны установить ENABLE_PREPROCESSING в YES.

Если on ключевого слова появляется только перед функцией обратного вызова можно альтернативно установить PREDEFINED макрос void в:

PREDEFINED    = on=void