Doxygen 和未记录的物品

Doxygen and undocumented items

提问人:queeg 提问时间:11/6/2023 最后编辑:queeg 更新时间:11/6/2023 访问量:31

问:

最近我开始使用 Doxygen,我觉得它按预期工作。 现在我需要把重点放在未记录的项目上——好吧,你可以猜到。

我想创建一个单独的页面/组来列出未记录的项目,以便用户更容易找到它们(日志中的警告太容易被忽略)。但更重要的是,我想先整理出唾手可得的果实。让我解释一下......

在查看其他人编写的代码时,有时很难猜到它的作用。如果它调用其他未记录的方法,则尤其如此。不调用其他方法或仅使用记录的方法要容易得多。

那么,Doxygen 是否有可能跟踪调用堆栈并识别仅依赖于任何代码或已记录代码的代码,并且仅将这些项目添加到额外页面?-- 啊,如果所讨论的项目是一个结构或常量,它可以被视为不依赖于未记录的东西......

编辑: Doxygen 版本为 1.9.5

我相信 Doxygen 对代码的理解足够好,因为在日志中我看到的消息如下

Generating caller graph for function ExtractChannel_4

我的 Doxyfile 看起来像

$ doxygen -x Doxyfile 
warning: ignoring unsupported tag 'PROJECT_ICON' at line 59, file Doxyfile
# Difference with default Doxyfile 1.9.1
PROJECT_NAME           = Project
PROJECT_LOGO           = icon.png
OUTPUT_DIRECTORY       = ./doxygen/
ABBREVIATE_BRIEF       =
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_PRIV_VIRTUAL   = YES
EXTRACT_PACKAGE        = YES
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_METHODS  = YES
EXTRACT_ANON_NSPACES   = YES
INTERNAL_DOCS          = YES
INPUT                  = Doc/ApiDocIntro.dox \
                         ./src
FILE_PATTERNS          =
RECURSIVE              = YES
EXAMPLE_PATTERNS       =
SOURCE_BROWSER         = YES
INLINE_SOURCES         = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES
REFERENCES_LINK_SOURCE = NO
HTML_TIMESTAMP         = YES
HTML_DYNAMIC_SECTIONS  = YES
MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
GENERATE_LATEX         = NO
LATEX_CMD_NAME         = latex
CALL_GRAPH             = YES
CALLER_GRAPH           = YES
DOT_IMAGE_FORMAT       = svg
INTERACTIVE_SVG        = YES
DOT_GRAPH_MAX_NODES    = 100
DOT_MULTI_TARGETS      = YES
$
多氧

评论

0赞 albert 11/6/2023
您使用的是哪个版本的 doxygen?一些想法。Doxygen 没有用于跟踪调用堆栈的工具(它不是编译器),它必须创建一个调用和调用者图(参见 CALL_GRAPH 和 CALLER_GRAPH 或 REFERENCE_RELATIONS / REFERENCED_BY_RELATION),它显示了一些结构。(可能最好也设置EXTRACT_ALL和其他 EXTRACT...设置,以便您获得一切)。如果没有EXTRACT_ALL,您也很有可能收到有关无证实体的警告。
0赞 queeg 11/6/2023
对调用图的了解是否不足以做出此决定?只需剥离记录的项目并确定列表是否为空......
0赞 albert 11/6/2023
请注意,使用时,您会获得与默认设置不同的所有设置。我正在考虑另一个问题。doxygen -x Doxyfile
0赞 albert 11/6/2023
也许给调用图中未记录的函数一个不同的边框颜色,以便它们稍微突出一点(我目前无法测试这一点,这也是出现一些一半评论的原因)。在 github 上的 doxygen 问题跟踪器中提出增强请求可能是个好主意。
0赞 albert 11/6/2023
请注意,当前的 doxygen 版本是 1.9.8

答: 暂无答案