jjzjj

c++ - 正确使用Doxygen

我一直在尝试使用Doxygen来记录我的C++项目,但收效甚微:Doxygen无法识别某些宏,因此整个函数都被误解了,而且大多数时候不会生成文档,即使它们有特殊的注释block。恰当的例子:/***\def__MYLIB_FUNCTION_ATTRIBUTE(...)*\briefSomebriefcomment*\detailsDetaileddoc*\saSomevalidreferences*/#define__MYLIB_FUNCTION_ATTRIBUTE(...)__attribute__(__VA_ARGS__)/***\defIN*\briefTagforinputar

c++ - 在 Doxygen 中记录回调类型定义

我有以下类型定义:typedefvoid(__cdecl*tCallback)(constchar*Message);我如何使用Doxygen正确记录?我想记录tCallback和预期的参数。一个简单的例子:///\typedeftesttypedeftestbool在doxygen中产生正确的输出//typedeftCallbacktypedefvoid(__cdecl*tCallback)(constchar*Message);产生:C:/test.cpp:2:warning:Found';'whileparsinginitializerlist!(doxygencouldbeco

c++ - 如何在 Doxygen 注释中包含 .cpp 文件的子集?

我正在尝试编写一些Doxygen注释block,并且我想包含示例代码片段。当然,我希望示例能够实际编译,这样它们就不会过时。我的example.cpp(我\include在.h文件中)看起来像这样:#include"stdafx.h"#include"../types_lib/Time_Limiter.h"#includevoidtl_demo(){//scarcewillbeagatetocontrolsomeresourcethatshouldn'tgetcalled//morethan10timesasecondTime_Limiterscarce(10);//here'sabu

c++ - 使用 Doxygen + Graphviz 可视化一个巨大的 C++ 项目

我继承了一个大型C++项目,我需要将其移植到Linux。该项目中有超过200,000行源代码分布在300多个文件中。如果有一个可视化的依赖关系/包含树来引用这个项目,那将非常有帮助,这样我就可以对应用程序的内部结构有一个大致的了解。这也将帮助我找到核心模块和Windows头文件之间的“故障线”,以便我以后可以将它们stub。VisualStudio中的类查看器根本无法削减它。我四处阅读,了解到Doxygen是一种常用的列出依赖项的工具。我更像是一个视觉型的人,发现这并没有太大帮助。幸运的是,我了解了Graphviz插件,它使用一种叫做“Dot”的东西使我能够为部件生成依赖树。不幸的是,

c++ - doxygen C++ 内联模板文档

有没有办法像这样记录模板参数:template而不是用tparam列出每个参数?请注意,在当前的doxygen中,函数参数可以这样记录:voidfunction(inta/**如果没有,实现起来会有多难?如果您熟悉doxygen的内部结构,您能指出实现它的方向吗?谢谢 最佳答案 无法像您描述的那样记录您的模板参数。我会说这不是一个好主意,因为那样的话您将以不同于通常参数的方式记录您的模板参数,您为什么要这样做?通常是这样的:/*!\ptranspose:transposeamatrix**\paramAinputmatrix*\pa

c++ - Doxygen:C++ 项目中的多个\mainpage block

在两种情况下,我无法确定doxygen关于\mainpage部分的行为:如果您未指定\mainpage部分,它会使用任何其他页面吗?如果是,如何选择?如果两个文件都指定了\mainpage部分怎么办? 最佳答案 \mainpage命令指定用于自定义索引页的内容,因此如果您缺少它,它只是一个带有普通Doxygen页眉和页脚的空白页。我认为关于拥有多个\mainpage命令最安全的说法是它是undefined经典意义上的根据版本和平台产生不可预测的结果。同样,当我不小心创建了多个具有相同页面名称的\page命令时,我得到了奇怪的结果。进

php - 如何使用 doxygen 从 sql 文件生成 ERD?

我正在努力熟悉doxygen,并学会了如何评论php代码并记录它们。我读过doxygen可以像下面的mediwikierd一样生成ERD,它是由doxygen生成的。Screenshothttp://upload.wikimedia.org/wikipedia/commons/8/88/MediaWiki_database_schema_1-19_%28r102798%29.png我找不到任何可以指导我使用doxygen生成Mysqlerd的教程。如果它不可能或复杂,请建议任何其他可以比doxygen更好地从sql文件生成erd的工具。如果我能得到一些关于从doxygen本身生成实体关

python - 用 Doxygen 记录一个不存在的成员

我正在尝试使用Doxygen记录一个python类。该类通过d-bus公开一组属性,但这些属性在python类中没有相应的公共(public)getter/setter。相反,它们是通过d-bus属性接口(interface)(Set/Get/GetAll/Introspect)实现的。我想做的是能够使用如下方式记录这些属性:##@propertypackage::Class::Namedescription整个package::Class工作(相同的方法找到函数,所以它找到正确的类)。运行doxygen时出现以下错误:警告:记录的函数“package::Class::Name”未声明

html - Doxygen:如何在所有输出格式的主页上嵌入图像?

我在Ubuntu14.04上使用Doxygen1.8.6从C/C++头文件生成API文档。我有一个markdown格式的主页(文件mainpage.md),我想在该页面中嵌入一个图像(文件logo.png)。目前,我正在为HTML输出工作,目录结构如下:work├──mainpage.md├──resources│  └──logo.png└──html└──index.htmlThewaythemarkdowninmainpage.mdembedstheimage,is:![TheLogo](../resources/logo.png)这可行,但这取决于HTML输出目录比工作目录低一

html - Doxygen:如何在所有输出格式的主页上嵌入图像?

我在Ubuntu14.04上使用Doxygen1.8.6从C/C++头文件生成API文档。我有一个markdown格式的主页(文件mainpage.md),我想在该页面中嵌入一个图像(文件logo.png)。目前,我正在为HTML输出工作,目录结构如下:work├──mainpage.md├──resources│  └──logo.png└──html└──index.htmlThewaythemarkdowninmainpage.mdembedstheimage,is:![TheLogo](../resources/logo.png)这可行,但这取决于HTML输出目录比工作目录低一