Doxygen：提取特定的doxygen定义为单独的文档

Question

我有一些源代码（STM32 Peripherial Lib）和现有的doxygen参数，我的Doxygen构建没有问题。

对于我的项目，我想生成一个文档，其中包含每个文件中的所有函数以及我想要添加到函数中的特定信息。但我想保留旧的信息以进行另一种doxygen配置。

这可能吗？

我已经添加了这个用于测试：

\ifnot "SECTION_DEFINE" <normal Doxygen Parameters from original Source Code> \elsif "SECTION_DEFINE" @brief Function Check TODO \endif

有了这个，我可以停用现有的文档，但我需要将这个\ ifnot \ elsif \ endif写入每个函数。 我可以只声明一个标签，只生成这个特定标签的文档吗？

亲切的问候 岸堤

Answer 1

您可以创建一个“相关页面”，其中只有\xrefitem命令才会显示您的附加信息。由于\xrefitem还会在原始文档中创建特殊文本部分，因此您可能希望将其与使用部分标签和conditional documentation的原始想法相结合。要关闭此概念，请使用aliases以使您的文档更具可读性。

考虑这个示例代码：

/** ST documentation
 * foobar
 * \exclusive for andi's function \endif
 */
void andreas(void);

/** ST documentation
 * foobar
 * \exclusive for beni's function \endif
 */
void benjamin(void);

您可以在Doxyfile中使用此别名：exclusive=\if SECTION_DEFINE \xrefitem viparea "Exclusive" "VIPs"。

只要未定义SECTION_DEFINE，“独家”信息就不会包含在您的文档中。一旦定义了此部分，就会在HTML documentation中创建一个“相关页面”（此处：viparea.html ），其中包含您记录的项目（ here：{{ 1}}和andreas ）命令后面的独占段落。结果：