问题标签 [doxygen]

Does anyone know of or have a Lingo filter for Doxygen?

I have played with DocMaker, but it introduces dependencies on director and is not a flexible or full featured as Doxygen.

-Marty

我正在开发一个相当大的开源 RTS 游戏引擎（Spring）。我最近添加了一堆可由 Lua 调用的新 C++ 函数，我想知道如何最好地记录它们，同时也鼓励人们为许多现有的 Lua 调用编写/更新文档。

因此，我认为如果我最初可以将文档编写为 C++ 函数附近的 doxygen 注释，这可能会很好——这很容易，因为函数体显然准确地定义了函数的作用。但是，我希望使用引擎的游戏开发人员能够改进文档，他们通常对 git（我们使用的 VCS）或 C++ 了解甚少。

因此，如果有一种方法可以从 C++ 文件中自动生成 apidocs，而且还有一个类似于 wiki 的 Web 界面，以允许更广泛的受众更新评论、添加示例等，那将是理想的。

所以我想知道，是否存在一个集成了 doxygen 样式格式、对这些评论进行类似 wiki 的编辑（最好不允许编辑源文件的任何其他部分）和 git 的网络工具？（将通过 Web 界面更改的评论提交到特殊分支）

然后，我们开发人员可以不时合并此分支以将改进添加到主分支，同时开发人员对文档的任何改进都将最终在此 Web 工具上，只需将主分支合并到此特殊分支分支。

我还没有找到任何东西，怀疑这个特定的东西是否存在，所以欢迎任何建议！

关于这个问题，我想知道是否有人知道将单个 doxygen 注释转换为 HTML 的 javascript 代码片段/库？

例如，

将被转换为类似的东西：

doxygen 的所有其他与格式相关的标签都类似。

我已经找到了这个，如果我必须自己实现它，这似乎是一个很好的起点，但可能我错过了一个完整的项目:-)

所以，欢迎提出建议！

我有一个 .cpp 文件，发现 Doxygen 无法记录包含以下格式的函数：

EH_StartandEH_Stop是一种异常处理机制，会导致问题。

我们如何排除这些？

背景：

我在 Objective-C 中创建复合字典数据结构的层次结构，并且从NSMutableDictionary继承，因此这些类可以在需要 NSDictionary/NSMutableDictionary 的任何地方使用。（只是为了让人们不认为我在重新发明轮子，每个人都使用CFMutableDictionaryRef，加上一些以排序顺序、插入顺序等存储键的额外结构。）为了与 Apple 的文档保持一致，我重写了这些类中的所有其他方法都使用必要的NSDictionary 原语和NSMutableDictionary 原语。

目标：

由于我努力尽可能完整地记录我的框架的 API，我希望我的自定义子类（由 Doxygen 生成）的文档包括对 NS(Mutable)Dictionary 最常用方法的描述，因此用户不要必须查看另一个页面，以查看特定自定义字典继承的方法未更改。此外，有时文档必须反映由覆盖的原始方法引起的不同功能，尽管方法实现与 NS(Mutable)Dictionary 没有变化。

问题：

当仅记录被覆盖的方法时，我没有收到任何错误/警告。如果我添加记录继承方法的注释，Doxygen 会抱怨（并且不会生成所述文档），除非我将方法原型添加到头文件。如果我添加一个原型，编译器会发出一个执行完成的警告，因为它不包含声明方法的方法定义。显然，这是该方法存在于父类中的情况，但编译器在实现它时坚持不懈，因为原型本质上是在子类中重新声明的。

问题：

• 是否可以让 Xcode/gcc 抑制从父类继承的方法的“未找到‘X’的方法定义”警告？
• 是否可以强制 Doxygen 为不存在声明的方法创建文档？我尝试使用该\fn命令，但得到了相同的结果。
• 是否有可能让 Doxygen 认为我编写的文档实际上适用于 NSMutableDictionary，但它是否出现在我的所有自定义子类中？

编辑：

据我所知，第一个问题的答案是肯定的和否定的。从技术上讲，使用该-Wno-protocol选项（或在 Xcode 构建设置中取消选中“不完整的 Objective-C 协议”警告）确实会导致 GCC 抑制关于似乎没有实现所有协议方法的类的编译时警告。然而，这掩盖了真正没有实现所有必要方法的类的问题。对于构建一个大量使用协议的框架，这真的不是一个选择。目前，GCC 似乎不知道从链接（非源）父类继承的方法。

我在工作场所使用 Doxygen，并且遇到了 Java 代码问题。在 EXTRACT_ALL=NO、EXTRACT_PRIVATE=NO、EXTRACT_STATIC=NO、EXTRACT_LOCAL_CLASSES=NO 和 EXTRACT_LOCAL_METHODS=NO 时，输出仍然包括未定义为公共或私有的静态成员。

前任。假设我有以下代码：

func3仅定义为static因为它是包级函数。

func1并func3出现在输出中，而我只想func1出现。

有谁知道只显示那些明确定义为公共的功能的方法？

提前致谢。

我正在开发一个主要从 ac# 应用程序使用 c++/cli 库的项目。

有没有办法让 c++/cli 中的代码注释对 Visual Studio 中的 c# 智能可见？

假设没有，那么记录 c++/cli 代码以使其更容易从 c#（当然也包括在 c++/cli 中）使用的最佳方法是什么？您对 XML 注释、doxygen 和其他工具（哪个）有何看法？

我正在评估 AtomineerUtils 插件（它允许 Visual Studio 自动输入 doxygen 注释块）。

当我有一个包含 __declspec (dllexport) 的类定义时，它会稍微出错。也就是说，它不是在它添加的注释块中出现类名，而是使用单词 declspec。

小烦恼，但还是烦恼。

有人使用此工具并有任何线索吗？

我正在尝试使用 xrefitem 创建一个“相关页面”，但它似乎没有工作，也没有内联。这是一个例子：

我正在使用 Doxygen 1.5.9。这些都没有出现在相关页面中。我还将评论包含在 CPP 文件中。

在 doxygen 中，我可以在我的实现文件中创建objective-c 类别来隐藏不应公开访问的接口。但是，doxygen 仍然将该类别记录为“公共”成员。即使添加了\protected 或\private，情况仍然如此。

是否有另一种我忽略的方法可以将其放在该类别的“私有方法”部分......或者更好的是在公共类仅列为私有的同一文档中？

这是我的配置的一部分：