Question

我正在用doxygen记录我的功能。一个例子：

//!  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。我写这个的一般方式就像; ＆＃34;此函数用于类foo的函数A和类foo2的函数B＆＃34;

doxygen中是否有任何关键字，如＆＃34;谁或何时或使用＆＃34;我可以用于这种情况吗？

Answer 1

在Doxyfile中，您会找到选项var clientContext = new ClientContext("http://myserver"); var fileGuid = new Guid("D51C440B-4F52-4005-90BE-BDC42E850975"); var file = clientContext.Web.GetFileById(fileGuid); clientContext.Load(file); clientContext.ExecuteQuery();和REFERENCED_BY_RELATION。如果将它们设置为YES，那么您将获得以逗号分隔的函数列表，这些函数引用了记录的函数，以及由记录的函数引用的逗号分隔的函数列表。

进一步创建自定义命令可能对您有意义（请参阅http://www.doxygen.nl/manual/custcmd.html）。您可以通过在Doxyfile中添加带有参数的别名来创建自定义命令，例如：

REFERENCES_RELATION

然后你可以写下评论：

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

哪个会产生句子＆＃34;这个函数正在使用GUI类＆＃34;在您的文档中。

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

1 个答案: