繁体   English   中英

替代 Doxygen 中的 \f 用于 Latex 公式

[英]Alternative to \f in Doxygen for Latex formulas

在 doxygen 中,如果您希望正确格式化您的公式,您必须执行以下操作:

\f$ x=2 \f$

我有很多带有数学公式的 md 文件。 这些文件是内部 wiki 的一部分,必须遵守该 wiki 的算法规则。 这意味着 latex 格式正常,即 $x=2$。

但是我也想用 doxygen 来补充文档。 但随后生成的数学部分未格式化并显示为普通的 Z25F7E525B5C0641E1EB1FB3BDEBEB15B5Z 代码。

无论如何我可以禁用那个\ f吗?

我能想到的唯一选择是有一个脚本将 md 文件复制到临时目录,将 $ 替换为 \f$ 然后指示 doxygen 使用这些文件。 这是一种可能性,但却是一种丑陋的可能性。 有什么办法可以避免 \f 吗?

您实际上不必复制文件,一种可能性是编写一个过滤器,为您在 doxygen 中执行您的操作(过滤器将读取文件,output 将更改后的 output 读取到标准输出)。

从文档https://www.doxygen.nl/manual/config.html#cfg_filter_patterns ):

FILTER_PATTERNS

FILTER_PATTERNS 标记可用于基于每个文件模式指定过滤器。 Doxygen 会将文件名与每个模式进行比较,并在匹配时应用过滤器。 过滤器是以下形式的列表:pattern=filter(如 *.cpp=my_cpp_filter)。 有关如何使用过滤器的更多信息,请参阅 INPUT_FILTER。 如果 FILTER_PATTERNS 标记为空或没有任何模式与文件名匹配,则应用 INPUT_FILTER。

请注意,对于自定义扩展或不直接支持的扩展,您还需要为扩展设置 EXTENSION_MAPPING ,否则 doxygen 无法正确处理文件。

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM