doxygen相关内容
我们的C ++程序具有内置的脚本接口,并且能够在其中运行脚本。脚本可以访问C ++程序提供的便捷功能。 现在,我们希望Doxygen创建脚本可以访问的功能的文档。这样的函数声明如下: void ScriptEngine :: load_script(const QString& path){ / / ... / *! fn sleep_ms(const unsigned i
..
在我的项目的C ++标头中,我使用了一些静态模板函数助手,这些助手在非静态公共函数中被调用。 在在此文件中,即使使用模板也隐藏了每个静态功能,这是正确的行为,因为静态功能对于外部世界是不可见的。但是,当我对其中之一进行模板专门化时,这种专门化将出现在生成的文档中: //在文档中,确定 template static T my_function(...)
..
我目前在c文件中有几个#define,它们关闭了硬件的某些功能以进行测试。但是,当它们也未定义时,我想用doxygen记录它们。 例如: 此可以正常工作: /// \def SIMULATE_SOME_HW_INTERFACE ///要模拟硬件界面时定义。 #define SIMULATE_SOME_HW_INTERFACE 将#define更改为#u
..
嗨, 我想用doxygen记录我的C#代码。问题是静态功能和公共/专用功能之间的依赖关系未显示。正确地显示了公共/私人之间的位置。有人可以帮我解决这个问题吗? 在此处粘贴配置以及一些示例代码: #------------------------------------------ --------------------------------- #与项目相关的配置选项 #---
..
我有一个带有模板函数的类。该函数是专用/实例化的,因此可以在cpp中定义。 Doxygen给我关于模板实例化的错误。 例如,我的.h: 命名空间LP { 命名空间LF { class FileReader { public: template
..
我希望Doxygen记录以类似C的语言(PARI / GP)编写的代码,但语法略有不同。我相信Doxygen可以证明不存在的实体。当编程语言不受Doxygen支持时,这似乎是最简单的方法。我想要这样的东西: / *! \fn foo(param,{option}) \此处简要说明 \param [in](param)强制参数说明 \param [ in](选项)可选参数描述 *
..
我开始使用 doxygen 来生成我的Python代码的文档。 我使用 doxypy 过滤器预处理Python文档字符串。 我的目标是在Python中对doxygen注释进行语法突出显示。 在专用.dox中编写 mainpage 时文件,我发现doxygen注释可以在 vim 中使用以下命令突出显示: set语法= c.doxygen 我在Python上尝试了相
..
直到今天,我一直在使用doxygen(+ dot)的“古老”版本(1.4.7),它通常绘制垂直方向的图形,例如 ..但有一个更新的版本(通过Ubuntu分发的1.8.6),这些图似乎是水平的,即 水平方向的问题是,许多图形都偏离了右侧窗口,因此您必须进行“ 2D”滚动才能查看数据。 我看过doxygen网页,但是看不到是否有任何选项可以告诉点以垂直方向绘制它们。有人知道是否存在这
..
我刚开始在Objective-C中编程,并发现了一些示例注释,如下所示: / *! @brief我们用来显示从imageBuffer * / 生成的图像的UIImageView @brief 的目的是什么? 解决方案 是。这是doxygen中功能描述的标准格式,使用命令 @brief 进行简要说明。 也许您更熟悉 \brief 表达式,但
..
有没有一种方法可以使Visual Studio自动将doxygen标签放置在C ++源文件中? 例如,我的意思是这段代码: int foo(bool p); 如果我在顶部键入 /// 其中,Visual Studio自动生成以下行: /// /// /// ///
..
我添加了 \dir 注释,以提供目录其他文档。但是我无法使用我知道的任何doxygen链接技术链接到该目录文档。我的问题是:如何正确链接到目录的文档? 下面是我尝试过的内容的摘要。我收到两个警告,但没有生成链接。 doxygen手册的“自动链接”部分讨论了与其他成员的链接,但确实如此更不用说指向目录的链接了。是否支持链接到目录文档?如果是这样,我是在做错什么还是一个错误? (我现在正在使用1
..
我想在doxygen输出中获取枚举成员的真实值。 例如,我有: /// MyEnum typedef枚举My_Enum { MY_ENUM_0,///
..
我在名为macros.h的文件中定义了许多多行宏。在我的doxyfile中,我有 ENABLE_PREPROCESSING =是 MACRO_EXPANSION =是 EXPAND_ONLY_PREDEF =否 PREDEFINED = EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS =否 还存在氧气不会在任何包含macros
..
我有一些带有现有doxygen参数的源代码(STM32外设库),我的Doxygen可以毫无问题地构建。 对于我的项目,我想生成一个文档,其中包含每个文件中的所有功能以及要添加到功能中的特定信息。但是我想保留旧的信息以用于其他的氧气配置。 有可能吗? 我已经添加了 \ifnot“ SECTION_DEFINE” \elsif“
..
我正在处理一个使用多个库的项目,该库的结构如下: / src / libs / libOne / libs / libTwo 我想生成一个Doxygen页面,其中包含我的所有代码以及库。通过将Doxygen指向根,这非常简单。但是,我希望将doxygen输出分组,以便可以清楚地看到每个类/文件属于哪个库。但是,由于这些库不是我写的,所以我不想更改它们以添加\addtogro
..
在我的代码中,一个vtable包含多个函数指针。 Doxygen无法跟随它们。 我想强迫它识别可能的路径,以生成完整的调用图,因为现在这部分丢失。 示例: typedef Bool(* SPECIAL_FUNC) (KEY键); typedef结构{ int a; int b; SPECIAL_FUNC; } OBJ; Bool add(KEY键)
..
我正在使用doxygen记录C ++代码。假设我有两个类:Base类和派生自Base的类。我在Base和Derived中都有一个名为Foo的成员组。能否使doxygen在派生类的文档中显示一个名为Foo的组,而不是像我现在看到的那样有两个名称相同的组? 解决方案 我为此制作了一个Doxygen检出补丁。该修补程序在下面。在生成的文档中,我没有发现任何不良影响。该实现的缺点是它是O(n ^
..
我想将XML文件的内容添加到doxygen生成的文档中。我将XML文件添加到doxygen配置文件的 INPUT 标记中。但是,尽管XML文件在文件列表中列出,但文件的内容未显示。我必须怎么做才能包含内容? 解决方案 Doxygen不支持解析XML的本机支持,因此您不能使用 INPUT ,但是您可以在输出中包含XML文件的内容。 假设您的XML文件被称为 test.xml ,位于目录
..
我寻求构造双氧模块基团内容的最佳方法。例如,我想在不同部分的以下模块组中构造@details文本。特别是每个部分都应该出现在生成的PDF的书签中(作为模块组的子元素): @defgroup lorem @ { @brief Lorem ipsum @details Lorem ipsum dolor坐着,秘密教养专家。 Ut purus elit,前庭 ut
..
在C / C ++中,您可以强制doxygen识别注释适用于一行前面的文本。以下任何一项: int my_variable; / *!
..