【问题标题】:Lightweight doxygen html output轻量级 doxygen html 输出
【发布时间】:2014-04-12 08:32:51
【问题描述】:

doxygen 是否有一个更轻量级的 HTML 后端,它不会用大量的 div 和表格填充页面?查看 css 文件时,输出看起来相当臃肿。可以编写另一个后端。我问是否已经存在一个。

我需要这个的原因

  1. 它可以更轻松地将 dox 与网站的其余部分集成。

  2. 我使用 hyphenate.js 使我的“相关页面”看起来不错。但是该脚本需要知道它应该使用哪些标签。使用较少的膨胀标记会更容易。

  3. Doxygen 缺乏关于输出标记如何使用 Firefox Web Developer 工具进行逆向工程以修改 1k 行 CSS 文件的完整文档。更少的臃肿标记减少了对文档的需求,并且让 Dimitri 更容易维护文档。

  4. 更少的膨胀标记使页面更便携。

【问题讨论】:

  • 为什么您想要更轻量级的 HTML 输出?我也经常想要一个更简单的形式,但我对代码风格的审美选择很少有任何真正的商业理由:) 我认为您的目标是为您的代码创建用户文档。说真的,了解您为什么认为 HTML 膨胀会阻止这种情况会很有用。
  • 您所说的“臃肿”也使输出更加可定制。我很高兴它在那里,它为我节省了很多工作。我所要做的就是修改一些 CSS 样式,而不是重写整个生成的输出。
  • @CodyGray 我现在要做的就是通读 1k 行来找到我想要修改的规则 :-(。最美妙的是一个完全可定制的标签映射,我在其中可以告诉 doxygen 将元素 X 包裹在标签 Y 中。
  • 我使用 Chrome 的检查器。 Firefox 和 IE 具有相似的功能。我忘记了没有它们我是如何进行网页设计的。不过同意标签图!

标签: doxygen


【解决方案1】:

使用 doxygen,您可以将数据导出为 html 格式、tex 格式、XML(以后可以根据需要进行解析)、RTF、Man pages 或 Docbook。

html 输出支持带有 HTML_STYLESHEET 属性的自定义页眉、页脚和样式表 (CSS),这可能是您想要的。您可以重写这些并根据需要调整输出。

如果没有让您满意,那么您可能会开始考虑使用自己的脚本语言手动解析上述输出之一并自己生成所需的格式(如果适合您)或直接通过 doxygen 源控制输出生成(https://github.com/doxygen/)

来源:http://www.doxygen.nl/manual/output.html

【讨论】:

  • 问题是关于第三方插件的存在。但你的回答表明答案是否定的。我必须使用接口 CodeOutputInterface 自己实现后端。
  • 根据我的经验,没有后端可以完成您需要的工作,因为 doxygen 允许在输出格式方面具有一定程度的灵活性。编辑:添加了后备解决方案:自己编辑源代码。
  • 我说的是正文标记。因为接口有大量的入口点需要实现,所以我问有没有人做过。
【解决方案2】:

你需要做什么取决于你最终想要什么。

有“输入过滤器”,例如:ftp://ftp.rsa.com/pub/dsg/public/doxygen/doxyfilt.pl 和“输出过滤器”,例如:http://www.bigsister.ch/doxygenfilter/doxygenfilter.html。编写自定义过滤器应该完全符合您的要求。使用现有代码并克服它的限制会更快,并且可以为编写自己的程序提供一些想法(如果您愿意的话)。

您可以使用您反对的输出尝试此网站http://www.dirtymarkup.com/,并查看它建议的工具之一是否会根据您的喜好“清理”代码,而不会删除太多功能(即:点击的能力在链接和展开/收缩部分)。

如果您真的想要它“原始”,请尝试 HTML2Text https://pypi.python.org/pypi/html2text,然后您可以使用 Text2HTML http://txt2html.sourceforge.net/ 将其“争取回来”。这将剥离它,但给你一些最小的 HTML 功能(保留链接)。

有许多“HTML 文本”转换器,在许多语言中,使用搜索引擎来查找您自己的源;最适合您的。

这是来自知名网站的工具列表:http://www.w3.org/Tools/html2things.html

以下是将语言转换为 HTML 的替代列表:http://www.w3.org/Tools/Prog_lang_filters.html。更多信息在这里:http://www.w3.org/Tools/Filters.html

【讨论】:

    猜你喜欢
    • 2011-05-28
    • 1970-01-01
    • 2011-02-06
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2018-10-27
    • 1970-01-01
    相关资源
    最近更新 更多