草庐IT

doxygen-addtogroup

全部标签

c++ - Doxygen `@code` block 中的链接有时会丢失

我注意到当默认构造函数不带参数时,Doxygen可以链接来自实例的成员函数调用,但当构造函数带参数时无法链接它们。这是为什么?是否有在@code/@endcodeblock中手动添加链接的解决方法?在下面的例子中:t.foo()-foo()已链接u.foo()-foo()未链接./**@filedoxy.cpp*//**structT*/structT{/**foo*/voidfoo(){}};/**structU*/structU{inta;/** 最佳答案 我认为这是Doxygen中已知问题的征兆。来自http://www.do

c++ - 我怎样才能让 Doxygen 知道 CUDA 内核调用?

我正在尝试使用Doxygen记录一个用CUDAC编写的项目。该文档工作正常。然而,调用者图不包括内核调用,如GPU_foo>>().例如,在这个简单的例子中:#include/*!*@briefglobalhellofoo*/__global__voidglobal_hello(void){printf("Hello\n");}/*!*@briefCPUhellofoo*/voidhello(void){printf("Hello\n");}/*!*@briefmain*/intmain(){hello();global_hello>>();return0;}使用相应的Doxyfile

c++ - 使用 Doxygen 绘制控制理论框图

我正在从事自动化领域的C++项目,我想开始记录。我宁愿选择Doxygen。但是,除了记录特定的数据字段和绘制类层次结构UML图之外,我还想用像这样的方框图来记录几种方法的功能:解决方案是什么?我熟悉LaTeX。我读过Doxygen对LaTeX有一些支持,但我不知道这能走多远。是否可以在Doxygen中使用任何LaTeX包?您会推荐哪些特定的软件包,您能否提供一些简单的示例?我也乐于接受与Doxygen不同的建议。 最佳答案 如果只是为了记录控制系统结构、变量等,您可以在其他地方生成图表(例如Dia、XFig或Inkscape,如果您

c++ - Doxygen 如何按路径分隔类?

那么在Doxygen中究竟如何按路径分隔类呢?我尝试过使用组和部分,但出于某种原因,它总是会组合具有相同名称的类。当前文件结构如下:Trunk|+->Client->DemoClass.h|+->Server->DemoClass.h|+->Shared->OtherClass.h问题是我不想要doxygen中包含所有功能的1xDemoClass我想要2个单独的部分/类,如Server/DemoClass、Client/DemoClass。 最佳答案 这是一个已知限制,请参阅http://www.doxygen.org/manual

c++ - 如何在 vim 中默认折叠(折叠)Doxygen 注释?

我们正在考虑将Doxygen文档添加到C++头文件中,但有些人不希望默认情况下看到冗长的Doxygen文档。.vimrc中有没有办法默认折叠(折叠)Doxygen注释?注意:我已经尝试过autocmdFileTypec,cppsetfoldmethod=syntax这将折叠所有匹配的语法,但我一直无法弄清楚如何避免折叠函数、类等。,即仅折叠Doxygen文档格式。如果vim的C-fold插件,另一种看起来可能是不错的解决方案。以下是使其正常工作的详细安装顺序:添加Doxygen语法高亮(a)从http://vim.sourceforge.net/scripts/script.php?s

c++ - Doxygen 文档应该放在 include guards 之前吗?

关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。ImprovethisquestionDoxygen文档应该放在includeguards之前还是之后?在namespace之前或内部?假设header包含单个类(context)的声明,这就是我在此处记录的内容。#ifndefCONTEXT_HPP#defineCONTEXT_HPP#include/***Theapplicationcontextinterface.*/namespacetest{classcontext{

c++ - 在主页中嵌入自述文件(doxygen)

有没有办法将纯文本文件(README.txt)嵌入到doxygen的主页中?(我正在用cmake处理它,所以我可以转储变量,但我认为这种类型的东西会内置)。 最佳答案 当然。在您的mainpage.dox(或您所称的任何名称)中,放置一个指向您的README.txt的链接作为单独的doxygen页面。\mainpageFooBar...\sectionother_docsAdditionalDocumentation`...Keyfeaturesthatdistinguishthecurrentrelease,buildinstru

c++ - 如何使用 doxygen 记录好友注入(inject)功能?

给定如下示例中的一些代码:classMyClass;classInjector{/***@briefMyClassaddition.*/friendMyClassoperator+(MyClassa,MyClassb){...}};classMyClass:privateInjector{};如何让doxygen在MyClass类的文档页面包含operator+()的文档?从功能上讲,它显然属于那里。是否有一些通用方法可以通过ADL提供doxygen文档功能?现实世界中的一个有用示例:我希望doxygen包含boost/operators.hpp中的基类提供的运算符。

c++ - Doxygen 和长类名

我有一个很好的C++项目,其中广泛使用了模板编程,但这真的不是重点。关键是我的一些类名(带有所有模板参数)变得很长。我将Doxygen用于文档。这通常不是问题,但最近我注意到类列表不可读,因为长类名使其太宽而无法显示在屏幕上。有没有办法让Doxygen将类列表中的类名分成更多行?有没有办法在保留通用模板类的同时从类列表中隐藏模板类的特化?有更好的解决方案吗?我设法通过将类隐藏在命名空间中然后立即将此命名空间导入全局命名空间来找到一个愚蠢的解决方法,这样这些类的名称就不会出现在列表中,除非单击或细节水平增加。明显的缺点是这些类(class)现在没有出现在列表中(其中一些相当重要,我希望它

c++ - Doxygen 未记录的字符串值

Doxygen(1.8.10)提示我的字符串的值没有记录。这是一个演示问题的最小示例#includestructMyStruct///这会导致警告/tmp/example.cpp:10:warning:MemberfirstVal(variable)ofclassMyClassisnotdocumented.如果我将结构缩减为单个成员并从初始化程序中删除“secondVal”,则警告消失,但显然这不是解决方案... 最佳答案 只需删除多余的struct。如:#includestructMyStruct///C++不要求您使用stru