Doxygen won't index my C++ source - why not?

Question

I have some C++ source code with templates maybe like this - doxygen runs without errors but none of the documentation is added to the output, what is going on?

///
/// A class
///
class A
{
  ///
  /// A typedef
  ///
  typedef B<C<D>> SomeTypedefOfTemplates;
};

Dimitri van Heesch · Accepted Answer · 2009-08-27 20:24:12Z

6

Note that doxygen now supports closing a template with the right shift operator (since version 1.6.0).

Also see http://bugzilla.gnome.org/show_bug.cgi?id=560512 for a discussion on the problem and the solution implemented.

answered Aug 27, 2009 at 20:24

Dimitri van Heesch

3313 silver badges2 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

1800 INFORMATION · Accepted Answer · 2008-10-16 19:57:21Z

4

Yeah, so what is going on is the template instantiation is bogus. The ">>" like that is ambiguous and is meant to be a compile time error. You couldn't see it because maybe your compiler (VC++) let it slip by but I guess doxygen was stricter on that. Add a space like shown.

///
/// A class
///
class A
{
  ///
  /// A typedef
  ///
  typedef B<C<D> > SomeTypedefOfTemplates;
};

answered Oct 16, 2008 at 19:57

1800 INFORMATION

137k30 gold badges164 silver badges242 bronze badges

2 Comments

Adam Rosenfield Over a year ago

Yep, the >> gets interpreted as a right-shift operator. C++0x will change this behavior, though. See en.wikipedia.org/wiki/C%2B%2B0x#Angle_bracket

mdec Over a year ago

Did you just ask your own question and answer it for the sake of it?

Collectives™ on Stack Overflow

Doxygen won't index my C++ source - why not?

2 Answers 2

Comments

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related