Blog on Charlie's Server » Documentation http://blog.charlies-server.com Fri, 09 Sep 2011 05:31:51 +0000 en hourly 1 http://wordpress.org/?v=3.3.1 Quick Tip: Link to Templated Classes in Doxygenhttp://blog.charlies-server.com/2009/08/13/link-to-templated-classes-in-doxygen http://blog.charlies-server.com/2009/08/13/link-to-templated-classes-in-doxygen#comments Thu, 13 Aug 2009 20:37:25 +0000 Hasan http://blog.charlies-server.com/?p=278 In order to link to templated C++ classes within Doxygen-generated documentation, simply refer to the class as though it were not templated at all. Doxygen will kindly pick up on the reference and link appropriately. Though this may seem obvious to some, it’s definitely not to others. Read on for an example including code.

Example

Suppose you have a class defined as follows:

template <class T> class Foo {};

You might use the class as follows:

/** A Foo pointer with @c int as the template parameter. */
Foo<int> *myFoo;

The comment above is correctly interpreted by Doxygen and, if enabled, will automatically link the text Foo to the documentation for the Foo<T> class.

]]> http://blog.charlies-server.com/2009/08/13/link-to-templated-classes-in-doxygen/feed 0