问题标签 [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.

0 投票
2 回答
24450 浏览

doxygen - 如何在 Doxygen markdown 中创建换行符?

我很难找到解释如何在 Doxygen markdown 中添加换行符的文档。

我试过在行尾使用两个空格,我也尝试过单换行或双换行,但这些都不适合我。

我正在使用 Doxygen 1.8.9.1 版。

0 投票
1 回答
2781 浏览

c++ - doxygen 没有搜索包含目录

抱歉这篇文章的长度。我在W7 64位机器上使用Doxygen 1.8.10 。我已经在 code::blocks 13.12 中编写并编译了我的代码。

我的文件结构如下:D:/Base/CodeBlocksProjects/SFML_apps/Alarm Clock包含我的cpp文件,我所有的头文件都在/CodeBlocksProjects/include.

我希望将 Doxygen 文档保存在/CodeBlocksProjects/SFML_apps/Alarm Clock/Doxygen. 这被设置为工作目录。 OUTPUT_DIRECTORY设置为.(一个点)。这意味着据我了解,Doxygen 会将其生成的文件保存在/Alarm Clock/Doxygen.
INPUT 设置为../应该意味着 Doxygen 将在/Alarm Clock/文件夹中查找源文件。 SEARCH_INCLUDES已打开且包含路径为../../../include. 当我使用目录查找器按钮指向我的包含文件夹时,会生成此相对路径。

其他一切都几乎是默认值。/Alarm Clock/但是没有找到并列出我的包含文件,因此除了文件夹中各种测试文件中的一些微不足道的类之外,没有类信息。我已经附加了 Doxyfile 设置。

任何帮助将非常感激。我已经完成了这段代码,我想在继续之前记录它......

0 投票
0 回答
726 浏览

doxygen - 如何通过 doxygen 使用 mscgen 创建序列图?

Graviz 在 doxygen 上运行良好,但我很难使用 mscgen。在 doxywizard 中,我将 mscgen_path 设置为 mscgen bin 文件夹。但是输出 html 不显示任何序列图。

0 投票
0 回答
882 浏览

doxygen - 用于verilog代码的Doxygen

我需要使用 Doxygen 记录我的 verilog 代码。我已经安装了 doxygen 1.8.10 版和 doxverilog 2.6 版。此外,我还有用于 Windows 64 位的 xilinx 12.0 和 microsoft visual studio 2010。我已经按照以下步骤操作,并且需要更多指导,因为我对这个 Doxygen 软件非常陌生。

  1. 将 Verilog 文件 verilogparser.y verlogscanner.l 和其他源文件从“C:\Doxverilog2.7\sources”复制到“C:\doxygen-1.8.10\src”。

  2. 将补丁文件“windows.patch”从“C:\Doxverilog2.7\sources”复制到“C:\doxygen-1.8.10”。

下一步在“Doxverilog2.7”的“ReadMe”文件中提到为: 在doxygen-1.8.1目录下打开一个shell make patch # patch -F3 -p1 < windows.patch

但我该如何打开它?这个外壳是什么意思?我从哪里可以得到它?

下一步以“使用 Visual C++ 2008 速成版打开 doxygen-1.8.1\winbuild\Doxygen.vcproj”的形式提供,但是当我在 Visual Studio 2010 中构建这个项目时,它给了我几个错误并且没有成功构建。有没有这样的项目可以在 Visual Studio 2010 而不是 Visual Studio 2008 上运行?

另外,我想使用 Doxywizard,我需要按照这些步骤操作吗?请帮我解决这个问题。

谢谢。

0 投票
1 回答
738 浏览

out-of-memory - Doxywizard 错误:没有足够的内存可用于此任务

虽然我有足够的内存(RAM -> ~3.5 GB 和硬盘 -> 60 GB),但在使用 DoxyWizard 创建 chm 文件时,我仍然一次又一次地收到此错误。我需要做任何设置来解决这个问题吗?

在此处输入图像描述

在此处输入图像描述

即使我使用hhc <index.hhp>html 文件夹中的命令从命令提示符的 html 帮助编译器执行此操作,我也会收到相同的错误。

0 投票
1 回答
465 浏览

fortran - Doxygen 链接到 Fortran 中其他模块/文件中的子例程

我有一个proc调用 Fortran subroutine的 Fortran 子例程uvuv在一个不同的模块中,它在 Doxygen 中有自己的模块页面。我想添加一个链接,以便您可以单击uvDoxygen 页面proc,它会将您带到该uv页面。

我试着做:

这些都没有链接到uv页面。有更好的方法吗?我使用了 HTML 链接,这很管用,但是这很麻烦并且需要很长时间,因为我有很多这样的子例程。

0 投票
1 回答
366 浏览

documentation - 如何在 doxygen 文档上隐藏私有类声明

//我的 doxygen 文件:

EXTRACT_ALL = 是

EXTRACT_PRIVATE = 否

EXTRACT_PACKAGE = 否

EXTRACT_STATIC = 否

EXTRACT_LOCAL_CLASSES = 是

EXTRACT_LOCAL_METHODS = 否

HIDE_UNDOC_MEMBERS = 是

HIDE_UNDOC_CLASSES = 否

0 投票
1 回答
1589 浏览

doxygen - 如何在 Doxygen 中为目录提供描述

我正在与 Doxygen 合作记录我的项目。我知道,通过使用下面的 Doxygen 命令,我们可以对源文件进行描述。

有什么方法可以描述 Doxygen 中的目录/文件夹吗?

0 投票
0 回答
532 浏览

doxygen - 如何使用 doxygen 在 Windows 上的项目存储库中为我的配置文件创建文档?

我一直在做我的项目,并使用 doxygen 完成了文档。现在我想在 Windows 终端上使用 [doxygen doxygen.config] 命令运行 doxygen,但它说找不到 doxygen 命令。我习惯在 Linux 中使用它,它似乎很容易。我尝试使用 doxygen 向导生成 doxygen,但它似乎不起作用。有人能告诉我如何解决这个问题吗?

我使用 doxygen 文件运行向导,它会生成“生成”文件夹,其中有“html”和“later”文件夹。但是 html 文件夹中没有任何内容。

0 投票
1 回答
1690 浏览

documentation - 如何使用 Javadoc 和 Doxygen 注释文件本身

我在使用 javadoc 样式和 doxygen 记录文件本身时遇到问题。我可以为变量和函数生成很好的文档,但对于文件本身,doxygen 始终认为文件的标题是下一个立即变量或宏的文档,即使该 var 或宏有自己的 javadoc 注释块。举个例子:

因此,当我为这个文件生成文档(使用 doxygen/doxywizard)时,定义的宏的文档将被文件的标题替换。

做这种事情的正确方法是什么?记录文件本身是否被认为是一种好习惯(包括描述、作者、时间、版本等信息),如果是,如何解决我刚才描述的问题?