doxygen相关内容
上下文-Doxygen工具,使用C代码生成RTF文档。 在模块/组的文档中,即使没有,也会得到标题“详细说明”在某些特定的模块/组中提供了详细说明。 在生成的RTF文档中,这看起来很难看。 我尝试了“ ALWAYS_DETAILED_SEC = NO” ,但是有可能摆脱这种空的“详细描述”部分吗?不管用。我不能执行“ HIDE_UNDOC_MEMBERS = YES” ,因为组/
..
我有一个目录,其中保存了所有源文件和头文件。我想运行Doxygen为这些源代码生成文档。但是,我不想更改此目录中的任何内容(特别是我无法添加将在其中保存Doxygen文档的子目录)。 如何实现我的目标 我认为我需要执行以下操作: -我创建并转到“ documentation”目录。 -在此目录中,执行 doxygen -g 创建一个名为“ Doxyfile”的模板配置文件。 -然
..
Roxygen受到C,C ++程序员使用的Doxygen文档系统的启发。我已经使用过Doxygen,只要您有doxygen注释,我发现记录任何程序真的很容易。它还会为函数和类生成调用图。我以为roxygen会以相同的方式工作,但是当我搜索roxygen帮助时,我只找到记录R包的解决方案。 我已经检查了Hadley Wickham的在线 roxygen2 help ,但这并没有描述有关R脚本文
..
例如,在我的函数中 //以doxygen文档开始代码 / **主要功能。我现在将尝试在此main函数中记录变量* / int main() { int arr []; / ** \简述一个整数数组* / ..... 返回0; } //代码结尾 但是,当我将Doxygen与在配置文件中将“ HIDE_IN_BODY_DOCS”变量设置为“ NO”,则不会
..
我喜欢Doxygen创建C或PHP代码的文档。我有一个即将到来的Python项目,我想我还记得Python没有 / * .. * / 注释,并且也有自己的自我文档工具, 由于我熟悉Doxygen,如何使用它来生成Python文档? 解决方案 这是记录在doxygen网站上,但此处总结如下: 您可以使用doxygen来记录您的Python代码。您可以使用Python文档字符串语法
..
我想用doxygen + pas2dox记录我的来源。当我设置好所有内容后,包括过滤器和提取选项(提取所有内容),doxygen运行良好。但是生成的文档仅包含源文件作为链接,并且未提取任何类型/方法。 筛选出的源看起来不错。 是否提示如何定位错误? 解决方案 我花了很多时间来弄清doxygen的完整配置。 将预处理程序pas2dox用于Delphi。 这是一个显示我的源代码的d
..
在某些doxygen文档中,我想显示 #define 的内容,而不是标签本身。例如,在C文件中,我有 #define REPEAT_N_TIMES 10 现在在我的文档中要显示: 操作是完成10次。 如果我使用 \ref REPEAT_N_TIMES ,它将显示: 操作已执行REPEAT_N_TIMES次
..
我们有以下预处理程序宏。它用于帮助Doxygen文档,因为Doxygen在C ++和某些模板typedef方面存在问题: #如果已定义(DOXYGEN_PROCESSING) #定义DOCUMENTED_TYPEDEF(x,y)类y:公共x {}; #else #定义DOCUMENTED_TYPEDEF(x,y)typedef x y; #endif 当 X 是非
..
我有一个项目,其中有大量的条件定义可简化跨平台开发。但是,我在说服Doxygen提取所有定义时遇到了问题,因为它只会拾取那些仅用于评估的定义。 例如,在以下代码段中,Doxygen将记录 TARGET_X86_64 而不记录 TARGET_ARM64 code>。 #如果已定义(_M_ARM64)||已定义(__arm64__)|| define(__ aarch64__) / **
..
此刻,我正在对doxygen发疯,我希望它在第8层上不会太愚蠢,但我们会看到... 我想提取静态和未记录的内容。这就是为什么 EXTRACT_ALL = YES 的原因。但是EXTRACT_ALL似乎不能满足文档的意图。参见下面的示例。 在EXTRACT_ALL的文档中,输出中仍然有警告。 #如果如果EXTRACT_ALL标记设置为YES,即使没有可用的文档,doxygen也会假
..
您是否可以使用单个注释块来注释doxygen中的多个功能?下面是一个不起作用的简单示例。我可以做些类似的事情来获得自己想要的东西吗? file.cpp #include file.h /// @name FunsGroupedInDoxygen /// @ { / ** * @简短文档2个功能的文档 * @param aParam A参数 * @retval 0
..
在通过 HTML帮助研讨会的 hhc.exe 成功编译.chm文件之后,我面临着一个非常奇怪的失败。 我用 Doxygen 创建了源代码文档。如果在doxygen文件中启用 GENERATE_HTMLHELP ,则会创建 Doxygen : 如果将GENERATE_HTMLHELP标记设置为YES,则doxygen会生成三个另外的 HTML索引文件:index.hhp,index.h
..
我有一个使用Google测试的项目。我在根目录中有以下CMake文件: set(CMAKE_C_COMPILER gcc) cmake_minimum_required(版本3.10.2) FATAL_ERROR) 项目(PROJECT) 设置(CMAKE_INCLUDE_CURRENT_DIR ON) 设置(CMAKE_AUTOMOC ON) 设置(CMAKE_AUTOUIC ON
..
在解决了一些初始问题后,尝试使doxygen起作用时,我在遵循 doxygen安装教程。 到目前为止有效: git克隆https://github.com/doxygen/doxygen.git cd doxygen mkdir版本 cd版本 sudo apt-get install flex (它丢失了,所以我不得不在 cmake 之前安装它) sudo
..
我在Web上找到了一个示例cmake文件,并将其放在我项目的 / doc 子目录中,其中文件 myproject.doxgen 也位于其中,包含Doxygen配置。 我已经测试过运行 doxygen.exe myproject.doxygen 产生有效的输出。我只需要将其构建到CMake流程中即可。因此 /doc/CMakeLists.txt 是: find_package(Doxy
..
Doxygen有点慢-处理我的整个项目大约需要几分钟,因此对于小的增量更改,这比实际构建其余代码的时间更长。有成千上万个没有任何文档的文件,所以我想它正在花费大部分时间来处理它们。有没有办法让它跳过没有任何文档的文件? 让它仅处理更改的文件怎么办? 解决方案 从Doxygen文档中获取: 如何排除所有测试目录 从我的目录树中来? 只需在配置文件中放置一个像 这样的排除
..
我正在使用boost :: python在c ++代码中添加一个python模块.用doxygen记录了c ++项目. 我想为python模块创建一个文档,但是我不知道如何不像这样多余: #include using namespace boost::python; /** @brief Sum two integers * @param a an
..
我知道这里有非常相似的措词问题,但是我在那里找不到我的问题的答案,所以我们开始: 我试图查看我的哪些C ++方法被其他人调用,因此在谷歌搜索后找到了Doxygen. 在他们的页面上,安装过程非常简单: 如果您安装了必要的构建工具(例如g ++,python, cmake,flex,bison),则应执行以下操作以获取初始 存储库的副本: git clone https://gith
..
例如,我在Doxygen上有很多锚点图片. \anchor pic_foo \image html foo.gif "My Caption" \anchor pic_bar \image html bar.gif "My Caption" 每次我使用\ref链接其中之一时,我都必须弥补 一些不错的描述,以便锚的原始名称不会出现在 输出. 是否有可能在doxygen中使用编号的锚点
..
我正在尝试将SVG添加到我的doxygen文档中. 第一次尝试使用\image blabla.svg.这有点奏效...但是,SVG包含另一个png引用,并且未显示“内部" png.在Chrome上可以使用,但即使在Firefox上也无法使用. 继续阅读,我发现我可以在tye标记上使用或.我不确定是否可以使用脱氧剂. 如何在doxygen文档中使用SV
..