How to add a footnote to doxygen?

Question

I would like to insert a footnote with numbering (or another, not finicky) in my conclusion about oxygen. The list of special commands does not include anything that I could identify as including this. I was hoping for something like:

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

which will produce

This is my text. ^one

and then

1: this is my footnote

at the bottom of the page. Is there a way to do this or something functionally equivalent?

Answer 1

You can define your own \ footnote command using the ALIASES option in the doxygen configuration file as follows:

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

This will create a real footnote in LaTeX and ^* output with a tooltip on the HTML output.

Answer 2

Good question! The following is a bit of hacking, but may suit your needs.

Start with the footnote text at the bottom of the page and use \anchor to mark it.

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

You can then reference the footnote using \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.

should produce

Among the odd plants of the upper Amazon basin is a piece of the raffle ( 1 ). Water buffaloes especially love loose roses.

• Wibble is an unusual shade of pink.

Yes, you need to do too much manually, but at least it gives some form of footnote with a hyperlink.

Answer 3

To create footnotes in HTML, I currently use a mixture of ALIASES commands and some custom JS.

The command looks like this:

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

You might want to improve this alias to also cover LaTeX footnotes through \latexonly and \htmlonly .

In header.html for my project, I add the script found here. http://www.planetholt.com/articles/jQuery-Footnotes To initialize the footnotes, I will also add the following code inside the script tag in header.html :

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