【问题标题】:How to compact/strip multiple blank lines in source-code-preview如何在源代码预览中压缩/去除多个空行
【发布时间】:2012-04-25 15:32:23
【问题描述】:

我的 doxygen 文档显示了每个类成员函数的源代码。 我的源代码有时会在函数之间包含多个空行。

如何让 doxygen compactstrip 这些多个空行? (而不是在预览中显示它们)

回答(从下方)

下面的答案为我指明了正确的方向:INPUT_FILTER (doxygen documentation)

INPUT_FILTER 标记可用于指定 doxygen 应调用的程序来过滤每个输入文件。 Doxygen 将通过执行(通过 popen())命令来调用过滤程序:

<filter> <input-file>

其中是 INPUT_FILTER 标记的值,并且是输入文件的名称。然后 Doxygen 将使用过滤器程序写入标准输出的输出。

我很快写了一个 python 脚本(我在 Win7 上)来做'压缩':

import re
import sys

if len(sys.argv) != 2:
  exit()

with open(sys.argv[1]) as f:
  original = f.read()
  compact = re.sub('\n\n\n+', '\n\n', original)
  print(compact)

然后我将它添加到过滤器中:

INPUT_FILTER = "python ../DoxyCompact.py"

这也为在 doxygen 读取之前修改源代码提供了很多可能性!

【问题讨论】:

  • 您是否有不想使用Sphinx的具体原因?
  • 我使用的是 Win7 64 位机器,我真的努力设置它。最后我用了 doxygen,效果很好……

标签: python doxygen


【解决方案1】:

我能想到的唯一方法是在 doxygen 使用文档中的源代码之前定义一些预处理器来去除多个空行。要定义对源文件执行的操作(或过滤器),请使用 INPUT_FILTER 配置文件选项。

警告:以下内容未经测试。

How can I replace multiple empty lines with a single empty line in bash?这个问题看来可以用

sed /^$/d

去除多个空行,所以在你的配置文件中,设置

INPUT_FILTER = sed /^$/d

【讨论】:

  • 我在问题中添加了您的答案并对其进行了扩展。
猜你喜欢
  • 2015-07-10
  • 2014-11-21
  • 1970-01-01
  • 2015-12-12
  • 1970-01-01
  • 2016-05-19
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多