在定义中将未使用的函数参数保留为未命名是很常见的。例如:inlinestd::stringoperator""_s(charconst*constop,size_tconst){return{op};}在这种情况下,doxygen1.8.12似乎错误地(最后一部分)了参数名称的类型:warning:Thefollowingparametersof…arenotdocumented:parameter'const'有没有办法在不关闭WARN_IF_UNDOCUMENTED且不将参数包装在\cond、\endcond中的情况下消除此警告? 最佳答案
我一直在网上阅读Doxygen,我想我想在我的NetbeansC++项目中尝试一下。问题是,我在任何地方都找不到关于如何让Doxygen与Netbeans一起工作的任何教程/指南。我发现了一些似乎是关于在Netbeans中使用Doxygen的博客文章,但它们似乎是半功能请求,而且我无法判断它们是实际指南还是只是“这就是它完成后的样子”的帖子.那么,这里有人有使用Doxygen和Netbeans的经验吗? 最佳答案 使用Doxygen不需要IDE的支持,可以单独使用。要创建Doxygen文档,您只需要源代码和Doxygen编译器。但是
我们使用doxygen来记录我们的类。我想明确地记录一个类已经生成构造函数和/或析构函数,以表明我已经考虑过它并决定例如使用生成的复制构造函数进行复制是安全的。但是,构造函数/析构函数未声明,因此doxygen不知道文档属于哪个函数。有没有办法让doxygen包含函数注释,即使函数从未声明过?//!TheFooclassdocumentationclassFoo{//!@fnFoo(constFoo&)//!GeneratedcopyconstructorOKtouse//!methoddocumentationvoidmethod();}此外,我根本不想写生成文件的签名。我想我的另一
有没有办法阻止Doxygen在它生成的图表中包含基本的C++类型(int、float等)?例如,当协作图包含大量用户定义的类型时,知道它们在内部都使用int不如查看类型之间的关系和大量行一样有用从图表的所有部分到int类型使图表在视觉上“很忙”并且更难阅读。理想情况下,代码应该设计得足够好并且模块化,这样协作图就会小而简单,并且包含基本类型也不会成为问题。但是Doxygen真正发挥作用的一种情况是,当存在大量编写糟糕的代码时,用户必须尽快掌握并着手处理,最好简化此中的协作图案例。我知道减少MAX_DOT_GRAPH_DEPTH可以简化协作图,但这会减少用户定义类型和基本类型的数量。为了
我已经用doxygen语法记录了一个结构。//!ThisstructcontainssomeinfotypedefstructmyInfo{intvariable1;//!当我生成html/chm输出时,变量描述包含一个“我正在使用当前的doxygen1.8.11并且我已经设置了MULTILINE_CPP_IS_BRIEF=NO。根据doxygenhomepage(请参阅“在成员之后放置文档”)这应该有效,还是我遗漏了什么? 最佳答案 试试这个://!Thisstructcontainssomeinfotypedefstructmy
我正在使用doxygen来记录我的代码。我发现我可以轻松找到所有类,因为有一个名为“类”的选项卡。但是我无法将所有免费功能一起列出。我必须转到"file"选项卡才能找到它们。我可以将所有免费功能放在doxygen文档中吗? 最佳答案 有一种方法可以对页面中的项目进行分组,该方法涉及您编写一些评论。目前还没有可用的自动方法将自由函数组合在一起。仍然使用分组选项,您可以将所有需要的项目放入文档中的给定页面。有关此内容的更多信息以及Doxygen页面上的一些示例:Doxygen/manual/grouping
有没有人试过在LazyC++源文件中嵌入Doxygen注释?任何问题?生成头文件/源文件后,Doxygen注释去哪里了? 最佳答案 我继续下载LazyC++进行试用,它似乎不能很好地与Doxygen配合使用。我的Doxygen注释根本没有出现在生成的头文件/源文件中。然后我尝试让Doxygen解析我的lzz文件,它有一个特殊的#hdr预处理器命令。Doxygen只是忽略了那个特殊的预处理器命令,生成的文档看起来很好。所以故事的寓意是简单地让Doxygen解析*.lzz文件而不是生成的*.h/*.cpp文件。:-)
我正在使用doxygen(xubuntu12.04机器上的版本1.8.0)记录遗留的c++/fortran混合代码。除了使用STLstd::vector类时,我的dot_graphs、调用图和调用图都正常工作。我有一些类foo需要包含另一个类bar的vector。classfoo{//Whati'dliketodo(1)std::vectord_bars//Whatworks(2)bar*d_bars};classbar{SOME_FUNCTION();}bar类包含各种函数,例如“SOME_FUNCTION()”。当foo类中的函数调用SOME_FUNCTION:d_bars[i].
我正在记录一些带有模板重载的函数,并希望引用特定的重载。但是我不知道如何为\ref命令输入签名才能理解;不幸的是,它需要一个规范版本,我不知道。有没有办法获取doxygen生成的规范签名列表?我的具体情况是这样声明的函数:templateintfunction(Tvalue,Tableconst(&descriptors)[S]);我试过了\reffunction(T,Table(&)[])\reffunction(T,Table(&)[])\reffunction(T,constTable(&)[])\reffunction(T,constTable(&)[])\reffunctio
是否可以教Doxygen识别类型为std::shared_ptr的成员?作为聚合?我认为它适用于普通指针,尽管我添加了BUILTIN_STL_SUPPORT=YES.问题还扩展到std::unique_ptr这应该是一个组合,我认为std::map,std::vectoretc可以记录为具有多重性1...N的组合,尽管我很确定我不希望在所有情况下都这样。如果Doxygen做不到这一点,我会对C++的替代文档系统感兴趣。 最佳答案 从版本1.8.14开始,Doxygen不添加std::shared_ptr当BUILTIN_STL_SU