问题标签 [doxywizard]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
python - 具有python超类的Doxygen文档结构
这是我在堆栈溢出中的第一个问题:这是我的 Python 项目结构:
超类1:
- 模块
class1 及其模块
class2 及其模块
超类2:
- 模块
class2-1 及其模块
class2-2 及其模块
如何在 Doxygen 生成的文档中替换这种类型的结构?我正在使用 doxywidzard 和相关的配置文件。
doxygen - 非法别名格式“ALIASES”
我将以下代码添加到 doxywizard ALIASES 中,但出现错误。我该如何解决这个问题?
[![在此处输入图像描述][1]][1]
错误信息:
错误:非法别名格式 `ALIASES += global_START="
Globals\1
: \2
"'。使用 "name=value" 或 "name(n)=value",其中 n 是参数的数量错误:非法别名格式 `ALIASES += global_END=""'。使用 "name=value" 或 "name(n)=value",其中 n 是参数的数量
版本:1.8.11
解决方案
我像这样在 doxyfile 中手动添加:
并打开 doxywizard,ALIASES 字段如下所示:(每行必须单独添加)
c - Doxygen 没有记录嵌套目录中的标题
这是我的演示项目结构
这是你好和再见的文件
Doxygen 只记录 hello.h 而不是 bye.h 这是我的doxyfile。
这是 doxygen 日志
我如何记录 bye.h?
我检查了扫描递归,优化 C,提取所有和源浏览器选项,似乎没有任何工作,doxygen 甚至没有查看 lib 文件夹。
configuration - Doxygen EXTRACT_ALL = YES 不会全部提取,还显示未记录的警告
我现在对 doxygen 很生气,我希望它在第 8 层不要太愚蠢,但我们会看到......
我想提取静态和无证的东西。这就是为什么EXTRACT_ALL = YES
现在。但是 EXTRACT_ALL 似乎没有按照文档的意图工作。请参见下面的示例。
针对 EXTRACT_ALL 的文档,输出中仍然存在警告。
来自 doxygen_output:
也EXTRACT_STATIC = YES
设置了,所以应该导出静态变量,但它们不是。
test_main.c
结果不显示静态变量
使用的配置:
doxygen - 如何使用 Doxygen 生成用户手册?
我有一些带有 .docx 扩展名的用户手册。我可以将我的手册转换为类似于 doxygen 手册(带有带有标题的侧面导航栏)
doxygen - 如何在 Doxygen 中添加一个 html 页面?
我正在使用 Doxywizard 生成 Doxygen 文档网站,并且我还有另一个 HTML 页面,例如“some_page.html”。是否可以在“相关页面”下添加链接以显示此 HTML?我阅读了 doxygen 文档。"\page" 命令对显示 HTML 页面没有帮助。
tcl - 为什么 doxygen 不能识别 .tcl 中的注释?
我被 doxywizard 卡住了,因为它无法识别任何评论,即使是更简单的文件。我有 Doxygen 1.8.18,这是支持 TCL 的最后一个 doxygen 版本(根据这个站点)。我从前面提到的站点中保存了代码示例。我将大部分配置保留为默认配置,除了:
- 未经检查的乳胶输出
- 在 Expert>Build 下选中 EXTRACT_ALL
- 在 Expert>Input 下,仅将 FILE_PATTERNS 更改为 *.tcl
输出为 tclexample.tcl 文件生成文档,该文件甚至出现在最终文档中,但它有一个几乎是空的页面:tclexample.tcl 文件参考
我的配置:
正如我从 doxygen 文档中了解到的那样,输出优化器不应该对代码的解析方式产生影响。问题是什么?
doxygen - Doxygen: \include test.dox in mainpage.dox 添加为文本
我为一个 python 项目创建了一个 Doxygne 文档。为了添加有关具有高级类体系结构的项目的高级介绍,我创建了一个 mainpage.dox 文件,该文件具有以下格式。
将上述所有内容放在一个 mainpage.dox 中的问题在于,它太长并且感觉不可读。
我实际上想将所有内容分成单独的附加 dox 文件并将其与 mainpage.dox 文件链接。例如:
为简介创建一个单独的 .dox 文件
为类体系结构创建一个单独的 .dox 文件
然后添加这些链接文件将显示 mainpage.dox 文件中的内容,如下所示。
Introduction.dox 文件包含: 我没有在这里添加任何评论。
不幸的是,如上所述添加 .dox 文件仅添加文本格式的信息。它不会以 Doxygen 格式的方式显示内容。我也试过 \include Introduction.dox 和 \include { Introduction.dox} 和 \includedoc Introduction.dox 。
我正在使用 Doxygen 1.8.17。知道可能是什么原因吗?
非常感谢!!
c++ - 如何忽略 Doxygen 中的某些目录?
我尝试使用 Doxygen 来查看它是如何记录代码的。
我遇到的最大问题是它扫描所有子目录,但是我需要避免其中一些,因为最终文档中不需要(它们也不合适,因为不是我工作的直接部分)。
我认为可以从 Doxygen 向导的专家选项卡中进行,但我是新手,我不明白如何设置它们。
最后,对排除的目录的引用(即对函数、变量等的引用)会发生什么?