Как проанализировать заголовочный файл C / C ++ с помощью doxygen (теперь для вызова API doxygen?)

Question

Я прокомментировал мой исходный файл с синтаксисом doxygen, пример:

/**
 * @brief get Root tree
 */
void get() {}

Теперь я хочу получить краткое сообщение о функции через API doxygen, кто может мне помочь, как это сделать?

Answer 1

Я считаю, что лучший способ получить доступ к такого рода информации - создать файл XML с помощью Doxygen , а затем использовать вашу любимую библиотеку для анализа XML для доступа к ней.

Answer 2

Вывод XML является предпочтительным способом извлечения информации, собранной doxygen.

Вы можете использовать свой любимый анализатор XML или скачать исходный пакет doxygen и посмотреть в addon / doxmlparser API C ++ для взаимодействия с выводом XML doxygen. Этот синтаксический анализатор оптимизирован для эффективной обработки потенциально большого объема XML-данных, создаваемых doxygen.

В качестве альтернативы вы также можете напрямую взаимодействовать с внутренностями doxygen. Для примера посмотрите на addon / doxyapp в пакете с исходным кодом. Обратите внимание, что это более изменчивый интерфейс, и при таком подходе вы обязаны соблюдать условия GPL v2.