我在我的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,则显示方程式的页面可能
我正在使用boost::python在C++代码中添加一个python模块。c++项目用doxygen记录。我想为python模块创建一个文档,但我不知道如何不像这样冗余:#includeusingnamespaceboost::python;/**@briefSumtwointegers*@paramaaninteger*@parambanotherinteger*@returnsumofintegers*/intsum(inta,intb){returna+b;}BOOST_PYTHON_MODULE(pymodule){def("sum",&sum,args("a","b"),"
我正在使用Doxygen来记录C++代码,并且正在为代码编写大量的Doxygen文档。在一个地方,我在代码中制作了一个组列表,并希望它显示如下:ControlModule:themodulethatcontrolseverythingSlaveModule:themodulethatistheslaveoftheControlModule我的文档源是这样的:-@refCM:themodulethatcontrolseverything-@refSM:themodulethatistheslaveofthe@CM但是,问题:Doxygen似乎将引用名称读取为CM:,而不是CM,因此无法找
有没有办法让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#--------------------------------------------------------------
所以我有一个简单的函数和一些文档:/***@param[out]destisoverwrittenbythesecondargument*@param[in]srcisvaluetooverwritethefirstargumentwith*/voidCopy(int&dest,intsrc){dest=src;}可能不是很有用,但很明显dest是输出的。但是,使用指针对我来说这条线变得模糊了:voidCopy(int*dest,intsrc){*dest=src;}dest应该还是一个输出吗?指针的值不会被修改,只有它指向的内存中的值会被修改。但我仍然会说可能是的。继续:voidWr
我有以下代码:///\fileDoxygen_tests.h/****\enumTick_Column_Type**\briefValuesthatrepresentTick_Column_Type.**/enumTick_Column_Type{TC_OPEN,///一切似乎都工作正常(枚举最终在文件范围内结束,但我有一个\file,所以它与描述一起出现,格式正确。我想要(但没有发生)的是,我希望Tick_Data_Row::m_cols文档中对Tick_Column_Type的引用链接回该文档页面。Doxygen通常似乎很聪明地弄清楚“啊哈,这是一个我知道的名字,我会热链接它”,但
我正在尝试记录以下内容: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上找