oxygen中的关键字，它将显示当前使用函数的实体

A keyword in Doxygen, which will show which entities currently using function

本文关键字：函数 实体 关键字 oxygen 显示      更新时间：2023-10-16

我正在用氧气记录我的功能。示例:

//!  Add the variable to String Hash Map
/*!
    Given name of the string, a new the item with this name will be add.  This function is being used from GUI when user adds a constant.
    param variableName The name of the variable which will be added
*/
void   addVariableToStrMap(const QString& variableName);

对于几乎每个函数，我都这样写:This function is being used from GUI class when user adds a constant。一般我是这样写的;"此函数正用于A类功能foo和B类功能foo2 "

在这种情况下，氧中是否有像"谁或何时或用法"这样的关键字我可以使用?

在Doxyfile中，您会发现选项REFERENCED_BY_RELATION和REFERENCES_RELATION。如果您将它们设置为YES，那么您将得到一个以逗号分隔的引用文档化函数的函数列表和由文档化函数引用的以逗号分隔的函数列表。

您可能会对进一步创建自定义命令感兴趣(参见http://www.doxygen.nl/manual/custcmd.html)。您可以通过在Doxyfile中添加带有参数的别名来创建自定义命令，例如:

ALIASES += who{1}="This function is being used from 1 class"

那么你可以在评论中写下:

who{GUI}

这将在您的文档中产生语句"This function is being used from GUI class"

相关文章：