问题标签 [doxygen-wizard]

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 投票
1 回答
45 浏览

c++ - 在 Doxygen 中记录命名空间

我开始用 doxygen 记录我的所有代码。我对文件文档没有问题,但是在为多个文件生成文档时遇到了一个小问题。

例如:

在一些头文件中(我只使用 C/C++ 代码项目)我有以下代码:

运行 doxywizard 后,如果我查找命名空间的文档,我将看到 NGE 命名空间,但不会得到:

我明白了

即使我/// NGE namespace/// @namespace NGE namespace

凸轮有人请解释我在哪里犯了错误?

0 投票
0 回答
106 浏览

c# - 如何配置 doxygen 以生成带有纯文件列表的 html?

我有一个用 C# 编写的树状结构的项目。我需要在带有注释的普通列表中列出所有 *.cs 文件。
例如:我的
项目

楷模

  • 模型1.cs
  • 模型2.cs

控制器

  • 控制器1.cs
  • 控制器2.cs

意见

  • View1.cshtml
  • View2.cshtml

等等

每个文件都有部分 xml 注释,例如:

我想生成具有这种结构或表格的 rtf 文件:
Model1.cs | 一些重要的评论
Model2.cs | 一些重要的评论1
Controller1.cs | 一些重要的评论2
Controller2.cs | 一些重要的
评论3 View1.cshtml | 一些重要的评论4
View2.cshtml | 一些重要的评论5

换句话说,我想生成的不是文档,而是列表结构中每个文件的摘要 xml 注释的描述。

0 投票
1 回答
72 浏览

doxygen - Doxygen Seperate Inc/ 和 Src/ 文件问题

我的项目文件夹名称是 MyDoxy 我有单独的文件系统MyDoxy/Src/MyDoxy/Inc/文件夹,它们有一些 .c 和 .h 文件。 main.cppSrc/文件夹中。

当我Doxygen.txt在 MyDoxy 文件路径中生成文件时。它不会生成文件和我在这篇文章中谈到的文件:Doxygen does not generate except the empty mainpage 但是当我在 MyDoxy/Src/ 路径中创建时。它适用于 main.cpp 和 .c 文件,但不适用于 .h 文件,例如main.h文件。

我怎么解决这个问题 ?

0 投票
1 回答
146 浏览

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 字段如下所示:(每行必须单独添加)

0 投票
1 回答
120 浏览

tabs - 如何在 doxygen 文档中添加我们自己定义的选项卡

代码的输出

FPGA_BOARD 内容

嗨,我想在页面上再添加一个选项卡,即我想在主页和相关页面之间添加“Lokesh”选项卡,我已附上屏幕截图以供参考。 图片供参考

在此处输入图像描述

详细的选项卡视图

0 投票
0 回答
170 浏览

doxygen - 在 doxygen 中记录错误代码实现

我正在尝试为代码中实现的一些“错误代码”生成文档。为了开始我的工作,我使用了以下参考: Custom tags with Doxygen 使用\xrefitemandALIASES选项,我做了以下事情。

在代码中我将注释写在 FUNC1 中,例如:

使用上述内容,我可以生成一个页面,其中显示函数名称以及其中实现了哪些错误代码。

现在,我的项目中有多个相同错误代码的来源。因此,在文档中,我还希望有一个页面,我可以在其中看到错误代码及其实现位置(带有指向函数的链接)。

我在“错误代码实现”页面上的内容:

我在“错误代码跟踪”页面上想要什么:

如何在 Doxygen 中做到这一点?

0 投票
0 回答
51 浏览

doxygen - 将递归标记设置为 ON 不会搜索 .NET 项目的子文件夹

我是 doxygen 工具的新手。我按照 doxygen 配置指南从我的 C# 源文件生成 HTML 文档。我能够生成 HTML 输出,但我发现它正在生成仅存在于所选源文件夹中的文件的输出,其中存在于源文件夹子目录中的文件被跳过/忽略。根据帮助指南,我检查了向导中的“递归”选项。我们还有什么需要配置的吗?谁能帮我解决这个问题。提前致谢。

问候巴德里

0 投票
1 回答
218 浏览

doxygen - 如何在 doxygen 配置文件(例如 iostream 库)中添加不带扩展名的文件?

在 INPUT 标记的配置文件中,我添加了一个目录。里面iostream没有任何扩展。运行配置文件后,我没有得到与iostream. 我想知道如何在 doxygen 配置文件中添加不带扩展名的文件。

0 投票
1 回答
113 浏览

documentation - 如何配置 doxyfile 并获取 .doc 文件的文档作为输入以在 Doxygen 中生成 html 输出?

我的任务是使用 doxygen 工具记录扩展名为 .doc 的文件。我能够为 .cpp 文件生成 html 输出,但坚持设置 doxyfile 的正确配置,以便为具有 .doc 扩展名的文件生成 html 输出作为输入文件。请帮我解决这个问题。

0 投票
0 回答
87 浏览

c++ - C++ doxygen 文档仅适用于静态函数

这是我第一次学习如何使用 Doxygen 做文档,我通过在 Github 中练习 ADXL345 的 doxy'd 代码作为基础做到这一点。我能够通过更改评论来生成 Doxygen html 站点,但是当我的 Adafruit_ADXL345_U.h 头文件正确显示时,Adafruit_ADXL345_U.cpp 缺少站点中显示的文档。它只显示了一个静态函数“spixfer()”。

Adafruit_ADXL345_U.cpp doxygen.

我在文档中没有看到内联和其他功能。

我使用的 Doxywizard 版本是 1.9.1,存在 *.cpp 扩展名,我使用的配置是:

下面使用的代码:

Adafruit_ADXL345_U.h

Adafruit_ADXL345_U.cpp

请问我可以在配置中更改什么以查看其余的文档注释?