Doxygen別名類似於\ see或\ sa

Question

我想定義一個別名，其行爲類似於\sa或\see，例如，將隨後標記的段落分組到一個段落中，並在單行中列出每個項目。

例如

\foo One 
\foo Two 
\foo Three 

應該結束了作爲

Foo: 
    One 
    Two 
    Three 

長話短說：一個行爲類似\see，但有不同的標籤別名。

Answer 1

查看​​命令。從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將生成副作用：標題）。