如何生成 rdoc 风格的可折叠代码段?

2024-01-02

我正在使用 Doxygen 为 C++ 项目创建内部文档。我让 Doxygen 包含方法的源代码等,但这使得页面难以扫描。我希望它的行为像 rdoc 一样,并将源代码隐藏在默认折叠的块中。

我以为HTML_DYNAMIC_SECTIONS可能会让我这样做,但是遗憾的是,更改日志说该选项仅影响图表。

也许我可以通过编辑来做到这一点LAYOUT_FILE?

不管怎样,聪明的人,我怎样才能强制 Doxygen 生成可折叠的代码部分?


if 包括]方法的来源等,[...]使页面难以扫描,你为什么不直接link to it (SOURCE_BROWSER = YES http://www.doxygen.nl/manual/config.html#cfg_source_browser) 代替包括 it (INLINE_SOURCES = YES http://www.doxygen.nl/manual/config.html#cfg_inline_sources)?这将使页面更容易扫描并更快地加载,并且源代码仍然可以访问(以多加载一个源页面为代价)。我猜取决于您实际需要访问源代码的频率。

话虽这么说,有is一种生成可折叠代码段的方法(不过,您必须修改源代码并重新编译 Doxygen):

  • Doxygen 的 HTML 输出中的可折叠部分像这样:
    <div class="dynheader"><div class="dynsection">
    [collapsible section]
    </div></div>
  • 包含的代码部分标记如下:<div class="fragment"><pre class="fragment">...</pre></div>
  • 因此,要使包含的代码部分可折叠,您必须

    • modify the <div class="fragment"><pre class="fragment">...</pre></div>生成<div class="dynheader"><div class="dynsection">...</div></div>(并且可能调整一些CSS),或者
    • 改变扫描并折叠可折叠部分以识别<div class="fragment"><pre class="fragment">作为其中之一。

实施(或去SOURCE_BROWSER路线:))留给读者作为练习。祝你好运!

哦,如果你能通过补丁获得成功,那就太好了提交 http://www.doxygen.nl/manual/trouble.html#bug_reports给迪米特里,以便他可以将其包含在未来的版本中。谢谢!

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

如何生成 rdoc 风格的可折叠代码段? 的相关文章

  • Python 文档字符串中的字符串操作

    我一直在尝试做以下事情 def history dependent simulate self node iterations 1 args kwargs For history dependent simulations only sel
  • doxygen 不显示静态函数和公共函数之间的依赖关系

    你好 我正在尝试使用 doxygen 记录我的 C 代码 问题是静态函数和公共 私有函数之间的依赖关系没有显示出来 其中 公共 私人之间的那些正在正确显示 有人可以在这件事上帮助我吗 将配置和一些示例代码粘贴到此处 Project rela
  • 如何在 YARD 中记录具有可变数量参数的函数?

    我有一个接受可变数量参数的函数 如下所示 def myfun args end 所有参数都具有相同类型 Symbol 所以现在我记录该函数 就像只有一个参数一样 说它可以接受多个参数 例如 this function doesn t do
  • Doxygen 将全局变量声明视为 C++ 中的函数

    当我运行 Doxygen 1 8 15 时 我在日志文件中收到警告 指出并未记录函数的所有参数 warning parameters of member gSwInstallIoMgr are not all documented warn
  • 有什么方法可以检查 Python 文件是否符合 Numpy 文档风格? [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我正在开发一个需要 Numpy 文档的项目 在我的 Java 时代 我记得有 linter 来检查 E
  • 如何在 vim 下突出显示 doxygen 中的 markdown?

    较新版本的 doxygen 附带了 Markdown 支持 有没有一种简单的方法可以将 Markdown 语法突出显示添加到 vim 中的 doxygen 注释块 顺便说一句 可以将 doxygen 语法添加到c文件通过使用set file
  • Doxygen 注释的“使用命名空间”

    我的库的所有类都是在命名空间内定义的 当我为 Doxygen 创建主页时 我必须在注释中显式使用此命名空间以使 Doxygen 生成链接 我想对整个评论块使用类似 使用命名空间 的内容 一个例子 mainpage My Library Us
  • 禁用所选文件的“文档注释”警告

    Xcode 能够检查文档注释问题 并在出现问题时报告警告 例如 我使用 CocoaPods 将 Facebook SDK 添加到我的项目中 在文件中的某个时刻FBError h有以下代码 typedef NS ENUM NSInteger
  • 有没有办法在 protobuf (proto2) 中创建类型别名?

    是否可以创建 protobuf 标量类型的别名 例如 我想使用Sequence替代string 即使它们是二进制等价的 我的近期目标是使文档 使用 protoc gen doc 生成 更容易理解 理想情况下 这种类型应该用支持类型检查的语言
  • Python 中 doxygen 风格文档字符串的 Vim 语法高亮显示

    我开始与doxygen生成我的 Python 代码的文档 我用doxypy过滤器来预处理 Python 文档字符串 我的目标是在 Python 中对 doxygen 注释进行良好的语法突出显示 当写我的mainpage在专用的 dox 文件
  • 在 doxygen 中使用 SVG

    我正在尝试将 SVG 添加到我的 doxygen 文档中 第一次尝试是使用 image blabla svg 这有点工作 但是 SVG 包含另一个 png 参考 并且 内部 png 未显示 这在 Chrome 上有效 但即使在 Firefo
  • 如何记录 IDE 的魔术(_call 和 _callStatic)方法

    在使用 notepad 和 sublime 编码多年之后 有人建议我尝试一下 PHP IDE 我正在尝试 phpStorm 它看起来不错 代码完成和文档是一个很棒的功能 但在使用魔术方法时对我来说不起作用 有没有办法让 phpStorm 了
  • GitHub 错误 Probot:未找到集成,documentation_url

    我在使用 GitHub 的 Probot 应用程序时遇到身份验证问题 当我使用 npm start 运行应用程序时 我会得到 github Github request GET app installations 404 Not Found
  • 从类详细信息 Visual Studio 导出

    我发现在 Visual Studio 中我们可以通过创建类图 添加类和打开类详细信息轻松地将摘要添加到代码中 现在我想知道是否可以将其导出到 Excel 文件中 检查 MD对此答案的评论https stackoverflow com a 3
  • C#中同步接口和实现注释的方法

    是否有自动方法在接口及其实现之间同步注释 我目前正在记录它们 并且不想手动使它们保持同步 UPDATE 考虑这段代码 interface IFoo
  • doxygen INSTALL 无法将文件“.../doxygen/build/bin/doxygen”复制到“/usr/local/bin/doxygen”

    解决了一些之后最初的问题 https stackoverflow com q 50986047 4120196在尝试让 doxygen 工作时 我在遵循以下步骤时偶然发现了下一个错误doxygen安装教程 http www doxygen
  • 如何在 Javadoc 中创建多级缩进?

    假设 作为记录代码 Javadoc 的一部分 您希望使用深度缩进来指示元素之间的关系 如何创建嵌套列表 some element some other element 还有一些其他元素 ul li Element li ul li Sube
  • 接手一个项目 - 我应该问以前的程序员什么? [关闭]

    Closed 这个问题是基于意见的 help closed questions 目前不接受答案 我正在接管一个商业网站的开发 该网站是由另一位程序员花费两年多的时间开发的 这主要是一项单人工作 维护和扩展网站 我将有 2 3 天的过渡期 届
  • 如何管理具有多个库的 Doxygen 项目?

    我正在开发一个使用多个库的项目 其结构设置如下 src libs libOne libs libTwo 我想生成一个 Doxygen 页面 其中涵盖我的所有代码以及库 这非常简单 只需将 Doxygen 指向根即可 但是 我希望对 doxy
  • JSTL 1.2 标签参考文档的链接 [关闭]

    Closed 此问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 在 JavaEE 6 中 JSTL 版本是 1 2 我正在尝试找到此版本的 taglib 文档的链接 我

随机推荐

  • 如何在react-native中编写风味特定的代码?

    大约一周前 我开始开发一个白标应用程序 其中每个应用程序唯一不同的是一些颜色值 图像源和 API 端点 但应用程序本身执行完全相同的操作 因此 在过去的几天里 我尝试学习如何从同一个项目构建多个应用程序 这里主要关注 Android 在我的
  • 使用 browserify 将 socket.io 依赖项与 --node 标志捆绑在一起时出现“错误:找不到模块”

    我正在尝试使用 browserify 将我的服务器端代码捆绑到单个 JS 文件中 因此我正在跑步 browserify node t coffeeify source server js coffee o deployment server
  • SQL:唯一索引中的类型转换

    CREATE TABLE foo dt AS DATE ts AS TIMESTAMP 创建唯一约束的正确方法是什么 其中日期值ts每发生一次dt 例子 dt ts 2010 01 02 2010 01 02 17 19 08 2010 0
  • Postgres HStore 错误 - 未知操作员

    我的红宝石代码 Portfolio where data gt key gt value key gt CSJ value gt 0 1 生成以下 SQL SELECT portfolios FROM portfolios WHERE da
  • 如何制作 PNG 资源?

    我有一个很大的表格TImage以它为背景 问题是 它作为位图直接存储在 DFM 中 大约占用 3 MB 原始 PNG 文件约为 250K 我想尝试通过将 PNG 嵌入到资源中来减少膨胀 然后让表单在OnCreate 现在我可以做到这一点 因
  • 如何访问电子应用程序内的相机/网络摄像头?

    我有一个网络电子应用程序 我想在其中一个页面中实现相机 问题是 最近出于安全原因 网络摄像头只能通过 https 访问 但如果是在本地提供应用程序的 Electron 应用程序 则方案会有所不同 因此流式传输会失败 所以我的问题是 在电子内
  • 用于将每个 n 个文件从文件夹 1 复制到文件夹 2 的批处理文件?

    我正在尝试将每 30 个文件从一个文件夹复制到另一个文件夹 并自动执行其他文件夹的过程 我已经尝试过此线程中的批处理脚本 Windows批处理文件脚本将每十个文件从一个文件夹复制到另一个文件夹 https stackoverflow com
  • 使用 xcode 8 将字典保存在 swift 3 的 userdefaults 中

    我使用以下代码使用 xcode 8 将对象保存到 UserDefaults 以前称为 NSUserDefaults let defaults UserDefaults standard defaults set someObject for
  • 可以使用条件来确定泛型的类型吗?

    在讨论这个问题之前 我将首先解释我想要做什么以及我是如何陷入困境的 作为我自己的学习练习 我解决了一些已经在 Objective C 中解决的问题 看看如何使用 Swift 以不同的方式解决它们 我遇到的具体情况是一个小片段 它捕获更改之前
  • Mathematica:将参数的默认值设置为非常量?

    我可以将函数参数的默认值设置为某个值吗 那不是恒定的吗 例子 tod Mod AbsoluteTime 86400 f x tod x 在上面 tod 每次评估时都会改变 但 f 却会改变 不是 f 产生 f x 42054 435657
  • React 生产和 Cookie 问题

    我开发了一个 React 应用程序和一个 Express API 本地主机中的一切都工作正常 我将 API 移至 digitalocean Droplet 它只是 IP 地址 而且是 HTTP 当我在开发环境中使用 React 应用程序的
  • 当 url 无效时,webrequest.begingetresponse 花费太多时间

    我正在使用 webrequest 来获取一些图像数据 网址有时可能无效 如果 URL 无效 begingetresponse 所花费的时间等于超时时间 在此期间 控件也会变得无响应 换句话说 异步回调不是异步工作的 这是预期的行为吗 try
  • NLog 未在所有级别上记录日志

    ASPNET Core 2 0 与最新的 Nlog 所有配置文件均正确加载 我的配置文件很简单 我只是希望它记录所有内容
  • 如何修复 Azure CI 上的控制台日志编码问题?

    当我在发布管道的 docker 容器中运行 Cypress 时 我在 Azure CI 上得到了这个信息 我猜这可能是因为 Cypress docker NodeJS 或 CI 本身的某些设置 https i stack imgur com
  • 无法在 App Engine Python 上通过 Cloud SQL 使用 utf8mb4 字符集

    我已经设置了一个 CloudSQL 实例 尝试将其与 AppEngine 上的 Django 应用程序一起使用 我已确认服务器已设置为使用utf8mb4通过 CloudSQL 控制台为我的数据库设置字符集 utf8mb4 utf8mb4 u
  • 具有 Windows 身份验证的 ASP.NET 角色

    来自 ASP 新手的超级简单问题 我正在开发一个内部专用的 ASP NET 网站 该网站全面使用 Windows 集成身份验证 我想将三个角色与该站点关联 用户 经理和管理员 该网站向整个组织开放 因此任何经过身份验证的人都是用户 除非他们
  • 如何在android中读取xmpp消息标签的自定义属性?

    我需要接收的 xml 是
  • 在 Swift 中计算预计到达时间

    我试图快速计算两个位置之间的估计旅行时间 步行 用户进行注释 这是我当前的代码 它不会引发任何导致程序崩溃的错误 而只会返回 请求 ETA 时出错 import UIKit import MapKit class LocationObjec
  • 解析php中的URL

    在 php 中 如果我想解析一个 URL 例如 www site com index php foo bar 我可以使用 POST 变量 我可以找回bar by POST foo 但如果我的网址是这样的怎么办www site com ind
  • 如何生成 rdoc 风格的可折叠代码段?

    我正在使用 Doxygen 为 C 项目创建内部文档 我让 Doxygen 包含方法的源代码等 但这使得页面难以扫描 我希望它的行为像 rdoc 一样 并将源代码隐藏在默认折叠的块中 我以为HTML DYNAMIC SECTIONS可能会让