第一次在这里使用 Doxygen。使用 Doxygen 向导,我很确定我正确设置了所有目录和所有内容,但由于某种原因,输出的文档只有头文件。我的项目是用 C 编写的,就像完全忽略了 .c 源文件,只从目录中抓取 .h 头文件。
我假设这只是我没有检查我需要的选项之一,或者检查了不应该检查的选项。我的输入 FILE_PATTERNS 包括 .c 和 .h,以及一堆其他文件,但它仍然不会为 .c 文件创建文档。
知道为什么要这样做吗?我不确定我还可以在这里添加什么来帮助你们理解我的问题,所以如果您需要我添加其他内容,请告诉我。
更新:我找到了一个设置,至少可以在 html 输出中显示 .c 文件,但仍然没有它们的源代码文档。我不知道为什么它不能创建源代码文档,但它可以识别并显示其中的所有函数和变量。
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 提供的源代码目录的顶层。但我的意思是有子文件夹,但里面没有什么重要的东西。
在 Doxyfile 中,设置 EXTRACT_ALL = YES。
默认值为 NO。
这将记录所有实体,不需要任何 Doxygen 特别注释。
我想我可能已经解决了。更改设置后,现在似乎有 .c 源文件的源代码文档,如下图所示。
用户3598862 (EXTRACT_ALL = YES) 的回答完成了工作,但是是一个大锤。我更喜欢保留该设置,并通过将“file”命令添加到文件顶部来包含我想要的每个 .c 文件。
/**
* @file
* Application-level setup.
*/
我看到一些评论中引用了这个命令。我将其添加为可见性的答案。