[Doxygen-develop] References and automatic numbering for figures and tables
Brought to you by:
dimitri
|
From: Gavin R. <ga...@ta...> - 2015-04-27 23:26:38
|
Hello,
I'm using Doxygen to create a reference manual. Input is markdown. Output
is LaTeX and html. Currently using Doxygen 1.8.8.
I'm wondering if there are any plans for Doxygen to support automatic
numbering of figures and tables, with referencing capability from the
markdown text?
For example, behavior similar to the @section command's LaTeX output. But
separate enumeration for figures and another separate enumeration for
tables. And with the enumeration showing up in both LaTeX and html output.
Syntax might be something like this,
At the figure:

or maybe

@figure fig_name "Growth rate vs time"
The first example is preferable for it's simplicity, but maybe it's
difficult to have ![Caption text ] used for multiple purposes...
At the table:
@table tab_name Growth rate data 2009 - 2014
| Year | Growth Rate|
|:------:|-----------------:|
| 2009| 0.3245 |
....whatever....
In the body text:
The growth rate for the last five years is shown in \ref tab_name. As can
be seen in /ref fig_name, the growth rate is logarithmic.
In the generated pdf/html:
The growth rate for the last five years is shown in Table 93: Growth rate
2009 - 2014. As can be seen in Figure 125: Growth rate vs time, the growth
rate is logarithmic.
So "Figure N" and "Table M" are automatically generated and pre-pended to
the caption for each figure/table in the document. And you can link to any
figure or table anyplace in the doc using a /ref tag.
I've noticed some users implement similar functionality with
post-processing scripts or other "add-on" tools, such as doxynum. I could
do likewise, but first, wanted to ask whether or not there are plans to
have such functionality "built-in" to Doxygen - and if so, approximately
when?
Kind regards,
Gavin Radolan
|