[Doxygen-users] Workaround for the @example problem
Brought to you by:
dimitri
|
From: Alok N. <tux...@gm...> - 2006-04-12 11:46:48
|
I have used the @example tag to link my examples with the APIs. Doxygen say= s that when I use the @example tag, the name of the file containing the example will be inserted just after the documentation and the name will lin= k to the example file. When I run Doxygen I find that it has created the Examples list and I can open an example file by clicking its name in the Examples list. When I click a function, the backward link from the example to the function works. However, I cannot go from the function to the exampl= e because Doxygen hasn't created the forward link to the example file. To resolve this cross-referencing problem, I open the HTML version of the Example file created by Doxygen and get the anchor for the function that I want to cross-reference. Then I start an @htmlonly and @endhtmlonly block i= n my function documentation block and insert the link to the anchor inside this block. The cross-reference is created and I can link forward. However this is a workaround. Does anybody know of any other solution? Alok |