Question

我目前正在使用Doxygen记录一些高级模拟工具。我希望能够在HTML文档中引用方程式。

说明问题。执行以下

doxygen -g Doxyfile
sed -i 's/^EXTRA_PACKAGES.*/EXTRA_PACKAGES = amsmath amsfonts/g' Doxyfile
sed -i 's/^LATEX_BATCHMODE.*/LATEX_BATCHMODE = YES/g' Doxyfile

您现在拥有Doxyfile，可用于包含公式的项目。

在同一目录中输入以下内容

sample.h：

/**
 * @file   sample.h
 */

/**
 * @mainpage Some example
 *
 * Some complicated math:
 * \f{equation}{\label{eq:1}
 * p(\vec{r}_{0},t) = \ldots
 * \f}
 */

/** 
 * The function computes the pressure based on \f$\ref{eq:1}\f$
 * 
 * @param rho 
 * @param v 
 * @param r 
 * @param t 
 * 
 * @return 
 */
int CalcPressure(float rho, float v[3], float r[3], float t);

执行以下命令以生成LaTeX文档。

doxygen Doxyfile
cd latex
make

对等式（1.1）的引用放在CalcPressure函数的文档中。

另一方面，HTML文档包含'??'参考公式。是否有可能调整doxygen运行两次以生成公式，这样创建的图像包含引用'（1.1）'而不是'??'。

另一种解决方案也可行。我知道如何使用xr包，http://www.cheshirekow.com/wordpress/?p=335

在另一个LaTeX文档中包含对函数的引用

我可以使用这个程序，如果我可以告诉Doxygen不删除_formulas.aux文件，重命名文件并使用xr包将其作为输入传递，但我不知道如何告诉Doxygen不要删除临时文件。

我希望有一个创建公式引用的解决方案。请帮忙

Answer 1

部分答案。要从html中删除??，请仅在latex中创建链接

/**
 * The function computes the pressure based on @latexonly\ref{eq:1}@endlatexonly
 */

但是这样你就不会在html中得到一个链接。

Answer 2

我自己设法找到了解决方案。

我创建了一个脚本

Linux：latex2

#!/bin/bash

if [ $# -lt 1]; then
    echo $0: usage: latex2 args
    exit 1
fi

latex $*
latex $*

Windows：latex2.bat

@echo off

call latex %*
call latex %*

并更改LATEX_CMD_NAME中的Doxyfile以执行此脚本或实际使用CMake

设置的定义

Doxyfile.in

LATEX_CMD_NAME         = @LATEX_CMD_NAME@

的CMakeLists.txt

if (UNIX OR CYGWIN)
  set( LATEX_CMD_NAME "${PROJECT_SOURCE_DIR}/bin/latex2")
else()
  set( LATEX_CMD_NAME "${PROJECT_SOURCE_DIR}/bin/latex2.bat")
endif()

使用Doxygen参考LaTeX方程式

2 个答案: