C的氧气输出答案

【问题标题】：Doxygen output for CC的氧气输出
【发布时间】：2014-07-14 13:39:44
【问题描述】：

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

有没有办法修改 Doxygen 的输出，使其更适合用 C 编写的代码？或者至少，删除“类”选项卡并只提供“文件”视图？

【问题讨论】：

i/** * @defgroup MY_C_CLASS * @{ */

标签： c doxygen

【解决方案1】：

你可以设置

OPTIMIZE_OUTPUT_FOR_C = YES

在配置文件中，获取更面向 C 的输出。

【讨论】：

【解决方案2】：

如果您在普通配置文件之外创建布局文件：

doxygen -l layout.xml

你可以编辑它；这控制了界面的基本格式。如果要删除“类”选项卡，请找到：

<tab type="classes" visible="yes" title="Types">
    [...]
</tab>

然后将其删除或将visible 更改为“否”。

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

\ingroup foobar

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

\defgroup foobar Description of foobar.

某处。这将被

使用

<tab type="modules" visible="yes" title="Modules" intro=""/>

来自layout.xml，产生一个可能比“文件”更直观的界面（例如，来自.h 的结构文档和来自.c 的函数文档如果它们在同一组中，则它们被组织在一起），类似于“类”如何与 C++ 协同工作。

the doxygen site 中有更多关于这些内容的信息。

【讨论】：

【解决方案3】：

您可以将 C 类 MY_C_CLASS 的结构和函数声明包含在以下构造中

我总是将函数的 doxygen 帮助放在帮助文件中，以便与类组分组。

/**
 * @defgroup MY_C_CLASS
 * @brief MY_C_CLASS class
 * describe here what it is all about.
 * @{
 */

 typedef struct tagMY_C_CLASS {

 } MY_C_CLASS;

 /**
  * @brief constructor
  * @return status; -1 on failure.
  */
 int MY_C_CLASS_init(MY_C_CLASS *void);

/**
 * @}
 */

【讨论】：