所以我开始使用Doxygen1.8.13(Windows10,64位)记录一个C++项目,并遇到了GraphViz的调用/调用者图生成问题。如果使用以下代码生成文档,Doxygen将生成如下所示的调用图:但如代码所示,Path()不调用任何函数(空主体)。structPath{Path(constNode*source_node,constNode*target_node,constunsignedlongcost,conststd::vectorpath):source_node(source_node),target_node(target_node),cost(cost),pat
我有这样的东西(来自QFlags文档的示例):public://!EnumdocenumOption{NoOptions=0x0,//!ValuedocShowTabs=0x1,ShowAll=0x2,};Q_DECLARE_FLAGS(Options,Option)现在我可以记录Option及其值,doxygen会很好地显示它们。但是我不能让doxygen为Options生成任何东西。在Qt文档中它看起来像this,他们在枚举文档的顶部和底部添加了注释,并将其列为索引部分中的单独类型。更重要的是,Qt能够链接到用作函数参数的QFlags(例如QObject::findChild())
我正在尝试使用Doxygen来记录一些选项控制宏符号的功能,例如://!\defBOOST_SOMEFEATURE/*!\briefOptionmacrothatisnotnormallydefined*butcanoptionallybedefinedbyconsumerstoactivatetheoption.*/但这不会被索引并且评论将被忽略,因为宏未定义。只有当有#definelike时,才会在文档中生成Doxygen宏符号条目#defineBOOST_SOMEFEATURE在头文件和其他文件中。除了像这样的讨厌的软糖之外,我可以强制宏符号的文档吗#undefBOOST_SOM
我正在为我的C++项目使用Doxygen,该项目将托管在github中。我想在自述文件中包含一个类的方法列表,并且我正在考虑使其自动化的方法。我将在repo中包含整个生成的html页面,但我认为通过在自述文件中包含主类的成员来提供API的概念会很好。到目前为止,我找不到生成Markdown文件的方法。我的下一个想法是编写一些shell脚本,它会自动复制成员列表并将其包含在自述文件中,为此我需要单独生成一个类的成员函数列表。是否可以配置doxygen来单独输出一个类的成员列表? 最佳答案 我最近有一个项目,我想将几个函数确定为公共
我在我的doxygen中包含了amsmath,我写道:\f{equation}{x=2\f}但是doxygen中的结果是\begin{equation}x=2\end{equation}而不是等式x=2有谁知道出了什么问题吗? 最佳答案 你做得对,我也这样做了,效果很好。该页面简要显示\begin{equation}x=2\end{equation},然后出现正确的方程。仔细检查您的配置文件中是否有USE_MATHJAX=YES。默认是NO参见:USE_MATHJAX在Doxygen引用中。如果未设置为YES,则显示方程式的页面可能
有没有办法让visualstudio自动将doxygen标签放在C++源文件中?我的意思是例如这段代码:intfoo(boolp);如果我在上面键入///,VisualStudio会自动生成以下行:///////////////intfoo(boolp);我的问题是:是否可以对doxygen做同样的事情(当我键入/**时)?使VS生成以下内容:/***@brief*@paramp*@return*/intfoo(boolp)我的问题是关于编写文档标签(不生成最终的doxygen)。 最佳答案 VS19中有一个设置可以做到这一点:工具
在使用库ABC时,很自然地所有名称都包含在同一顶级namespace中。是否可以从class名称中删除顶级namespace,但显示封闭的namespaces? 最佳答案 Doxygen中没有这样的选项。您仍然可以使用预处理器使其工作。#ifndefDOXY_PARSER#defineLIB_NAMESPACE_STARTSnamespacelib_namespace{/##/#defineLIB_NAMESPACE_ENDS}/##/#defineLIB_NAMESPACElib_namespace#else#defineLIB_
Doxygen没有显示记录的成员函数(包括构造函数)是如何从其他类调用的。?我使用EXTRACT_ALL选项设置“自动文档”。我设置了CALL_GRAPH选项来获取调用引用。我也确实启用了graphviz/dot(输出)选项。这是我的选择日志:#---------------------------------------------------------------------------#Projectrelatedconfigurationoptions#--------------------------------------------------------------
我正在尝试记录以下内容:templateclassmyClass{public:..这是氧气/*!*\classmyClass*\briefDefinesaclassforstuff.*/发电量:myClassClassReferenceDefinesaclassforstuff.所以我缺少模板信息,但这不是世界末日,因为我知道doxygen不能很好地处理模板。主要问题是生成时的警告:myClass.h:2:warning:thename`T'suppliedastheargumentofthe\class,\struct,\union,or\includecommandisnotan
准确地说:我知道如何在声明时对枚举进行dox,我想改为不在线地对它们进行dox。我想让头文件没有doxygen注释;它们都在.cpp文件中。这对函数、类、typedef等来说不是问题。我还可以像这样记录enum本身:/*!\enumMyClass::MyEnumFooBarBaz\valueFirstEnumValue但是我如何记录enum的值呢?谢谢! 最佳答案 您需要根据docs使用\var 关于c++-doxygen:如何记录\enum值外线?,我们在StackOverflow上找