我正在使用 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(使用前将#替换为@)