c++ - 类似于 \see 或 \sa 的 Doxygen 别名

Question

我想定义一个行为类似于\saor的别名\see，例如，将用它标记的后续段落分组到一个部分中，并在一行中列出每个项目。

例如

\foo One
\foo Two
\foo Three

最终应该是

Foo:
  One
  Two
  Three

长话短说：行为相似\see但标签不同的别名。

Answer 1

看看\xrefitem命令。从 doxygen 文档（强调我的）：

该命令是对 和 等命令的\todo概括\bug。它可用于创建用户定义的文本部分，这些文本部分会在发生位置和将生成的相关页面之间自动交叉引用。在相关页面上，将收集相同类型的所有部分。

文档中的示例建议您放置别名

ALIASES += "reminder=\xrefitem reminders \"Reminder\" \"Reminders\"" 

在您的配置文件中。然后写类似

\reminder test 1
\reminder test 2
\reminder test 3

在您的文档中将导致如下内容：

Reminder:  
   test 1  
   test 2  
   test 3  

唯一的问题是您将在“相关页面”选项卡下的一个名为“提醒”的附加页面下。如果您不想要这个相关页面，您可以使用自定义命令文档中记录的别名：

ALIASES += sideeffect="\par Side Effects:\n" 

这将允许您将命令\sideeffect放入文档中，这将导致用户定义的段落带有标题Side Effects:。但是，这些不会在最终文档中组合在一起（即每个\sideeffect都会生成一个副作用：标题）。