doxygen 中的方程答案

【问题标题】：Equations in doxygendoxygen 中的方程
【发布时间】：2015-01-31 03:55:46
【问题描述】：

我在我的 doxygen 中加入了 amsmath，我写道：

\f{equation}{
  x=2 
\f}

但是 doxygen 中的结果是

\begin{equation} x=2 \end{equation}

而不是等式

x=2

有人知道怎么回事吗？

【问题讨论】：

我使用了默认的 doxygen 设置并将公式放在 C 文件中，并且可以正常工作。您使用的是哪个版本的 doxygen？您对公式使用哪种渲染（LaTeX 或 MathJax）。您是否收到任何错误消息。
我正在使用 doxygen 版本 1.8.8 和 LaTeX，我没有收到任何错误...
最好是在此处或作为错误报告或邮件列表中提供一个小的完整示例，以便重现。看到 \begin{equation} x=2 \end{equation} 它看起来有点像你在使用 MathJax 并且没有加载它。

标签： c++ latex doxygen

【解决方案1】：

你做对了，我这样做了，它有效。该页面简要显示\begin{equation} x=2 \end{equation}，然后出现正确的等式。

仔细检查您的配置文件中是否有USE_MATHJAX = YES。默认为NO

请参阅：Doxygen 参考中的USE_MATHJAX。

如果未设置为 YES，则显示方程式的页面可能不包含 mathjax 脚本（我尚未检查）：

<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>

【讨论】：

未来注意事项：cdn.mathjax.org 即将结束生命周期，请查看mathjax.org/cdn-shutting-down 了解迁移提示。
@Michael 如果我错了，请纠正我，但 mathjax 本质上是您的 html 页面中的在线服务。是否可以使用文档而不是 mathjax 使 vanilla Latex 方程工作？
是的，免费在线服务。抱歉，不知道 :(

【解决方案2】：

改为使用

\f$ x=2 \f$

这将输出一个内联数学公式。

参考：Doxygen Including formulas

【讨论】：

那行得通；我实际上是在尝试输入一个更复杂的方程式，并且将其内联似乎有点愚蠢。

【解决方案3】：

我决定在这个问题中添加一些新信息，因为它是 2019 年，并且有一种更简单的方法来启用 MathJax。

使用 Doxygen GUI 前端时，您可以在 HTML 下的“专家”选项卡中启用 MathJax。默认情况下，这将包括 CDN。要指向您自己下载的 MathJax 版本，您可以设置 MATHJAX_RELPATH。

【讨论】：