31得票5回答
在Eclipse中更改Doxygen注释样式

有人知道如何在Eclipse CDT中编辑Doxygen注释使用的样式吗? 换句话说,在函数前输入/**并按下enter,当前会得到类似以下的内容: /** * * @param one * @param two * @return */ Foo(int one, int tw...

26得票2回答
使用Doxygen记录C++中的宏函数

如何使用Doxygen在C++中记录宏函数,并在非恶意代码的文档中引用它?更具体地说,我有一个名为"Message"的普通类在Message.H文件中定义,用户可以从中继承以定义自己的消息。在另一个文件("MessageHelpers.H")中,我有一个类似于下面的疯狂宏://! Users ...

54得票7回答
我能否将GitHub Pages的index.html放在代码库的子文件夹中?

我试图使用GitHub页面来托管Doxygen站点。理想情况下,我希望能够将生成的文件和目录推送到GitHub,而无需进行任何调整。 然而,这意味着我的index.html文件在存储库的子文件夹中,而GitHub Pages没有识别它(当我尝试访问Pages网站时会出现404错误)。有没有办...

11得票3回答
Doxygen无法为源文件生成文档

第一次使用Doxygen。使用Doxygen向导,我相信我正确设置了所有目录和文件,但出现的文档只包含头文件。我的项目是用C语言编写的,就好像它完全忽略了.c源文件,只从目录中获取.h头文件。 我认为这可能只是我没有检查所需选项或勾选了不应该勾选的选项。我的输入FILE_PATTERNS包括...

12得票1回答
Doxygen生成的文档中的相对文件路径

我正在使用适用于Windows的Doxygen 1.7.4。 在生成的文档的文件列表页面中,我希望看到相对路径。 我已经设置了 FULL_PATH_NAMES = YES,以便获得不仅仅是没有路径的文件名,而是更多的信息,但这给出了完整的绝对路径。 我只想要相对于项目目录的路径。我知道,我...

11得票1回答
我能否让Doxygen将@ref解析为C++标准库函数?

有时我想在Doxygen注释中引用标准库的结构。我可以使用HTML <a>元素来完成这个目的,但是这种方法需要输入大量文本。我更希望能够简单地编写代码 {@ref std::string},并让Doxygen知道它需要链接到cppreference.org上的std::string...

22得票1回答
只在特定的文件/模块上运行Doxygen?

最近我开始在一个已经有很多Doxygen注释的项目中编写Doxygen文档。 由于我正在学习,我希望通过不断编辑和生成文档来迭代,但是文档生成速度相当慢-需要3-5分钟,这使得工作变得不可行。 我通过删除源树中大部分文件来让doxy仅找到我正在编辑的文件,但这真的是一个可怕的解决方案,而且...

9得票1回答
Doxygen多行注释在变量后面

我用doxygen语法记录了一个结构。 //! This struct contains some info typedef struct myInfo { int variable1; //!< This is a very long text about my varia...

17得票1回答
Doxygen:分组模块和页面?

我对doxygen中的页面和组有一个问题。我有一个项目,将类等分组使用@defgroup和 @ingroup 命令。到目前为止,这个功能运作良好。 现在我想添加特殊的markdown页面文档到项目中。这些页面应该出现在指定的模块(group)中。我尝试使用@page和@subpage命令创建...

21得票4回答
C++元编程doxygen文档

我正在为一些大量使用元编程的代码编写文档,例如: template<rysq::type A, rysq::type B, rysq::type C, rysq::type D, class Transform> struct Kernel<meta::braket<...