doxygen 相关问题

Doxygen是一个多语言文档生成应用程序,适用于C ++,C,Java,Objective-C,Python,IDL,Fortran,VHDL,PHP和C#,支持各种输出格式,包括RTF,HTML,XML和PDF。

Doxygen:警告:\dir 命令匹配多个目录

我想向文件夹添加一些文档,因此在我的一个文件中添加 /** * \dir 源 * \details 添加详细信息... */ 我还有一个名为 testsources 的文件夹,Doxygen 似乎是 ge...

回答 1 投票 0

Doxygen 报告“潜在的递归类关系”

我有一个C++模板化类base::Foo,并且在另一个文件中有一个类base::bar::Foo:public base::Foo。 Doxygen 似乎不喜欢这个,因为它会抛出错误 我有一个 C++ 模板类 base::Foo<class T>,并且在另一个文件中有一个类 base::bar::Foo : public base::Foo<Baz>。 Doxygen 似乎不喜欢这个,因为它会抛出错误 <unknown>:1: Detected potential recursive class relation between class snLib::mocTwod::DsaCell and base class DsaCell< snLib::mocTwod::ProblemTraits, detLib::cellDiffusionTwod::ProblemTraits >! 有没有办法防止这种情况发生? Doxygen 的文档没有讨论此错误或任何有关“潜在递归类关系”的内容。 “基础”类: /*! \file snlib/DsaCell.hpp */ #ifndef snlib_DsaCell_hpp #define snlib_DsaCell_hpp #include "Dsa.hpp" namespace snLib { /*! * \brief Implementation of naive cell-centered DSA */ template <class HoTraits_T, class LoTraits_T> class DsaCell : public snLib::Dsa< HoTraits_T, LoTraits_T > { [snip] }; } #endif 导致问题的其后代之一: /*! \file snlib/twod/moc/DsaCell.hpp */ #ifndef snlib_twod_moc_DsaCell_hpp #define snlib_twod_moc_DsaCell_hpp #include "snlib/DsaCell.hpp" #include "ProblemTraits.hpp" #include "detlib/twod/celldiffusion/ProblemTraits.hpp" namespace snLib { namespace mocTwod { /*! * \brief Inconsistent DSA for MOC */ class DsaCell : public snLib::DsaCell< snLib::mocTwod::ProblemTraits, detLib::cellDiffusionTwod::ProblemTraits > { [snip] }; } } // end namespace snLib::mocTwod #endif 我的Doxygen配置文件设置了很多选项,包括路径配置:STRIP_FROM_PATH(设置为根目录)、STRIP_FROM_INC_PATH(同上)、INCLUDE_PATH(同上)。 编辑:看起来错误实际上是在另一个 Doxyfile 中引发的,该 Doxyfile 使用由名称冲突的文件生成的 XML 标记,因此问题与此相关。不管怎样,我只是将基类重命名为其他东西,一切又恢复正常了。 Doxygen 有一个函数可以检查类 A 和 B 是否有继承关系 (直接或间接),这是递归的。该函数检查递归的限制深度为 256。 可能 doxygen 与你的代码混淆了(因为名称重合),并认为 A 类依赖于 B,而 B 又依赖于 A。 这可能是 Doxygen 错误,但最好的方法是重命名该类。 此警告似乎已在 doxygen 1.10.0 中修复。我的项目一直有这个烦人的警告,直到今天我们从 1.9.7 升级。

回答 2 投票 0

如何让 Doxygen 生成自定义 URL?

我目前将此作为我的网址: html/d9/d61/md_ebu_hicad__e_bu__hi_c_a_d__configurator_tool__documentation_pages_2.html 我想要这个: html/第2页 Doxygen Awesome 就是这样的一个例子

回答 1 投票 0

Doxygen |如何为我的页面生成静态 URL?

我目前将此作为我的网址:html/d9/d61/md_ebu_hicad__e_bu__hi_c_a_d__configurator_tool__documentation_pages_2.html 我想要这个:html/page2 Doxygen Awesome 就是这样的一个例子

回答 1 投票 0

如何从c++项目生成markdown文档?

我正在尝试为复杂的 C++ 项目创建文档。 为此,我开始使用 Doxygen,它适合我的使用,因为我只需将项目的标题注释为 g...

回答 2 投票 0

Sphinx 是否已经适合 C++ 文档? [已关闭]

我想尝试使用 C++ 的新项目的文档生成器。我认为我的选择是 Doxygen 或 Sphinx。由于我有一个 Python 项目,我想使用 Sphinx,所以我想知道...

回答 2 投票 0

CMake:如何对具有多个目标的项目使用 doxygen_add_docs() 并在构建期间生成

我有一个具有以下结构的项目: 我的项目/ ├─ 建造/ ├─ cmake/ │ └─ DoxygenFun.cmake ├─ 文档/ ├─ src/ │ ├─ CMakeLists.txt │ ├─ 超级库/ │ │ ├─ CMakeLists.txt │ │ ├─ lib1/ │ ...

回答 1 投票 0

Doxygen 没有为源文件生成文档

第一次在这里使用 Doxygen。使用 Doxygen 向导,我很确定我正确设置了所有目录和所有内容,但由于某种原因,输出的文档只有他...

回答 3 投票 0

Doxygen 无法在文档中包含 .aidl 接口和枚举

我有一些带有接口和枚举的 .aidl 文件,想要将它们添加到 API 文档中。 我添加了 INPUT 的路径,并使用 .aidl 和 .java 指向 FILE_PATTERNS,并使用 aidl=java 指向 EXTENSION_MAPPING。 然后,我

回答 1 投票 0

Doxygen 团体协作图中不带箭头的紫色虚线的含义?

在 Doxygen 中创建指定 Doxygen 组之间连接的协作图时,不带箭头的紫色虚线的含义是什么?

回答 1 投票 0

在 Doxygen 中自定义树视图

我是第一次尝试使用 Doxygen,到目前为止我对大多数事情都很满意。您可以说我正在创建的手册由两部分组成:一部分是使用包含

回答 2 投票 0

Doxygen 未生成文件描述

我正在使用 Doxygen 编写一个项目的文档,除了文件的描述之外,一切或多或少都按预期工作。在文件的开头我有: /** @文件$r...

回答 1 投票 0

如何从 Doxygen 获取单个 PDF 文档?

当我生成 PDF 格式的 Doxygen 文档时,我会得到大量不同的文件,每个文件中都有一个图表。 是否可以获得一个 PDF 文档,以一本书的形式组织,大致如

回答 7 投票 0

如何启用find_package(Doxygen)搜索特定文件夹以找到doxygen.exe?

我想使用 doxygen 记录我的 C++ 源代码。 我通过在本地 PC 中安装 doxygen 成功,当 CMakelists.txt 尝试 find_package(Doxygen) 时,它成功了,并且

回答 1 投票 0

如何从 DOxygen 继承图中排除类?

我的项目中有一个模板化的 C++ 类,它仅用于调试目的——在正常构建中,它会编译为空/无操作类。这个类被许多人私人继承......

回答 1 投票 0

Doxgen 使用过时版本的 bison OSX Big Sir

我正在尝试使用 Doxygen 为我的代码创建文档。按照 Doxygen 文档,当我运行 cmake -G "Unix Makefiles" .. 编译器告诉我 CMakeList 中的 CMake 错误...

回答 4 投票 0

Doxygen 注释 - 在标头或实现中?

我想用 Doxygen 记录一个 Objective C 项目。目的是为开发人员记录。整个项目是开源的,任何人都可以查看。 我创建了一个 Doxyfile,然后

回答 1 投票 0

CMake 构建目录遇到问题

我有一个非常简单的CMakeLists.txt 文件: cmake_minimum_required(版本3.15) 项目(测试_文档) 查找包(Doxygen) 如果(Doxygen_FOUND) 查找文件(DOXYGEN_PLANTUML_JAR_PATH

回答 1 投票 0

更改 Doxygen 主题?

我真的不认为用于记录 C 代码的 Doxygen HTML 主题适合记录函数和过程(尽管如果使用 C++,它对于记录 OOP 来说非常棒)。所以我要问的是...

回答 2 投票 0

Sphinx +breathe HTML 输出与 doxygen HTML 输出不同

我需要你的帮助。 我使用 Sphinx 创建了一个文档。 在本文档中,我需要添加另一个有关 C API 的文档。该 API 有现成的 doxygen 文档...

回答 1 投票 0

© www.soinside.com 2019 - 2024. All rights reserved.