我正在尝试为代码中实现的一些“错误代码”生成文档。为了开始我的工作,我使用了以下参考:
Custom tags with Doxygen
使用\xrefitem
andALIASES
选项,我做了以下事情。
ALIASES = "error{1}=\ref ErrorCode-\1 \"ErrorCode-\1\" " \
"implement{1}=\xrefitem implement \"Implements ErrorCode\" \"ErrorCode Implementation\" \1" \
在代码中我将注释写在 FUNC1 中,例如:
@implement{@error{001}} Error Code 001
使用上述内容,我可以生成一个页面,其中显示函数名称以及其中实现了哪些错误代码。
现在,我的项目中有多个相同错误代码的来源。因此,在文档中,我还希望有一个页面,我可以在其中看到错误代码及其实现位置(带有指向函数的链接)。
我在“错误代码实现”页面上的内容:
FUNC1
Implements ErrorCode-001, ErrorCode-003
FUNC2
Implements ErrorCode-002
我在“错误代码跟踪”页面上想要什么:
ErrorCode-001
Implemented in FUNC1, FUNC3
ErrorCode-002
Implemented in FUNC2
如何在 Doxygen 中做到这一点?