C的氧气输出

Pau*_*aul 5 c doxygen

我用C++代码多年来一直使用Doxygen.我想将它与我正在使用的一些C代码一起使用,但输出不是最佳的.顶部栏中的"类"选项卡仅显示struct定义,而不显示文件中的函数.我必须单击"文件"选项卡,然后单击头文件的名称以查看它包含的功能.

有没有办法修改Doxygen的输出,以便它更适合用C编写的代码?或者至少,删除"类"选项卡并仅提供"文件"视图?

dox*_*gen 5

你可以设置

OPTIMIZE_OUTPUT_FOR_C = YES
Run Code Online (Sandbox Code Playgroud)

在配置文件中,获得更加面向C的输出.


del*_*ver 3

如果除了普通配置文件之外还创建布局文件:

doxygen -l layout.xml
Run Code Online (Sandbox Code Playgroud)

您可以编辑它;这控制了界面的基本格式。如果要删除“类”选项卡,请找到:

<tab type="classes" visible="yes" title="Types">
    [...]
</tab>
Run Code Online (Sandbox Code Playgroud)

并将其删除或改为visible“否”。

C 函数和数据类型通常以非随机方式分组在文件中,因此仅“文件”选项卡可能就足够了。如果没有,请使用组:

\ingroup foobar
Run Code Online (Sandbox Code Playgroud)

可以添加到结构和函数定义等中。然后您需要一个

\defgroup foobar Description of foobar.
Run Code Online (Sandbox Code Playgroud)

某处。然后这将被使用

<tab type="modules" visible="yes" title="Modules" intro=""/>
Run Code Online (Sandbox Code Playgroud)

layout.xml,产生一个可能比“文件”更直观的界面(例如,如果 a 中的结构文档.h和 a 中的函数文档.c位于同一组中,则将它们组织在一起),类似于“类”与 C++ 的工作方式。

doxygen 网站上有更多关于此内容的信息。