Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How do I add a footnote in doxygen?

Tags:

doxygen

I'd like to insert a numbered (or other, I'm not picky) footnote in my doxygen output. The list of special commands doesn't include anything that I could identify as enabling this. I was hoping for something like:

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

which would produce

This is my text.1

and then

1: This is my footnote

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

like image 687
Scott Deerwester Avatar asked Aug 13 '14 15:08

Scott Deerwester


1 Answers

Good question! What follows is a bit of a hack but might serve your needs.

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

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

You can then link to the footnote using a \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

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

  1. Wibble is an unusual shade of pink.

Yes, you are having to do rather too much manually, but at least this gives some form of hyperlinked footnote.

like image 179
Cheeseminer Avatar answered Sep 24 '22 11:09

Cheeseminer