在Doxygen中使用Microsoft的源代码注释语言（SAL）？
代码狗狗
我正在尝试使用Doxygen记录一些使用Microsoft的源代码注释语言（SAL）的C ++代码。但是，Doxygen无法_Success_正确解析某些注释宏，例如。在该示例的情况下功能注释，_Success_，Doxygen的曲解该宏为函数头/原型。
以包含函数注释标记的以下示例为例：
/**
* @file
* Example with function annotation.
*/
#include <windows.h>
#include <sal.h>
/**
* @brief This is a function.
* @param i a random variable
* @return TRUE on every call.
*/
_Success_(return) // The SAL function annotation.
BOOL function(_In_ int i) {
return TRUE;
}
在上面的示例中，Doxygen将解释_Success_()为函数标头/原型，从而创建绝对错误的文档。这里是出现什么HTML Doxygen的输出像有和没有的功能注释：
通过函数注释，Doxygen还说我记录了一个i不属于参数列表的参数变量：
C：/.../ Source.cpp：9：警告：在成功（返回）的参数列表中找不到命令@param的参数'i'
Am I missing a configuration setting in the main Doxygen configuration file?
Or is SAL and Doxygen simply just incompatible?
Code Doggo
Ah ha! After some further research, I found a question on Stack Overflow that asked this same question, except it wasn't tagged correctly and did not explicitly say s/he was using "Microsoft's SAL." This is why it took me awhile to find it. (I have updated the corresponding question to correct these missteps.)
The question's answer references the Doxygen manual section entitled: Preprocessing.
A typically example where some help from the preprocessor is needed is when dealing with the language extension from Microsoft:
__declspec. The same goes for GNU's__attribute__extension. [...] When nothing is done, doxygen will be confused and see__declspecas some sort of function. [...]
Therefore, as pertaining to my example above, the settings that need to be configured in the Doxygen configuration file are as follows:
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
PREDEFINED = _Success_(x)= \
_In_=
Basically, this set of configurations means that the macros defined in the PREDEFINED section will be fully expanded and evaluated "before the preprocessor [has] started." But, these macros will expand to nothing as we provide "nothing" for the definition side of the equation (i.e. format: name=definition). Therefore, they are essentially ignored/removed while Doxygen builds the documentation documents.
不幸的是，这确实意味着需要继续扩展此PREDEFINED列表，以至少封装源代码中使用的所有SAL宏。一种更好的解决方案是将所有SAL宏封装在此列表中，但是将来的证明是不可能的，因为在以后添加任何新的宏时总是会很晚。但是，至少有解决方案！
本文收集自互联网，转载请注明来源。
如有侵权，请联系 [email protected] 删除。
编辑于
相关文章
TOP 榜单
- 1
Linux的官方Adobe Flash存储库是否已过时？
- 2
如何使用HttpClient的在使用SSL证书，无论多么“糟糕”是
- 3
错误：“ javac”未被识别为内部或外部命令，
- 4
在 Python 2.7 中。如何从文件中读取特定文本并分配给变量
- 5
Modbus Python施耐德PM5300
- 6
为什么Object.hashCode（）不遵循Java代码约定
- 7
如何检查字符串输入的格式
- 8
检查嵌套列表中的长度是否相同
- 9
错误TS2365：运算符'！=='无法应用于类型'“（”'和'“）”'
- 10
如何自动选择正确的键盘布局？-仅具有一个键盘布局
- 11
如何正确比较 scala.xml 节点？
- 12
在令牌内联程序集错误之前预期为 ')'
- 13
如何在JavaScript中获取数组的第n个元素？
- 14
如何将sklearn.naive_bayes与（多个）分类功能一起使用？
- 15
ValueError：尝试同时迭代两个列表时，解包的值太多（预期为 2）
- 16
如何监视应用程序而不是单个进程的CPU使用率？
- 17
解决类Koin的实例时出错
- 18
ES5的代理替代
- 19
有什么解决方案可以将android设备用作Cast Receiver？
- 20
VBA 自动化错误：-2147221080 (800401a8)
- 21
套接字无法检测到断开连接
我来说两句