New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Linking to template specializations inside a @link structural command fails (Origin: bugzilla #619790) #3785

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component general for ---
Reported in version 1.6.3 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2010-05-27 08:51:11 +0000, Jakob van Bethlehem wrote:

Created attachment 162079
Little code that demonstrates the described bug

The attached sourcefile shows the situation. There is some template, which is by default not implemented. Only some specializations are relevant for the code and should be allowed to be instantiated. In the documentation I try to create a link to either one of this specializations (an int-version here) without having the full name of that specialization appear in the documentation.

When creating a link to that specialization by the automatic linking process, it works. When trying inside a @link - @endlink block it fails.

On 2011-11-01 21:22:16 +0000, Matthew wrote:

It seems doxygen has many issues dealing with template specializations. I have never been able to get links (automatic or otherwise) to work against template specializations.

On 2011-11-01 21:51:03 +0000, Dimitri van Heesch wrote:

Hi Matthew,

Thanks for your feedback, but can you attach examples demonstrating the many issues you found? That would help me in fixing them.

On 2011-11-02 13:01:25 +0000, Matthew wrote:

For me, I have never been able to get template specializations to work in any part of a comment that uses auto-linking or explicit linking, as Jakob did. An example would be if I defined a signal class and a set of specializations such as:

/** @brief The signal class allows many functions to be attached ...
Only a limited number of specializations exist for @p Signature, they are:
@Li @ref signal<void(void)>
@Li @ref signal<void(Arg0&)>
@Li @ref signal<void(Arg0&,Arg1&)>
*/
template
class signal { ... };

template <>
class signal<void(void)> { ... };

template
class signal<void(Arg0&)> { ... };

template <typename Arg0, typename Arg1>
class signal<void(Arg0&,Arg1&)> { ... };

To make a link to any specialization, I have resourced to using the tag like so:
@Li signal<void(void)>
@Li signal<void(Arg0&)>
...

On 2013-01-22 17:32:04 +0000, Matthew Woehlke wrote:

I likewise can't get this to work (at all), using Doxygen 1.8.3:

/// Documentation here. This works.
template struct default_delete { ... }

/// Documentation here. This also works; shows up as a separate class.
template struct default_delete<T[]> { ... }

/// More documentation.
/// A link to default_delete works as expected.
/// It links to the generic variant.
/// A link to default_delete<T[]> does not work as desired.
/// It also links to the generic variant, not the specialization.
void foo();

...I've also tried e.g. escaping the <>'s, using </> instead, using \ref, using \link... nothing I've tried generates a link to the specialization. (I did however check the tag file, and there IS a tag for the specialization. I would guess that the way doxygen parses the text, it stops gathering charaters for the tag when it gets to the '<' (in whatever form), and so always finds the generic variant and not the specialization.)

On 2013-04-01 14:30:58 +0000, Dimitri van Heesch wrote:

Problems should be fixed with David's patch posted here:
http://doxygen.10944.n7.nabble.com/PATCH-Improved-support-for-linking-to-template-specializations-td5806.html

I'll include this patch in the next subversion update.

On 2013-05-19 12:35:54 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.4. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant.

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment