doxygen相关内容
我喜欢doxygen来创建C或PHP代码的文档。我有一个即将到来的Python项目,我想我记得Python没有/ * .. * /评论,还有自己的自我文档设施,似乎是pythonic的方式来记录。 我可以只使用doxygen吗?有什么特别要注意的吗? 我已经在Python中做了一些编码,但到目前为止,只有在我懒惰的小项目中,我才知道(是的,我知道...但是现在我们假装现在没问题了。
..
我的团队开始使用doxygen记录我们的C代码,特别注意我们的公共API标头。在doxygen中似乎有很多灵活性和不同的特殊命令,这是很好的,但不清楚什么是好事,什么是坏事没有试错。 你最喜欢的方法是标记你的代码,你必须做什么和不要做什么? 请提供你的顶尖技巧,每个答案一个方便投票。 / p> 我希望定义我们整个API文档的方法,包括提供一个模板,让其他团队开始。到目前为止,我有
..
Xcode 5的新功能之一是能够记录您自己的代码具有特殊的注释语法。该格式与Doxygen类似,但似乎只支持这些功能。 哪些命令被支持,哪些不支持? 他们的使用与Doxygen有什么不同? 解决方案 以下是我在Xcode 5.0.2中找到的所有选项的示例 是由以下代码生成的: / **第一行文本。 放置\\\\ 不会创建一个新行。\\\ 创建换行符的一种方法
..
我正在使用Doxygen记录大学的c ++项目,一切都正确,但依赖关系图如下所示: 我希望图形不会显示列表,地图或字符串等内容,只包含我为项目创建的自定义类,但是我找不到在线或文档。有没有人知道如何做? 解决方案 由于你想排除stdlib容器类,你应该添加 std :: 命名空间到你的doxyfile: EXCLUDE_SYMBOLS = std :: *
..
由于cuda的“.cu”文件基本上是c,有没有办法我们可以使用doxygen生成文件的“.cu”文件?我注意到NVIDIA使用doxygen生成cuda的文档。但是,当我使用doxygen,“.cu”文件被忽略。 解决方案 我怀疑这是你的问题: http://www.stack.nl/~dimitri/doxygen/config.html#cfg_file_patterns 如果I
..
标题1
标题2.1
第2.1.1段
第2.1.2段
第2.1.3段
标题2.2
第2.2.1段
..
我使用Doxygen从我的代码生成HTML文档。然而,我发现默认样式表有相当差的字体和布局的选择。我知道我可以写我自己的CSS文件来获得我想要的输出,但在我花费我的时间之前,我想知道是否有任何体面的自定义样式表已经可用。 解决方案 我对Doxygen CSS做了一些基本的修改,以清理它一点。我已将其上传到 bitbucket.org/rc1/doxygen-style/
..
我有一个c#项目,我需要与doxygen记录。它接受visual studio的 /// 自动生成的注释,但不幸的是它不能接受正常的 // 注释。有没有我缺少一个配置设置?或者这是不可能的? 解决方案 /// 作为 XML文档注释。这是Doxygen和其他文档生成软件如何定位您需要的代码区域。 要详细说明,如果有 //这是hacky,但我会在你的代码中返回,你应该将它们更改为一个XM
..
我是一个大风扇的 doxygen 和其他文档生成工具,我想迁移此项目以使用这些系统之一。 有人知道一个工具可以扫描源代码注释的关键词,如“说明”,“作者”,“文件名”和其他种类的上下文智能转换注释为标准格式? 感谢 解决方案 当我阅读O'Reilly在 Lex + Yacc ,是有代码在命令行输出注释,第2章中有一节介绍如何解析注释的代码,包括 // 和 /*..*/ ...在
..
我使用Doxygen的 \ page , \subpage 和 \section 构造,以便为我的应用程序提供概述文档。在这里我使用HTML来创建一个格式很好的表。 但是,我想删除输出中的表的一部分,而不删除注释本身。例如 / *! \page MAINPAGE主页
Do This 100
..
常识告诉Doxygen注释块必须放在类,结构,枚举,函数,声明所在的头文件中。我同意这是一个声音的参数,一个库的意思是分布没有它的源(只有头和库与目标代码)。 BUT ... I当我开发公司内部(或作为自己的一个侧面项目)库时,我们一直在考虑完全相反的方法,它将与其完整的源代码一起使用。我建议的是把大的注释块放在实现文件(HPP,INL,CPP等)中,以便不要混淆在头中声明的类和函数的界面。
..
Xcode 5的新功能之一是能够使用特殊注释语法记录您自己的代码。该格式与Doxygen类似,但似乎只支持这些功能的子集。 哪些命令受支持,哪些不支持? 它们的用法与Doxygen不同吗? 解决方案 下面是我在Xcode 5.0.2中找到的所有选项的示例 img src =“https://i.stack.imgur.com/RisSW.png”alt =“enter i
..
我使用doxygen,但它不会记录我的一些类。所有这些类都以下列方式调用: 我假设它与if(!class_exists('a'))让doxygen仍然记录这个? 解决方案 Doxygen有许多问题
..
我试图安装doxygen在我的CentOs 6.3机器,我得到这个错误。任何想法?? [root @ dell1 doxygen-1.8.3.1]#make install / usr /安装-d / usr / local / bin / usr / bin / install -d / usr / local / doc / doxygen / usr / bin / in
..
我有一些C ++ / CLI软件,这是所有好的,并记录在一个C#的ish这种方式,这意味着DOxygen能够拉出一些不错的html。有什么办法我可以得到相同的信息出现在intellisense工具提示的.NET框架的方式吗? 例如,让我们说这是我的标题文件(MyApp.h): / *************** MyApp.h *************** / ///我的命
..
我正在开发一个项目,其中主要从ac#应用程序使用c ++ / cli库。 有任何方法使代码注释c ++ / cli在visual studio中可见的c#intellisence? 假设没有,最好的方式是记录c ++ / cli代码,从c#(和c ++ / cli当然)?你对XML评论和doxygen对其他工具的意见是什么? 解决方案 我得到它的工作如下: 对C ++ /
..
class EXAMPLE { public func1() private func2() func3() } 我只检查了有记录的实体。我有func1和func3的文档,但没有func2的文档。我有 EXTRACT_ALL = NO EXTRACT_PRIVATE = NO EXTRACT_STATIC = NO EXTRACT_LOCAL_CLA
..
这肯定是一个noob问题,但我不能在Doxygen文档中找到一个答案。我不确定是否使用: @file 或 @class 。 原因是如果我把文件,所有的注释只出现在文件选项卡,但不是在类选项卡(每个)。 对于cpp它没关系,我只是使用文件,它是好的,但如果我在标题中使用文件和类(文件开头和类的声明开始之前的类声明)然后我在生成的文档中的类的重复条目... 我
..
我目前正在用Doxygen记录我的代码。看起来好像Doxygen不能处理模板化的返回值。我的问题: / ** *从图表中检索所有边。 * @param gID图的ID。 * @return包含顶点对的列表,表示图形中的边。 * / int GetEdges(const int& gID); // Works fine / ** *从图中检索所有边。 *
..
我使用doxygen 1.7.1为一些C ++ 11代码生成文档,似乎忽略了我的模板别名。 为了清楚起见,下面是一个模板别名的示例: template 使用ResultOf = std :: result_of :: type; 它也无法使用语法选择更清晰的新的传统typedef: 使用PredicateOne = std ::
..