如何在doxygen中添加脚注？

Question

我想在我的doxygen输出中插入一个编号（或其他，我不挑剔）的脚注。 list of special commands不包含任何我可以识别为启用此功能的内容。我希望有类似的东西：

This is my text.\footnote{This is my footnote}

会产生

  

这是我的文字。 ¹

然后

  

1：这是我的脚注

位于页面底部。有没有办法实现这个或功能相同的东西？

Answer 1

好问题！ 以下是一些黑客攻击，但可能满足您的需求。

从页面底部的脚注文字开始，使用\anchor进行标记。

\anchor wibble 1. Wibble is an unusual shade of pink.

然后，您可以使用\ref

链接到脚注

Amongst the odder plants of the upper Amazon basin is the wibble rose (\ref wibble "1"). Water buffalo are particularly fond of wibble roses.

应该产生

  

在亚马逊河上游盆地的奇观植物中，有一种狡猾的玫瑰   （的 1 ）。水牛特别喜欢嘎嘎叫的玫瑰花。

     

  
1. Wibble是一种不寻常的粉红色。
  

是的，你必须手动做太多，但至少这会给出某种形式的超链接脚注。

Answer 2

要用HTML生成脚注，我目前使用ALIASES命令和一些自定义JS的混合。

命令如下所示：

ALIASES += "myFootnote{1}=<span class=\"footnote\">\1</span>"

您可能希望改进此别名，以便通过\latexonly和\htmlonly覆盖LaTeX中的脚注。

在我的项目的header.html中，我添加了此处找到的脚本。 http://www.planetholt.com/articles/jQuery-Footnotes 要初始化脚注，我还将以下代码添加到脚本标记中header.html：

$(document).ready(function() {
    $("#doc-content").append('<ol id="autoFootnotes0" class="footnotesList"></ol>');
    $("body").footnotes();
});

Answer 3

您可以通过doxygen的配置文件中的ALIASES选项定义自己的\ footnote命令，如下所示：

ALIASES = footnote{1}="\latexonly\footnote\{\1\}\endlatexonly\htmlonly<sup title=\"\1\">*</sup>\endhtmlonly"

这将在LaTeX输出中生成一个真正的脚注，并在HTML输出中生成工具提示 ^* 。