禁止氧气警告
是否有一种方法可以抑制Doxygen对特定文件发出“未记录”的警告？我的项目有几个自动生成的代码标头，导致其引发成百上千的错误，使筛选困难。 解决方案 您可以在生成的文件中使用抑制标签： //！ @cond Doxygen_Suppress 代码 //！ @endcond 您不需要在其中使用“ Doxygen_Suppress”，但为清晰起见，我喜欢它。
..
doxygen相关内容
创建新的自定义命令，该命令将添加到Doxygen的一部分中
我想在Doxygen中创建自定义命令，类似于 \fn \param 或 \var 。 例如，我希望能够创建 \选项命令，如下所示： / ** \option option_1这是第一个选择。 \option option_2这是第二个选项。 * / 输出如下： 选项： option_1这是第一个选项。
..
忽略Doxygen项目文件夹中的文件
如何用Doxygen像Git的 .git / info / exclude 一样忽略文件？ Doxygen根据我不想使用的第三方代码（例如Email -component和我的Git -repo）为我生成文档。 我需要将文件保留在原处。 解决方案 您可以在配置文件中使用EXCLUDE_PATTERNS标记： EXCLUDE_PATTERNS = * / test / *
..
Doxygen在记录PHP时出现奇怪的问题，如果
在尝试记录我的项目时，我遇到一个奇怪的问题。我有以下代码： //！设置默认的:: $ action作为被叫控制器。如果未调用任何操作，则将设置默认值（索引）。 $ action = isset（$ _ GET [‘action’]）吗？ $ _GET ['action']：'index'; if（$ action）{ echo'something 1'; } else {
..
从Doxygen文档中排除某些类
我正在构建一个基于Qt的项目，并且在目标文档中找到了许多Qt类。 我如何告诉Doxygen禁用某些类的文档生成？对于Q。*？ 解决方案 假设您拥有的东西是这样的：（这个问题有点不清楚 / ** * X类的一些文档 * / 类X：public osg :: Drawable { ... } 并且您的问题是您想包含类 X 的文档，而不是类 osg :
..
合并氧气模块
我有很多针对doxygen的代码。为了提高性能，我正在尝试将其分解为模块，然后将结果合并到一组文档中。我以为标签文件可以解决这个问题，但是要么我配置错误，要么我误解了它的工作原理。 目录布局： root + | -src + | | -a | | -doc + | -a.dox | -main.dox | -main.md | -output +
..
使用doxygen在结构定义之外记录c结构的成员
我正在使用doxygen注释我的C代码。我使用的是外部API（即不是我自己的API），但缺少相关文档，因此我打算在自己的源文件中记录一些该API。我有有用于外部API的头文件，但是将我自己的注释添加到该文件中是不切实际的。 外国标头 struct externalstruct { int a; int b; }; 我的标题 / **我的结构
..
如何记录python函数参数类型？
我知道参数可以是任何对象，但是对于文档而言，指定期望的值非常重要。 首先是如何指定参数类型像下面这样？ str （或使用 String 或 string ？） int list dict function（） tuple 对象 MyClass 的实例第二，如何指定可以为$ b是 int 或 str 可以处理单个参数的多种类型？ 请使用下面的示例演示用建议的解决方
..
Objective-C文档生成器：HeaderDoc与Doxygen与AppleDoc
我需要为我的工作场所实施一个文档生成解决方案，并将其范围缩小到标题中提到的三个。在这些解决方案之间进行形式化比较的方式中，我几乎找不到信息，我希望那些具有上述一种或多种经验的人可以称职： 这是我从最初的通行证中收集到的内容： HeaderDoc优点：与Apple现有文档一致，与制作Apple文档集兼容 HeaderDoc缺点：难以修改行为，项目未积极开展工作，许多人放弃了它（这意
..
如何在Doxygen中包含自定义文件
我想添加自定义（非项目）文件以使用 Doxygen 生成一些额外的页面。 我（实际上）不确定如何命名这些文件以及应如何格式化其内容。 解决方案 在找到答案之前，我已经进行了很多搜索，所以我认为分享起来会很愉快！ 根据这篇 Doxygen陷阱文章我终于发现：您需要添加一个文件扩展名为 dox 。它的内容应包含C样式的注释块： / *！ \page我的测试页 内容 .
..
如何使用Doxygen制作简介页
我使用Doxygen为我的SDK制作了文档。它包含文件，名称空间，类，类型等的列表-我在代码中作为Doxygen注释放置的所有内容。现在，我想写一些关于SDK的常规信息（介绍的种类），它与任何代码元素都不直接相关。我想将此介绍放在文档起始页上。我该怎么做？ 解决方案 看看 主页 命令。 另外，请看一下对另一个线程的答案：如何包括Doxygen中的自定义文件。它指出了doxygen类作
..
Doxygen的自定义标签
我正在尝试确定是否有一种使用Doxygen创建自定义标签的方法。我确实找到了ALIAS配置文件选项，但是并不能完全满足我的需要。基本上在我的代码中，我希望能够编写类似 /// \req要求＃322-等等b $ b 然后让Doxygen像 \bug一样创建一个列表和 \todo 命令用于具有此自定义标记的行。 Doxygen可以做到吗？ 解决方案 \bug 的推广而
..
Graphviz + Doxygen生成UML类图
我要使用 Graphviz + Doxygen 生成基于C ++代码的类图。由于Doxygen带有本机DOT支持，因此已经可以使用。但是是否可能产生具有类似访问权限修饰符（公共，私有等），类方法的返回值和参数类型的 UML样输出，类似于下图？ 我知道线程如何使用doxygen从C ++源代码创建UML类图，但是并不能回答问题。 解决方案 创建以下源文件 example.cpp ：
..
未记录的功能不应在列表中查看/显示-仅针对已记录实体的发货凭证
类示例{ public func1（） private func2（） func3（） } 我仅检查了已记录的实体。我有func1和func3的文档，但没有func2的文档。我有 EXTRACT_ALL =否 EXTRACT_PRIVATE =否 EXTRACT_STATIC =否 EXTRACT_LOCAL_CLASSES =是 EXTRACT_LOCA
..
无法生成函数定义的文档，后跟一些宏#defines
我有一个.cpp文件，发现Doxygen无法记录包含以下格式的函数： / /！ //！ \简短测试 //！并在这些点上执行操作。 //！ void CTest :: TestTri（） EH_Start（“ CTest :: TestTri”） { } EH_Stop EH_Start 和 EH_Stop 是异常处理机制，并引起问题。
..
链接到外部主页
我制作了Doxygen文档，该文档本身使用标记文件机制引用了另一个文档。但是我现在想在其主页内链接到外部文档的主页。当然，我总是可以直接指定文件： ...使用[OtherDoc]（../../。 ./OtherProject/doc/html/index.html）... ... 项目彼此相对。但是尽管如此，我还是希望Doxygen自动执行此过程，因为它仍然需要知道外部文
..
Doxygen：显示未记录方法的警告
我已使用脱氧剂激活警告 警告=是 WARN_IF_UNDOCUMENTED =是 WARN_IF_DOC_ERROR =是 WARN_NO_PARAMDOC =是 但是像这样的无证方法： void AnimationManager :: setAnimationTimeStep（double timeStep） { ... } 在产生氧
..
如何用Doxygen记录Visual Basic
我试图在Windows中为Visual Basic使用Doxygen过滤器。 我从基于gawk的Vsevolod Kukol过滤器开始。 没有太多方向。 所以我开始使用他自己的VB代码 VB6Module.bas ，并通过他的 vbfilter.awk ，我发出： gawk -f vbfilter.awk VB6Module.bas 这将在stdin上输出类似C
..
Doxygen是否可以处理MainPage.dox以外的页面
如果您将MainPage.dox文件放在Doxygen的搜索路径中，则会将其添加到源文档上方Doxygen / html中的输出中。但是您可以拥有MainPage.dox这样的多个文件吗？还是仅限于一个？ 解决方案 Doxygen将识别并解析任何带有* .dox扩展名的文件，并将其包含在结果文档中。这些文件将产生什么，取决于文件中的doxygen注释。例如，如果要修改主页，则需要这样的注释
..
用Doxygen或PHPDoc记录获取/发布参数
我正在浏览PHPDoc的文档，找不到找到将我发送给各种方法的Post变量的好方法。 因此，我开始希望对Doxygen有所了解，希望它将为我提供记录所有这些变量的更好方法。我的代码涉及很多AJAX请求，因此大多数变量是通过post发送的。 我是否有一个很好的方法来记录doxygen中的post变量？我无法确定仅使用标准参数代码运行是否会出错。 如果没有，在此过程中是否还有其他记录员
..