doxygen 第10页 - IT屋-程序员软件开发技术分享社区

配置Doxygen以忽略源代码注释语言(SAL)

我有一些用Doxygen记录的类.此外，它们还使用Microsoft的源代码注释语言(SAL)进行注释，以支持静态代码分析. //! The majestic class. class Foo { //! \brief do something //! \param [out] pResult The result value is stored here. //! ..

发布时间：2020-07-31 05:41:17 c++ doxygen sal C/C++开发

那是in或in/out参数吗? Doxygen，C ++

如果将指针传递给函数以进行只读，则该指针是一个IN参数. 如果将指针传递给某个函数以进行只读操作，但是此函数在该模块相关的函数中进行只读操作时可以访问该指针的副本，则该指针仍为IN. 如果该函数仍将指针用作只读，但是其他与模块相关的函数将指针用于写操作，那么指针又是什么? 一个IN参数，但没有const?输入/输出参数? 我的意思示例: class SteeringWheel ..

发布时间：2020-07-23 07:07:38 documentation doxygen inout 其他开发

在.NET中使用XML注释有什么好处?

我不明白使用XML注释的好处.我知道可以将它们转换为代码外部的漂亮文档，但是可以使用更加简洁的DOxygen语法来实现.我认为XML注释是错误的，因为: 他们通常会混淆注释和代码. (它们更难于人类阅读.) 更少的代码可以在一个屏幕上查看，因为"summary"和"/summary"需要多行. (已删除) 那可能是什么原因，为什么在.NET中首选XML而不是简单的DOxygen语法 ..

发布时间：2020-07-15 02:40:54 c# doxygen xml-comments C#/.NET

强制doxygen从版本文件中选择一个

今天才开始使用doxygen.你会怎么做. 给出以下目录结构 -rootDir -dirA -dirAFile_ver01 -dirAFile_ver02 -dirAFile_ver03 -dirAFile_ver04 -dirB -dirBFile_ver01 -dirBF ..

发布时间：2020-07-13 20:59:19 file filter version doxygen 其他开发

Doxygen是否可以轻松配置为识别TODO和FIXME线?

我刚刚安装并设置了Doxygen的一个实例，但是在开箱即用的代码中，它只能在代码中找到TODO标记，例如: /** * @todo Foo */ 似乎找不到: // TODO Foo // FIXME Bar // @todo Baz 大多数处理解析的IDE和错误跟踪器都可以使用它们，是否有一种简单的方法来配置Doxygen来查找它们并将它们列为ToDo项? 解决方案 ..

发布时间：2020-07-11 02:23:32 doxygen todo 其他开发

在doxygen中，标准的"///\ todo东西"用于标记待办事项.我在MSVC中进行大部分编码，因此可以在“任务列表"中查看TODO. MSVC在其标签中使用"//TODO的东西".有什么办法可以使他们一起工作?我找到了“任务"列表的属性窗格，并尝试将"\ todo"添加到列表中，但是它不喜欢"\"字符.我可以让这两个一起工作吗? 编辑:我特别想了解如何在Visual Studio 10 ..

发布时间：2020-07-11 02:23:25 visual-studio visual-studio-2010 visual-c++ doxygen todo 其他开发

我应该如何记录继承的成员?

考虑到我有一个复杂的类结构，其中许多元素是从其他元素继承的.我可能在接口中定义了方法GetStuff(string stuffName, int count)，该方法由其他接口继承，然后由抽象类抽象地实现，然后在具体类中显式实现，等等. 在使用XML注释记录我的代码时，我该如何处理诸如GetStuff()之类的继承成员，这些注释将与Doxygen或Sandcastle之类的工具一起使用?仅在 ..

发布时间：2020-07-06 05:17:12 documentation doxygen sandcastle 其他开发

可以使用Doxygen，Sandcastle或其他文档生成器来记录XML吗?

我目前正在使用Sandcastle，Doxygen和JavaDoc为我编写的代码生成文档.是否可以使用这些软件包来记录XML模式?如果没有，是否有任何软件包(最好是免费的！)可以做到这一点?我可以自己编写文档，作为Doxygen或Sandcastle中的一个额外的概念性话题，但我宁愿使用一种工具为我做这件事！一个例子是(尽管我不是XML Schema的专家！): /// ..

发布时间：2020-07-06 05:17:00 xml xsd doxygen documentation-generation sandcastle 其他开发

如何生成rdoc样式的可折叠代码段?

我正在使用Doxygen为C ++项目创建内部文档.我让Doxygen包含了方法等的来源，但这使页面难以扫描.我希望它的行为像rdoc一样，并将源隐藏在默认情况下折叠的块中. 我以为HTML_DYNAMIC_SECTIONS可能会让我这样做，但是可惜，变更日志说该选项只影响图表. 也许我可以通过编辑LAYOUT_FILE来做到这一点? 无论如何，聪明的人，我如何强迫Doxygen ..

发布时间：2020-07-05 05:59:42 documentation doxygen rdoc 其他开发

Doxygen for Python:如何为嵌套函数生成文档

我正在使用Doxygen记录我的Python代码.该代码利用了Python定义嵌套函数的功能. 因此，我已将它们记录为仿佛它们是“正常"功能，并设置了EXTRACT_ALL=YES. 但是，嵌套函数仍然无法在任何地方找到.有什么方法可以使Doxygen做到这一点? (Doxygen版本1.8.6) 解决方案无法访问嵌套函数，因此请确保它没有文档化 def wra ..

发布时间：2020-07-01 05:26:12 python doxygen nested-function Python

Doxygen要求记录包含保护

请不要介意以下最小示例的奇怪之处(我必须将它扩大得更多，以证明为什么我这样做是有道理的): 文件test.cpp: #include "a.h" int main() { return 0; } 文件a.h: namespace N { // without namespace all is well! #include "b.h" } 文件b.h: /// ..

发布时间：2020-06-26 18:47:45 c++ doxygen include-guards C/C++开发

如何在Doxygen中禁用斜杠命令语法

我遇到了PHP 5.3名称空间和Doxygen注释的问题. 示例: /** * Sample Method * * @param string $output * @return \Project\Lib\Rest */ Doxygen给我以下警告: warning: Found unknown command `\Project' warning: Found u ..

发布时间：2020-05-27 18:33:10 php php-5.3 doxygen PHP

Doxygen:如何在php中描述类成员变量?

我正在尝试使用doxygen将php代码解析为xml输出. Doxygen不会解析类成员变量的描述. 这是我的示例php文件: 请注意，注释具有简短说明和变量类型. 这是我从此 ..

发布时间：2020-05-27 02:36:16 php variables doxygen PHP

是否有记录GET/POST参数的标准?

在PHP项目中，即使将主控制器逻辑用于主应用程序，也会有许多独立脚本，ajax代码段等. 是否有一种标准化的方法(PHPDoc或其他方法)在脚本的第一个注释块中定义脚本将接受/需要的GET和/或POST参数以及它们的类型? 我通常通过添加@param来帮助自己，就好像文件是一个函数一样，并添加@return解释脚本执行和返回的操作，但是也许还有一种我不知道的更专业的方法. 解决方 ..

发布时间：2020-05-27 01:54:34 php javadoc doxygen phpdoc PHP

使用doxygen生成具有自定义结构的PDF

在开始讨论细节之前，先简短介绍一下: 我正在尝试自定义doxygen生成的pdf文档结构.我已经在为html和chm输出执行此操作，但对于pdf则不起作用. 我的主要问题是，这是设计上的限制还是我遗漏了一些东西? 如果这是设计使然，我还有其他方法可以从doxygen开始，从而生成定制的pdf文档? 以下是详细信息: 我们正在使用doxygen生成C API的源代码文档，该文档 ..

发布时间：2020-05-25 04:15:42 pdf doxygen 其他开发

如何从Doxygen获取单个PDF文档?

当我生成PDF格式的Doxygen文档时，会得到很多不同的文件，每个文件都有一个图表. 是否可以获取单个PDF文档，将其组织成一本书，大致与HTML版本一样? 是否可以自动获取它，即无需手动处理乳胶文件? 谢谢！解决方案请参见 Doxygen完成处理后，在乳胶目录中有一个名为"refman.tex"的文件. 您可以通过三种方式使用该文件从Doxygen中获取“一本书": ..

发布时间：2020-05-25 04:02:51 pdf pdf-generation doxygen documentation-generation pdflatex 其他开发

在python中使用正则表达式确定C ++函数及其参数

所以我在此python脚本中做错了什么，但它变得令人费解，并且我看不到我在做错什么. 我希望脚本浏览文件，找到所有函数定义，然后提取函数的名称，返回类型和参数，并输出"doxygen"样式的注释，如下所示: /******************************************************************************/ /*! ..

发布时间：2020-05-25 01:34:29 c++ python regex parsing doxygen C/C++开发

python中的Doxygen C ++注释字符串解析器?

有人知道一个python模块来解析doxygen风格的C ++注释字符串吗?我的意思是这样的字符串(简单的示例): /** * A constructor. * A more elaborate description of the constructor. * @param param1 test1 * @param param2 test2 */ ， ..

发布时间：2020-05-25 01:06:02 c++ python parsing doxygen C/C++开发

Doxygen:记录函数指针类型(ANSI-C)的参数

我的代码需要一些函数指针类型，例如 /** * \brief Callback function type "foo" */ typedef int (*foo)(int a, int b); 我想记录函数自变量的语义，但是\brief语句旁边的\param[in,out]似乎并没有添加额外的文档. 有没有办法让doxygen将参数文档添加到type-defs函数中? T ..

发布时间：2020-05-24 22:44:05 c function pointers parameters doxygen 其他开发

Doxygen和package.html

根据javadoc规范，我在相关软件包的根目录中放置了一个名为package-info.html的文档文件.但是，当我在该文件夹上运行Doxygen时，此文件中的文档没有被提取.我如何告诉Doxygen使用此文件作为软件包文档?我也尝试了旧的规范package.html，但这还是行不通的. 解决方案为Java包提供文档的另一种新方法是使用名为package-info.java的文件而不是 ..

发布时间：2020-05-23 19:46:03 package javadoc doxygen 其他开发

doxygen相关内容