Doxygen \ xrefitem标题

时间:2015-08-04 12:53:17

标签: doxygen

我使用doxygen并想知道我是否理解 \ xrefitem和"标题"是对的吗?

在我的代码中,我有:

//! \xrefitem Cars "heading" "ListName" 
//! Text

在这里,我定义了一个键"汽车"。此密钥的所有出现都将被放入"相关页面"菜单。会有一个链接" ListName"在这种情况下,所有相关人工制品的出现都会出现。

现在我的希望是"标题"是可更改的,同一个键的项目将放在" ListName"但在不同的标题下#34;

//! \xrefitem Cars "Audi" "ListName" 
//! Text

//! \xrefitem Cars "Mercedes" "ListName" 
//! Text

但无论我输入什么"标题"它没有显示,同样"奥迪"或"梅赛德斯"。

任何人都可以解释"标题"我能用它做什么,如果我的理解是正确的呢?

我现在已经阅读了几十本手册,但却没有得到它。

1 个答案:

答案 0 :(得分:0)

遵循手册中的建议并使用ALIAS是个好主意。这有助于明确指出,将参数(例如“奥迪”改为“梅赛德斯”)毫无意义。

采用手册的例子

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

并使用

/reminder Make Coffee

会产生类似

的内容
Reminder 
  Make Coffee

即。标题,文字

在标有

的网页上
Reminders

即。 LISTNAME

希望有所帮助 - 我有点生疏,在这里从记忆中工作。