сфинкс + дышать + doxygen: .. doxygendefine :: работает только для файлов заголовков - PullRequest
0 голосов
/ 03 августа 2020

У меня есть проект C, который я документирую с помощью sphinx + дышите + doxygen.

Я хочу задокументировать определение с помощью

.. doxygendefine:: MY_DEFINE

Это отлично работает, пока поскольку MY_DEFINE определяется внутри файла .h. Когда он перемещается в файл. c, sphinx сообщает мне

doxygendefine: Cannot find define “MY_DEFINE” in doxygen xml output for project ...

Просмотр файлов XML, сгенерированных doxygen, показывает, что документация определения находится внутри XML. Затем я попытался использовать

.. doxygenfile:: file.c

, который генерирует всю документацию для файла. В этом выводе документации присутствует определение MY_DEFINE.

Я не думаю, что проблема заключается в моей настройке doxygen. Есть ли?

Есть ли конфигурация для дыхания, которая приводит к такому поведению?

Как я могу это исправить? Это сводит меня с ума, что документирование материалов из исходных файлов не работает.

Кстати: функции документирования также работают, только если они определены внутри файла заголовка. stati c функции в C файлах также не найдены (хотя присутствуют в выводе doxygen XML)

1 Ответ

0 голосов
/ 06 августа 2020

Я прочитал документацию еще раз и понял, что дыхание не выполняет поиск в файлах "реализации". Если я исключу C файлов из этого списка, определение будет найдено. Однако дыхание почему-то не нравится, если в вашей документации есть и файл заголовка, и файл C, содержащий прототипы и реализации. придерживайтесь доксигена на время.

...