Doxygen别名类似于\ see或\ sa

Question

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

e.g。

\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  

唯一的问题是，您将在“相关页面”标签下的“提醒”选项卡下的其他页面下。如果您不想要此相关页面，则可以使用custom commands文档中记录的别名：

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

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