documentation - 如何生成 rdoc 风格的可折叠代码段？

Question

我正在使用 Doxygen 为 C++ 项目创建内部文档。我让 Doxygen 包含方法等的来源，但这使得页面难以扫描。我希望它表现得像 rdoc 并将源隐藏在默认情况下折叠的块中。

我以为HTML_DYNAMIC_SECTIONS可能会让我这样做，但唉，更改日志说该选项仅影响图表和图形。

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

无论如何，聪明的人，我如何强制 Doxygen 生成可折叠的代码部分？

Answer 1

如果包括 [ing] 方法的来源等，[...] 使页面难以扫描，为什么不直接链接到它( SOURCE_BROWSER = YES )而不是包含它( INLINE_SOURCES = YES )？这将使页面更易于扫描和加载更快，并且源仍然可以访问(以多加载一个源页面为代价)。我想取决于您实际需要访问源的频率。

话虽如此，有一种方法可以生成可折叠的代码部分(不过，您必须修改源代码并重新编译 Doxygen):

Doxygen 的 HTML 输出中的可折叠部分 are marked with two nested <div> s像这样:

    <div class="dynheader"><div class="dynsection">
    [collapsible section]
    </div></div>

包含的代码部分标记如下:<div class="fragment"><pre class="fragment">...</pre></div>

因此，要使包含的代码部分可折叠，您必须

修改 the code that generates <div class="fragment"><pre class="fragment">...</pre></div>生成 <div class="dynheader"><div class="dynsection">...</div></div> (并可能调整一些 css)，或

更改 javascript initDynSections() function扫描并折叠可折叠部分以识别 <div class="fragment"><pre class="fragment">作为其中之一。

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

哦，如果你能通过补丁成功的话，那就太好了 submit it给 dimitri，以便他可以将其包含在 future 的版本中。谢谢!