doxygen相关内容

Doxygen:具有C ++和VHDL的项目的无缝文档

我正在建立有关某种库的文档,该库由C / C ++部分和VHDL部分以及一些仅用于指导性的Doxygen页组成。必须将它们放在一个独立的组中。到目前为止,一切都可以正常工作,而且很好而且蓬松... 但是如果我想通过使用 OPTIMIZE_OUTPUT_VHDL优化vhdl-子目录中的输出怎么办?是,并同时使用 OPTIMIZE_OUTPUT_C = YES 优化c子目录的输出? 据我了 ..
发布时间:2020-10-26 01:49:08 C/C++开发

根据代码记录单元测试

我正在尝试使用doxygen来记录我的单元测试,但是我想在代码中而不是在测试标头中直接记录它们,以减少进行类似测试时的复制/粘贴错误。值得注意的是,我使用的是RTF输出格式。 / ** @brief一种测试脱氧方法文档的方法 * @test *-#步骤1 *-#步骤2 *-#步骤3 * / [TestMethod()] public void DoxygenScr ..
发布时间:2020-10-26 01:49:01 其他开发

param [out]和doxygen返回之间的区别?

\param [out] 和 \return 吗?它们似乎都记录了函数的输出/返回。是由于 void 函数没有返回值而只有 param [out] 有效而导致的差异吗? ? 解决方案 Out参数与返回值不同。以C中的示例为例: / ** * \param [in ] val值计算基于。 * \param [out]变量函数输出写入此变量。 * *不返回 * / ..
发布时间:2020-10-26 01:49:00 其他开发

Doxygen生成的文档中的相对文件路径

我在Windows上使用Doxygen 1.7.4。 在生成文档的文件列表页中,我想查看相对的路径。 我已经设置了 FULL_PATH_NAMES = YES ,除了不带路径的文件名之外,还有更多的东西,但这提供了完整的绝对路径。 我只想要相对于项目目录的路径。我知道,我可以使用 STRIP_FROM_PATH ,但是通配符有问题。我需要这种路径剥离方法,因为该项目是在多台PC上完成 ..
发布时间:2020-10-26 01:47:58 其他开发

如何更改graphviz的默认字体大小?

我使用doxygen + graphviz记录我的代码。 graphviz在生成图像方面做得很好。 是否可以更改graphviz的默认字体大小?默认值为14,但我想改用12。 更改单个元素(如节点,子图,边等)的字体大小确实很痛苦。 更新: 作为参考,这是我在doxygen中使用的代码,(当然,文本字段已重命名) @dot 严格有向图{ 节点[shape = bo ..
发布时间:2020-10-26 01:47:54 其他开发

从DOxygen XML输出中提取函数调用列表

我在DOxygen论坛上也发布了问题 我有一个中等大小的C项目,包含大约2,900个函数。我正在使用DOxygen 1.5.9,并且它已成功生成函数的调用图。有没有办法将其提取出来以进行进一步分析?一个简单的配对列表就足够了,例如 呼叫者,被呼叫者 FunctionX,FunctionY ... 我对XSLT感到满意,但我必须说DOxygen XML输出很复杂。 ..
发布时间:2020-10-26 01:47:52 其他开发

如何创建外观和工作方式与Apple Core Library中的外观类似的Xcode文档集

我想为我的API创建一个文档集,其外观和工作方式类似于Apple Core Library文档集。例如,查看NSString的页面。 我尝试过Doxygen,也尝试过headerdoc2html。 headerdoc生成的文件没有Apple文件执行的大多数高级结构以及图形设计是不同的。在更详细的层次上,就像在查看特定方法时一样,事情更加紧密,但是没有所有的详细结构。 由Doxyg ..
发布时间:2020-10-26 01:46:48 其他开发

python中的doxygen语法

有人可以帮助我弄清楚如何正确注释python代码以被doxygen解析吗? 它会以某种方式忽略标签。输出(HTML)显示标签: @brief创建一个新的Hello对象。 此Hello对象用于... @param name用户名。 我尝试的两种变体均不起作用: class您好: “”“ @简短简短说明... 较长说明 “”“ d ..
发布时间:2020-10-26 01:46:44 Python

排除Doxygen的目录

我希望Doxygen忽略,跳过而不是搜索项目的以下目录: * /。svn / * * / docs / * * /属性/ * * / bin / * 根据 Doxygen常见问题解答: 如何从目录树中排除所有测试目录? 只需在配置文件中放入这样的排除模式: EXCLUDE_PATTERNS = * / test / * 因 ..
发布时间:2020-10-26 01:46:41 其他开发

在Doxygen中引用参数的正确方法是什么?

我具有以下有关Doxygen的功能文档: / ** @brief做有趣的事情 @param [in] pfirst第一个参数:装满猴子的桶 @ pre “ pfirst”必须事先通过BarrelFiller()$ b传递$ b * / 请注意, pfirst 是 我在这里用引号将其括起来,因为我想使其与其他文本区分开来。但是最好这样做,以使Do ..
发布时间:2020-10-26 01:46:37 其他开发

X宏打破氧气笔迹

我有3个文件: test.c int table [] = { #define X(val)val, #include“ test.x” #undef X }; void level2(void){ level3(); level4(); } void level3(void){ level4(); } test2.c ..
发布时间:2020-10-26 01:46:33 其他开发

整合常春藤和氧气

有没有一种方法可以整合常春藤和氧气?我想通过常春藤发布我的doxygen文档吗?如果是这样怎么办?有相关的文档吗? 解决方案 我不是doxygen用户。我假设您正在使用它创建文档的zip存档? Ivy可以用于发布任何类型的文件。以下教程提供了有关如何将文本文件发布到本地的示例资料库。要选择发布到远程存储库,只需切换解析器即可 在以前的公司中,我们在每个版本中都包含一个 ivy. ..
发布时间:2020-10-26 01:46:29 其他开发

Doxygen是否可以从生成的XML中排除未记录的功能?

我只想为具有Doxygen注释的代码生成文档。我已经通过Doxygen版本1.8.9.1创建了 Doxyfile 并将其配置为仅输出XML并隐藏所有未记录的代码: GENERATE_HTML =否 GENERATE_LATEX =否 GENERATE_XML =是 HIDE_UNDOC_MEMBERS =是 HIDE_UNDOC_CLASSES =是 之后,我创建了 ..
发布时间:2020-10-26 01:46:18 其他开发

Doxygen @URL链接无法正确生成链接

我已将此添加到班级注释中: @link http://www.google.com Google @endlink 但是,当我使用doxygen生成文档时,链接文本的确是“ Google”,但是链接将: file:///media/portable/Examples/Doxygen/link/html/classClass1.html ..
发布时间:2020-10-26 01:46:15 其他开发

使用doxygen的\link命令

我有一个外部HTML文件,我想通过doxygen的“相关页面”标签或左侧框架进行链接。看来我需要使用 \link 命令,但找不到如何使用它或在何处使用的好例子。我当前正在使用doxywizard生成HTML。 因此, \link 是我整合到doxygen中的东西吗?配置文件还是在以某种方式构建HTML时添加它? 更新 所以我最终不得不执行以下操作: 创建一个具有以下内容的新 ..
发布时间:2020-10-26 01:46:13 其他开发

是否可以选择显示哪个Doxygen警告?

Doxygen显示一个化合物?未记录。生成时的警告。对于特定项目,我不想记录化合物。为了消除混乱,我想查看除该警告以外的所有其他警告。有没有办法清理Doxygen的输出? 解决方案 我认为这是不可能的,除非自己写一篇文章-处理器过滤氧气输出。在您的情况下,这应该不太困难,简单的 grep 就足够了: doxygen | grep -v“警告:未记录化合物 ..
发布时间:2020-10-26 01:45:11 其他开发

从依赖关系图中排除特定的标头

我不确定这是一个 doxygen 还是一个 dot 问题,但是可以了。 在我的项目中,我有很多文件需要包含常见的标头,例如 stdlib.h , stdint.h ,依此类推。当我要求 doxygen 为我的每个文件生成依赖关系图时,这会导致很多混乱和杂乱无章,因为绘图工具总是重用现有节点,并且从不重复它们。 我能以某种方式告诉 doxygen 从生成的图形中排除一组标题,只是完全忽略 ..
发布时间:2020-10-26 01:45:07 其他开发