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

Doxygen get's confused by angle brackets (Origin: bugzilla #670289) #4574

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.7.6.1 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2012-02-17 14:59:34 +0000, Martin Sauerhoff wrote:

Created attachment 207856
Files for reproducing the bug

In the example below, doxygen omits the documentation of
all class members of class B. It correctly includes the documentation, if

  1. either a space is inserted between the two right double brackets
    of type definition StrangeType; or
  2. the (single) member of class A is commented out.

Thus, the parser somehow get's confused by multiple angle brackets.
Note that the two consecutive right angle brackets here are allowed
according to C++11. The dependence on the unrelated definition
of class A is strange, anyway.

//! \file myclass.h

#pragma once

// -----------------------------------------------------------------------------
// Class A
//
//! \brief First class.
// -----------------------------------------------------------------------------

class A
{
static const size_t LargeValue = ~static_cast<size_t>(0);
};

// -----------------------------------------------------------------------------
// Class B
//
//! \brief Second class.
// -----------------------------------------------------------------------------

class B
{
public:
//! Template type with double right angle brackets.
typedef TemplateType1<TemplateType2<T, U>> StrangeType;

//! Member that doxygen refuses to document.
B();

//! Member that doxygen refuses to document.
void undocumentedMemberFunctioncompare();
};

On 2012-02-18 13:19:34 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next subversion update.

On 2012-02-25 15:37:20 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.0. 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