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

LaTeX error documenting class defined in macro (Origin: bugzilla #676294) #4704

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

On 2012-05-18 07:19:14 +0000, Philip Blakely wrote:

In C++, a multi-line macro redefining a class causes a "Runaway argument" problem in a hyperlink in LaTeX.

With the minimal example given at the bottom of this report, the generated LaTeX documentation causes pdflatex to crash with:

Runaway argument?
{}^^M\hyperlink {classA}{ A}();(\backslash )^^M }; (\backslash \ETC
.
! File ended while scanning use of \hyperlink.

This is due to \hyperlink{classA}{} being in the generated .tex file.

The example originally had A as a templated class, with the macro defining a specialisation, so although the example code isn't valid C++, the additions that would cause it to be valid do not make the Doxygen error go away.

Reducing the first definition of A to a forward declaration causes the error to go away, as does putting the macro all onto one line, or removing the constructor.

This did not result in an error in release version 1.8.0, but does in the latest SVN version: 1.8.0-20120429 (rev. 813).

Doxyfile:
EXTRACT_ALL = YES

DoxygenTest.C:
class A
{
};

#define M
class A
{
A();
}; \

On 2012-05-18 08:51:31 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next subversion update.

On 2012-05-19 12:26:46 +0000, Dimitri van Heesch wrote:

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

On 2012-05-19 15:41:18 +0000, Philip Blakely wrote:

Confirmed fixed for my code for version 1.8.1.

Many thanks.

@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