doxygen相关内容

标记覆盖的功能

是否存在像\deprecated这样的命令,但是用于标记覆盖的功能? Java为您已重写的功能添加了注释@override.我想在C ++中做同样的事情,以便可以看到已重写的超类函数.充其量,文档页面上还应该显示所有继承的类成员函数,但不会被指向超类函数的超链接显式覆盖. 我知道有一种方法可以从超类方法复制文档.但是我不想复制整个文档.我只想知道,一个函数是继承的.该行为应与不赞成使用 ..
发布时间:2020-05-23 18:37:34 C/C++开发

从顶部到底部的方向翻转doxygen的图

创建了"包括"和"被包括"的doxygen图,嵌套深度从上到下递增(使用1.8.5). 由于我们的图大多数都是带有多个节点的浅图,因此这会导致带有丑陋的水平滚动条的非常宽的图.有没有一种方法可以教导doxygen以从左到右的方向创建这些图,以及创建呼叫者/调用图的方法? 我知道graphviz/dot支持这一点,但是找不到告诉doxygen我的偏好的方法. 解决方案 最近有一个 ..
发布时间:2020-05-22 18:50:43 其他开发

Doxygen-声明参数为可选

我正在使用Doxygen记录代码库,想知道是否有一个关键字来声明函数的参数是可选的.像这样: /*! \fn int add(int a, int b=0) \brief adds two values \param a the first operand \param \optional b the second operand. Default is 0 \return the res ..
发布时间:2020-05-21 22:15:09 C/C++开发

“使用命名空间"有关Doxygen的评论

我的库的所有类都在名称空间中定义.当我为Doxygen创建主页时,必须在注释中显式使用此命名空间,以使Doxygen生成链接.我想在整个注释块中使用“使用命名空间"之类的东西. 一个例子: /** * \mainpage My Library * * Use MyLibraryNamespace::MyClass to ... */ 此处Doxygen自动生成指向MyLibrary ..
发布时间:2020-05-16 20:14:19 其他开发

氧气慢

Doxygen在我们的代码库上运行大约需要12个小时.这主要是因为要处理大量代码(约150万行).但是,它很快就会接近我们无法进行每晚文档更新的时间,因为它们花费的时间太长.我们已经不得不减少图表深度以将其减少到12小时. 我已经尝试了标准方法,但是我确实确实需要高质量的输出,其中包括图形和SEARCH_INCLUDES.我有一台相当不错的机器来运行Doxygen,但是Doxygen没有利用 ..
发布时间:2020-05-13 19:23:58 其他开发

Doxygen用于多语言API

我的公司开发了用于工程程序的API.它是用C ++开发的,但是我们为以下语言创建了包装器: 类似于VB的专有语言 MATLAB 和Python. 当前,文档是由一堆脚本生成的,要使其保持100%,它开始变得很耗时.我想知道是否有办法一次性获得doxygen/sphinx或另一个程序来生成C/C ++,VB和MATLAB的文档. Python部分由SWIG完成.当前输出类似于: ..
发布时间:2020-05-06 14:23:42 C/C++开发

生成Matlab HTML文档的Mathworks方法是什么?

我正在研究共享的Matlab代码,我们希望在本地网络中将生成的文档共享为可搜索的HTML文档. 我知道以下生成文档的方法: 将转换器写入类似C ++的文件.这是在与Matlab一起使用Doxygen (最后2011年更新)和 mtoc ++ (最新更新时间为2013年).然后由Doxygen解析类似C ++的文件. 使用Python的 sphinxcontrib-matlabdoma ..

使用@file在Doxygen中降价

我正在尝试使用围栏代码块用doxygen和markdown记录一些源代码模板 ~~~cpp /// @file filename.h ~~~ 但是Doxygen似乎会处理@file命令,即使其逐字代码会导致警告 warning: the name `filename.h' supplied as the second argument in the \file stateme ..
发布时间:2020-05-06 03:59:41 其他开发

Doxygen:如何使整个文件“内部"?

我想制作我的文档"Internal"的整个页面,以便仅在INTERNAL_DOCS = YES时生成.我将markdown格式用于此文档的大写文本,因此所有这些文件都具有 .md 扩展名,但这不应该有所作为. 如果我将其应用于源文本文件的@page part 中,则将按预期方式工作,因为页面的所有证据都将从输出中消失: @internal @page hidden_page Blah ..
发布时间:2020-05-06 03:54:09 其他开发

创建pdf时在markdown中进行分页

我正在使用doxygen(1.8.6)创建markdown文本文件的pdf.现在,我想在markdown文件的特定阶段获得分页符,我使用了链接. 在给定的链接中,他们提到使用'>'作为换行符.但是他们没有提到分页符.是的,我也可以使用'>'来进行分页符,但是我必须在markdown文本文件上写入此符号5次或更多次,这会使markdown文件看起来很奇怪.还有其他方法可以在markdown文件中获 ..
发布时间:2020-05-06 03:45:32 其他开发

如何在vim下突出显示Doxygen的降价促销?

较新版本的doxygen带有markdown支持.有没有一种简单的方法可以将markdown语法高亮添加到vim中的doxygen注释块? 另一方面,可以使用set filetype=c.doxygen 将doxygen语法添加到c文件中 解决方案 要正确执行此操作,必须通过复制语法或定义可能包含以下内容的区域来扩展Doxygen语法扩展脚本以支持Markdown语法Markdown并使用 ..
发布时间:2020-05-06 03:44:52 其他开发

如何在Doxygen的降价文档之间链接?

我有一个项目,其中包含一组降价页面,这些页面与链接(例如, [Go to this page](subdir/MyOtherPage.md) 所有页面都被doxygen拾取并显示在输出中,但是链接并未更改以指向其新的html格式. 我可以更改指向html页面的链接,但是我的项目托管在github上,然后这些链接将被破坏,因为github支持自动在markdown页面之间进行链接. ..
发布时间:2020-05-06 03:42:38 其他开发

如何使用Markdown页面和Doxygen组?

我正在使用Doxygen和Markdown编写技术手册. Markdown简化了生成HTML的工作,而Doxygen则具有多年的使用它的代码经验,并且知道如何使用\ingroup工具生成良好的跨文档,Doxygen具有丰富的经验. 我无法让后者与Doxygen对Markdown的处理正常工作. 我想要实现的是编写一个具有完整描述性的培训文档,但能够标记重要的部分,并使Doxygen将其 ..
发布时间:2020-05-06 03:41:06 其他开发

使用README.md文件作为Doxygen的主页

Doxygen的文档指出,我可以在markdown文件中使用PHP Markdown Extra标题标签,但不能使用 # Main Page # {#mainpage} 也 # Main Page # {#index} 有效,但是标签也不以纯文本形式出现在输出中.这是BTW的第一行. 我也无法使用以上标签或文件名来引用该页面. 我也有一个main.dox文件,其中包 ..
发布时间:2020-05-06 03:40:13 其他开发

用doxygen记录配置宏

我想用doxygen记录配置宏.该宏未在源代码中定义,但需要使用编译器定义设置进行定义. 由于我没有定义,因此尝试了类似在doxygen手册中找到的以下内容(我将此代码段添加到了使用宏进行条件编译的标头中): /*! \def MY_CONFIG_MACRO \brief Brief Details. */ 但是,该文档未出现在生成的HTML文件中.知道为什么上面 ..
发布时间:2020-05-05 09:10:20 其他开发

在Doxygen中调试乳胶错误的提示

现在我收到一条错误消息: No file _formulas.aux. ... ! Missing $ inserted. ... 我已经尝试在代码中查找和单个@f$标签,但是到目前为止,我未能成功找到罪魁祸首.我该如何解决这个特定问题? 此外,调试doxygen中的乳胶错误有哪些常规技巧?某处有日志文件吗? 解决方案 我同时使用了Doxygen和LaTeX.编译公式时,D ..
发布时间:2020-04-29 04:00:20 其他开发

LaTeX中使用doxygen的各个功能文档

我正在LaTeX中为某些软件编写各种手册.我必须使用 article 类.我必须在手册中包含各个c ++类的文档.我正在为此寻找氧气,但是我从未使用过氧气(如果有更好的方法,请告诉我). 我可以用doxygen生成整个项目的一个很好的LaTeX(-> pdf)文件.但是我想做的是以某种方式提取每个类的LaTeX源,并将其放入我的LaTeX手册源中的适当位置. 我尝试将refman.te ..
发布时间:2020-04-29 03:58:11 其他开发