Doxygen \xrefitem 标题
Doxygen \xrefitem heading
我使用 doxygen 并想知道我对
\xrefitem 和 "heading" 是正确的吗?
在我的代码中我有:
//! \xrefitem Cars "heading" "ListName"
//! Text
这里我定义了一个key"Cars"。此键的所有匹配项都将放入 "Related Pages" 菜单。将有一个 link 和 "ListName",在其下会出现所有与该密钥相关的人工制品。
现在我希望 "heading" 是可变的,相同键的项目将放在 "ListName" 下,但在不同的 "headings" 下。
//! \xrefitem Cars "Audi" "ListName"
//! Text
//! \xrefitem Cars "Mercedes" "ListName"
//! Text
但是无论我为 "headings" 输入什么,它都不会显示,同样 "Audi" 或 "Mercedes"。
任何人都可以解释 "heading" 的用途以及我可以用它做什么以及我的理解是否正确?
手册我看了几十遍,就是不明白。
最好遵循手册中的建议并使用别名。这有助于明确改变参数(例如 "Audi" 到 "Mercedes")是没有意义的。
以手册为例
ALIASES += "reminder=\xrefitem reminders \"Reminder\" \"Reminders\""
并使用
/reminder Make Coffee
会产生类似
的结果
Reminder
Make Coffee
即标题、文字
在标记为
的页面上
Reminders
即列表名称
希望对您有所帮助 - 我有点生疏了,靠记忆工作。
我使用 doxygen 并想知道我对 \xrefitem 和 "heading" 是正确的吗?
在我的代码中我有:
//! \xrefitem Cars "heading" "ListName"
//! Text
这里我定义了一个key"Cars"。此键的所有匹配项都将放入 "Related Pages" 菜单。将有一个 link 和 "ListName",在其下会出现所有与该密钥相关的人工制品。
现在我希望 "heading" 是可变的,相同键的项目将放在 "ListName" 下,但在不同的 "headings" 下。
//! \xrefitem Cars "Audi" "ListName"
//! Text
//! \xrefitem Cars "Mercedes" "ListName"
//! Text
但是无论我为 "headings" 输入什么,它都不会显示,同样 "Audi" 或 "Mercedes"。
任何人都可以解释 "heading" 的用途以及我可以用它做什么以及我的理解是否正确?
手册我看了几十遍,就是不明白。
最好遵循手册中的建议并使用别名。这有助于明确改变参数(例如 "Audi" 到 "Mercedes")是没有意义的。
以手册为例
ALIASES += "reminder=\xrefitem reminders \"Reminder\" \"Reminders\""
并使用
/reminder Make Coffee
会产生类似
的结果Reminder
Make Coffee
即标题、文字
在标记为
的页面上Reminders
即列表名称
希望对您有所帮助 - 我有点生疏了,靠记忆工作。