Doxygen：将特定的 doxygen 定义提取到单独的文档中答案

【问题标题】：Doxygen: extract specific doxygen defines into separate documentaionDoxygen：将特定的 doxygen 定义提取到单独的文档中
【发布时间】：2018-08-25 14:51:13
【问题描述】：

我有一些带有现有 doxygen 参数的源代码（STM32 Peripherial Lib），我的 Doxygen 可以毫无问题地构建这些参数。

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

这可能吗？

我已经添加了这个进行测试：

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

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

亲切的问候安迪

【问题讨论】：

你看过doxygen配置文件（Doxyfile）中的ALIASES了吗？

标签： doxygen

【解决方案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），其中包含您记录的项目（此处：andreas 和 @987654340 @) 与命令后面的独占段落。结果：

【讨论】：

您好，非常感谢您的回复。这是非常有帮助的。我添加了一个别名并在我的源代码文档中添加了一行。但我还有一个问题。我可以将实际文件名添加到我的别名或源代码文档中吗？我尝试了几件事，但我无法将文件名放入其中。
我很高兴能帮助你@duderino65！我不确定我是否可以回答您的第二个问题（您的comment 中的那个），但我会调查一下。您应该考虑formally ask a new question，因为这比您单独发表评论更有可能引起其他社区成员的关注。
@duderino65，您的第二个问题（comment 中的那个）似乎已经在 Doxygen 邮件列表中出现在 asked 上，后来甚至在 SO 上出现在 here 上。后者要求提供文件的链接，但我想结果应该是令人满意的。不幸的是，两者都还没有得到答复。
@duderino65：我对你的第二个问题（comment 中的那个）有一个answer。
再次感谢您的帮助。这对我来说很好。我在我的 Linux Buildserver 和 Jenkins 上设置了它。我可以提取我使用这个主题生成的实际 html 文件。在 Windows 上，当 mintty.exe（来自 Git For Windows 的 git bash）调用此脚本时，该脚本正在运行。但是当我在 Windows 上开始 make 时它不起作用。一件事是 INPUT_FILTER = ./filter.sh 中的“./”，还有一些我现在没有得到的其他问题。但这对我来说是一个很好的解决方案，可以在 jenkins 上构建这个额外的文档。谢谢和亲切的问候安迪