doxygen相关内容
我正在使用doxygen记录我的C代码。为了更好的可读性,我使用 defgroup 和 addtogroup (请参阅 doxygen c:分组定义)。 文件页面看起来不错,但是在组/模块页面上,所有变量文档都翻了一番。在头文件中声明(带有extern)的每个变量都有2个条目,并在.c文件(摘要和描述部分)中定义。功能和其他一切只列出一次... 如何摆脱组/模块页面上的douplicate
..
我使用Doxygen记录我的python模块,我试图让它链接到文本中的函数。我可以让它链接到函数的命名空间,但不是函数本身。 例如。 ModuleName :: Namespace 工作但 ModuleName :: Namespace :: getSomething()不。 如何让这些链接工作? 解决方案 Doxygen自动将功能包装在每个模块的命名空间。您必须记录此模块,以
..
我对Doxygen有一个非常奇怪的问题:我用它从我的C#代码的XML标签创建文档,如其他StackOverflow问题中所建议的那样。基本上是这样的情况: // file:Foo1 public class Foo1 { public enum Bar { Bar1, Bar2 } } //文件:Foo2 public class Foo2 { pub
..
考虑以下单文件项目。 / ** \defgroup api公共API * / / ** *这是foo和bar在一起。 * \inggroup api * / void foobar(){ //没有这里可以看到。 } 在包含此文件的目录中,我运行以下命令。 > doxygen -g doxygen Doxyfile
..
我有一个使用Qt的项目。该文档由doxygen生成。可以配置doxygen以生成在线qt文档的链接。 例如, / ** *实现QAbstractListModel。 * / 这样的评论将在输出中有一个互联网链接到Qt在线文件QAbstractListModel。 解决方案 您可以使用 TAGFILES 选项,那么您可以将在线链接设置为TAGFILE。
..
Doxygen无法为.cpp中的函数记录,如 Hello All, 我有一个.cpp文件,发现doxygen无法记录包含以下格式的函数: //! //! \brief Test //!并对这些点进行操作。 //! void CTest :: TestTri() EH_Start(“CTest :: TestTri”) { } EH_Stop
..
我目前正在为我的C#代码创建文档。我做了很多普通的源代码,并设置了doxygen来创建HTML。最后我到达了在WPF中完成的UI,所以这两个XAML和源代码。现在我的问题是,记录这些文件的最好方法是什么?评论可能在XAML,但不是有用的,因为它们不能嵌套。另外我不知道Doxygen是否可以处理XAML文档。所有这些都应该记录在xaml.cs文件中? 解决方案 我发现了一个或多或少的好解决方
..
我使用的是doxygen,但是它没有记录我的一些类。所有这些类都通过以下方式调用: 我假设它与if(!class_exists('a'))有关,我怎么能让doxygen还记录这个? 解决方案 Do
..
我们来考虑以下源代码。 /// ///这是一个我想要的文件 /// /// param1的说明 /// param2的说明 ///请参阅Type1 [Ap
..
如何记录PHP常量: define('SOME_CONSTANT','constant value'); 与Doxygen? 解决方案 只需在常量 define()函数调用或 const 这个:
..
我知道如何通过标记示例文件的一部分来创建代码片段: //! [myfunc示例] int i = myfunc(1,“example”); 如果(i = CORRECT_VALUE)printf(“success”); //! [myfunc示例] ,然后包含其他地方: / snippet mytestfile.c myfunc示例 在
..
我有一个C项目,其中包含两个名称相同的函数,但每个都在不同的组/模块( @defgroup )中。 这些函数各自编译成不同的二进制文件,但是我需要紧密交叉引用文档,所以我需要参考( @ref )到彼此的模块中的这些功能(等等)。 当我做简单的 @ref name-of-the-function ,它始终链接到位于文件树中较早的文件中的文件。如何链接到另一个? 解决方案 据我所见
..
我正在使用Doxygen为C ++项目创建内部文档。我有Doxygen包括方法的源,等等,但这使得页面类型难以扫描。我希望它的行为像rdoc,并将源代码隐藏在默认情况下折叠的块中。 我以为HTML_DYNAMIC_SECTIONS可能会让我这样做,但唉,更改日志表示该选项仅影响图表和图表。 也许我可以通过编辑LAYOUT_FILE来执行? 无论如何,聪明的人,Doxygen可以生
..
在我正在处理的 .md 文件中,我有一个混合使用markdown和 @file 的问题与Doxygen 1.8.5。 如果我使用: 发行说明 @file releases.md 发行说明 @tableofcontents @section rel_page发布历史 Blah blah blah 除了第一个# line)。为了完整起见,这种情
..
我们有一些makefile模板,通过设置一些参数makefile变量来实现某些构建操作,并通过包含如 应用一个makefile模板 GENERIC_PARAM1-y:= paramA GENERIC_PARAM2-y:= paramB 包含$(MAKE_TOOLS)/doaction.mk 像 doaction.mk 这样的文件包含make模板来生成标准规则定义,
..
我正在Windows中使用一些Doxygen过滤器进行Visual Basic。 我从Vawvo Kukol过滤器开始,基于gawk。 没有太多的方向。 所以我开始使用自己评论的VB代码 VB6Module.bas ,并通过他的 vbfilter.awk ,我发出: gawk -f vbfilter.awk VB6Module.bas 这将在stdin上输出类似
..
如何使用Doxygen生成Qt样式的文档(Trolltech的C ++ Qt或Riverbank的PyQt文档)?我正在记录Python,我希望能够改进它产生的默认功能简介。 特别是,我希望能够看到返回类型(可以是用户指定的)和函数简介中的参数。 例如: 函数: int getNumber(self) str getString(self) tuple getTuple
..
我正在使用Doxygen进行C ++项目。当我构建html文档时,我收到以下错误: C:/ Amir / Programming / Eclipse C ++ / CacheOptimization / src /CacheLruNaiveAlgorithm.cpp:19: 警告:没有唯一匹配的类成员 void CacheOpt :: CacheLruNaiveAlgorithm
..
最近(最后)我已经开始记录我的一个开源项目。该项目是.Net的类库。我使用Doxygen从源代码生成HTML文档。 现在,我的问题是应该存储Doxygen在我的源代码控件中生成的HTML文件吗? 解决方案 您是否认为每次提交代码时都可以重建文档?否则,您的文档将很快变得不可靠,因为它可能 - 或者可能与您的代码不一致。 但是我明白这是很难决定的,因为特别如果您的项目是启动/小型
..
有些人建议Doxygen,一些ccdoc,应该更类似于javadoc,但不太受支持。你的意见是什么? 解决方案 我使用 Doxygen 有几个原因: 通话图 协作图 继承图 依赖关系图 在提交任何内容之前,所有更改必须记录在案,我们的常规版本涉及生成文档。 Doxygen的这些非常方便的功能增加了任何项目的总线系数。
..