Doxygen: how to reference java generic interface in documentation

1
votes

I have some Java interface with doxygen documentation

public interface Service< T , U > {
    ...
}

Doxygen is creating docu for class Service< T, U >. When I'm trying to reference this docu page from some other page with @ref tag @ref Service< T , U>, warning is generated:

warning: unable to resolve reference to 'Service' for \ref command

It looks like @ref is not friendly with "<" in the name.

Does anyone know some workaround to reference class with "<" sing in the name?

1
javadoxygen
Did you try @ref Service? - Lake
Yes, sure. Result is the same - warning. And it is clear why - docu is created for Service<T,U>, so I should reference to it somehow... - Dmitry Latnikov

1 Answers

0
votes

I tried to reproduce your problem with the following example:

/** A service */
public interface Service< T , U > {
}


/** @mainpage
 *  See @ref Service<T,U> "the service interface" for details.
 */

but it worked fine (as I would expect).