typedef in template class with Doxygen (C++)

Question

My question is related to how to comment typedef in template class with Doxygen. I will give an example to illustrate my question:

 namespace fundamental
  {
            


        

Answer 1

There's the See Also (@sa) command, useful for generating cross-references to other entities.

Answer 2

The other answers will work, but if your typedef is so closely tied to the Base class that you want them to appear in the same Doxygen page, you may want to consider defining a new namespace (within Fundamental) that will just include Base and your typedef. Then, doxygen will generate a page for that namespace that will include Base and your typedef.

Defining a file documentation will do the same thing, but this may be a more logical layout for your code.

Answer 3

The typedef is part of a namespace, so you must document the namespace for it to appear, i.e.:

/// documentation for the namespace
namespace fundamental
{
   ...
   typedef Base<float> Coordinate; ///< Point coordinate class
}

Alternatively you could use @relates but it this will put the member under Related Functions of the Base class:

/// @relates Base
/// Point coordinate class
typedef Base<float> Coordinate;

You can change this title to for instance Related Members by creating a layout file using doxygen -l and then editing the two occurrences of the related element in the generated DoxygenLayout.xml as follows:

<related title="Related Members"/>

Answer 4

You could also use the /sa command to manually place a reference in Base's page.

namespace fundamental
{
  /**
  * Basic function
  * /sa Coordinate
  */
  template <typename T>
  class Base
  {
  public:
    T x; ///< x coordinate
    T y; ///< y coordinate
  };
  typedef Base<float> Coordinate; ///< Point coordinate class
}

Answer 5

There is two other solutions to this problem. You can define groups using @defgroup keyword, and group the class and and typedef type into one module. The other solution is using @relates

Answer 6

In the manual I read the following:

Let's repeat that, because it is often overlooked: to document global objects (functions, typedefs, enum, macros, etc), you must document the file in which they are defined. In other words, there must at least be a

/*! \file */ or a /** @file */ line in this file.