Doxygen не генерирует документацию для исходных файлов
Впервые с помощью Doxygen здесь. Используя Doxygen Wizard, я уверен, что все директории и все правильно устанавливаю, но по какой-то причине в выходной документации есть только заголовочные файлы. Мой проект написан на C, и похоже, что он полностью игнорирует исходные файлы.c и извлекает только заголовочные файлы.h из каталога.
Я предполагаю, что просто я не проверяю один из вариантов, который мне нужен, или проверяется, который не должен быть. Мои входные данные FILE_PATTERNS включают в себя.c и.h, наряду с кучей других, и все же он не будет создавать документацию для файлов.c.
Есть идеи, почему он это делает? Я не уверен, что еще я могу включить сюда, чтобы помочь вам разобраться в моей проблеме, так что просто дайте мне знать, если вам нужно, чтобы я включил что-то еще.
ОБНОВЛЕНИЕ: я нашел параметр, чтобы по крайней мере показать файлы.c в выводе html, но для них до сих пор нет документации по исходному коду. Я понятия не имею, почему он не может создать документацию по исходному коду, но он может распознавать и отображать все функции и переменные внутри них.
Input configuration is as follows:
INPUT = "C:/Users/Me/Desktop/ProjectFoler/Project"
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.c \
*.cc \
*.cxx \
*.cpp \
*.c++ \
*.java \
*.ii \
*.ixx \
*.ipp \
*.i++ \
*.inl \
*.idl \
*.ddl \
*.odl \
*.h \
*.hh \
*.hxx \
*.hpp \
*.h++ \
*.cs \
*.d \
*.php \
*.php4 \
*.php5 \
*.phtml \
*.inc \
*.m \
*.markdown \
*.md \
*.mm \
*.dox \
*.py \
*.f90 \
*.f \
*.for \
*.tcl \
*.vhd \
*.vhdl \
*.ucf \
*.qsf \
*.as \
*.js
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
EXAMPLE_PATH =
EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
FILTER_SOURCE_PATTERNS =
USE_MDFILE_AS_MAINPAGE =
Я не думаю, что структура папок будет иметь значение, потому что исходные файлы вместе с заголовочными файлами находятся непосредственно в верхнем слое каталога исходного кода, который я предоставляю для Doxygen. Но я имею в виду подпапки, в которых нет ничего важного.
3 ответа
Я думаю, что я, возможно, решил это. Похоже, теперь есть документация по исходному коду для исходных файлов.c после изменения настроек, как показано на рисунке ниже.
В Doxyfile установите EXTRACT_ALL = YES.
Значение по умолчанию - НЕТ.
Это документирует все сущности без каких-либо комментариев Doxygen Special.
Ответ пользователя 3598862 (EXTRACT_ALL = YES) выполняет свою работу, но это кувалда. Я предпочитаю оставить этот параметр выключенным и включать каждый файл .c, который мне нужен, добавляя команду «файл» в начало файла.
/**
* @file
* Application-level setup.
*/
Я вижу ссылку на эту команду в некоторых комментариях. Я добавляю это как ответ для наглядности.