Re: [Doxygen-users] Workaround for the @example problem

[Dimitri v. H. <do...@gm...>]

On 4/12/06, Alok Narula <tux...@gm...> wrote:
>
> I have used the @example tag to link my examples with the APIs. Doxygen
> says that when I use the @example tag, the name of the file containing th=
e
> example will be inserted just after the documentation and the name will l=
ink
> 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 exampl=
e
> to the function works. However, I cannot go from the function to the exam=
ple
> because Doxygen hasn't created the forward link to the example file.
>

That sounds like a bug then. Doxygen should generate a link from the
function to the example in which the function is used (provided doxygen
could properly parse the example that is).


> 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=
 in
> 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 thi=
s
> is a workaround. Does anybody know of any other solution?
>

Please file a bug report for this and then attach an example that shows the
problem, to the bug report.

Regards,
  Dimitri