Skip to content
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

"///" not stripped from brief description when MULTILINE_CPP_IS_BRIEF=YES (Origin: bugzilla #625952) #3886

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Copy link
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity normal in component general for ---
Reported in version 1.7.1-SVN on platform Other
Assigned to: Dimitri van Heesch

On 2010-08-03 15:46:37 +0000, John Marshall wrote:

For example:

==== Doxyfile ====
MULTILINE_CPP_IS_BRIEF = YES

==== test.h ====
/** @Class foo test.h /
/// Foo
/// bar
/
* baz */
class foo {
public:
foo() { }
};

The expected brief description of class foo is "Foo bar" but instead it appears as "Foo /// bar".

This was introduced in svn change 730, when src/scanner.l's docBlock variable was changed from QCString to QGString.

The problem appears on line 5194 of src/scanner.l:

[^\n]"\n"[ \t]"//"[/!] { // continuation of multiline C++-style comment
docBlock+=yytext;
docBlock.resize(docBlock.size() - 3);
yyLineNr++;
}

QGString::size() doesn't mean the same thing as QCString::size(). Using "docBlock.length() - 3" instead would work, or maybe changing the meaning of QGString::size() is better.

Also QGString::resize() removes one character too many. Consider for example what qtools/qgstring.cpp's resize()'s "m_data[newlen-1]='\0';" does for docBlock.resize(1).

On 2010-08-14 14:11:55 +0000, Dimitri van Heesch wrote:

Hi John,

Thanks for the analysis. You are correct. docBlock.size() should have been docBlock.length() and QGString::resize() should do m_data[newlen]='\0';

On 2010-08-14 14:12:13 +0000, Dimitri van Heesch wrote:

*** Bug 626799 has been marked as a duplicate of this bug. ***

On 2010-08-22 17:43:19 +0000, Dimitri van Heesch wrote:

*** Bug 624256 has been marked as a duplicate of this bug. ***

On 2010-10-09 08:19:29 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.2. 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
You can’t perform that action at this time.