问题标签 [doxygen]

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 投票
3 回答
1639 浏览

refactoring - 将 C Callergraphs 与 Doxygen 合并或确定所有调用的联合

我有一组遗留的 C 代码,我正在重构这些代码以将 C 计算代码从 GUI 中分离出来。这由于高度递归的数学核心代码是 K&R 风格的声明而变得复杂。由于函数参数的嵌套使用,我已经放弃了将这些转换为 ANSI 声明的尝试(只是无法消除最后 4 个编译器错误)。

我需要将一些文件移动到纯 DLL 中并确定要公开的最小接口,这将需要编写包装函数来发布类型化接口。

我已经使用 Doxygen @callergraph 标记标记了关键源文件,以便为各个函数生成信息图。除此之外,我想做的是合并这些图表,这样我就可以确定暴露给外界的函数的最窄边界。

原始头文件没有用——它们将所有内容都暴露为无类型的 C 函数。

有数百个函数,所以对生成的调用者图的简单检查是痛苦的。

我正在考虑编写某种 DOT 合并工具 - 设置 DOT_CLEANUP=NO 使 Doxygen 将中间 DOT 文件留在那里,而不是只保留它们生成的 png 文件。

我并不沉迷于这是一个图形解决方案——如果有人可以建议一种替代分析工具(免费或相对便宜)或使用 Doxygen 的 XML 输出来实现相同目标的技术,我会非常高兴。

在文件级别合并的调用者图表确实对客户文档而不是普通列表具有一定的吸引力:-)

0 投票
3 回答
25121 浏览

doxygen - 使用 Doxygen 的自定义标签

我想弄清楚是否有一种方法可以使用 Doxygen 创建自定义标签。我确实找到了 ALIAS 配置文件选项,但这并不完全符合我的需要。基本上在我的代码中,我希望能够编写类似的东西

然后让 Doxygen 像它一样为具有此自定义标记的行创建一个列表\bug\todo命令。Doxygen 可以吗?

0 投票
2 回答
13255 浏览

html - 使用 doxygen 记录枚举

doxygen 为枚举生成的 html 文档在左侧列出了枚举,在右侧列出了文档。但是,我需要为每个值提供非常详细的文档,并且其中一些名称很长,因此使带有文档的右列出现在右侧很远并且看起来很糟糕。是否不可能使每个值的文档出现在值的下方或上方而不是右侧?

0 投票
2 回答
3096 浏览

objective-c - doxygen 是否支持 Objective-C 中方法参数的内联注释?

我曾经在 C++ 中使用 doxygen lot,并且非常喜欢使用///<或变体来内联记录函数和方法参数的能力。相反,我真的不喜欢在不使用内联样式时必须在注释中重复参数(因为大多数代码文档系统仅支持)。

所以最近我一直在用我的 Objective-C 代码设置 doxygen,并且似乎无法让内联参数记录工作!

使用@param 的离线文档似乎有效——所以我只能得出结论,它不支持内联Objective-C 方法语法。这将是一个真正的耻辱。

有没有人知道有什么不同?我很想让这个工作。

0 投票
4 回答
32253 浏览

c# - Doxygen:隐藏私有/受保护的方法......和提示

我正在使用 Doxygen 为我们的 API 生成文档,用 C# 编写。但是,它公开了私有/受保护的成员。有没有办法隐藏这些?

我想出了如何隐藏文件:EXCLUDE = 文件名列表

然而,我需要更多的粒度,从而保护用户免受不必要的 API 噪音。一个示例 Doxygen 文件以及提示/技巧将不胜感激。

您使用什么工具从源代码生成 API?

当我通过 C++ 在 C# 中使用 Doxygen 时,我感觉有点留在 18 世纪。

0 投票
5 回答
4654 浏览

boost - Boost 库的 Doxygen 文档?

网络上某处是否有 Boost 库的 doxygen 文档?

我可以创建自己的,但我认为它应该已经存在于网络上的某个地方?谢谢!

0 投票
2 回答
1513 浏览

c# - 生成的乳胶源中的无效字符

我在运行 XP 的 Windows 机器上的 Visual Studio 2008 的 C# 项目上运行 doxygen (1.5.8)。在生成乳胶代码时,会包含一些非法序列。它总是涉及以下序列:“”(带有分词的拉丁-I,类似于二元移位运算符和西班牙语开放问号)。我已经看到它发生在“using {\bf System}”的上下文中,但也许还有其他的。

生成的乳胶文件读取

虽然来源很简单:

一些奇怪的 Windows BOF 字符?似乎只是在使用系统之前;指令(每个文件的第一个)。

0 投票
2 回答
7426 浏览

documentation - 如何在 doxygen 输出中生成导航树?

如果您使用过 javadoc,然后来到 doxygen,那么您可能知道我说我想念使从类到类和方法到方法的跳转变得容易的分层(基于框架)视图的意思。(对于那些没有看过它的人,想象一下 IDE 或文件系统中的树导航器)。

如果可能的话,我怎样才能让 Doxygen 包含导航树?

10 月份有人问了一个类似的问题,但这只是关于样式表的替代品,只有一个出现了。我想我正在寻找更重要的东西。

0 投票
4 回答
8954 浏览

java - 如何能够从 doxygen 的函数内部提取注释?

我很想知道是否可以在函数(c、c++、java)中以 doxygen 可以将它们放在生成的 html 文件中的方式添加一些注释。

例如:

0 投票
4 回答
3841 浏览

python - 使用 Doxygen 的 Qt 样式文档?

如何使用 Doxygen 生成 Qt 风格的文档(Trolltech 的 C++ Qt 或 Riverbank 的 PyQt 文档)?我正在记录 Python,我希望能够改进它产生的默认函数简介。

特别是,我希望能够看到函数简介中的返回类型(可以是用户指定的)和参数。

例如:

如果不修改源代码就无法做到这一点,那么除了 Doxygen 之外,也许还有其他工具可以以这种方式处理 Python 文档?