After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 702189 - Markdown and @image
Markdown and @image
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
unspecified
Other Windows
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2013-06-13 15:16 UTC by Kyle
Modified: 2013-08-23 15:04 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Kyle 2013-06-13 15:16:36 UTC
The markdown processor and @image tag seem to be interacting in a strange way which triggers unintended code sections.  In the below example (from doxygen-users "C# comments and blank lines"):

        /// <summary>
        ///             Brief text.
        /// </summary>
        /// <remarks>
        ///             Text.
        ///             @image html picture.png
        ///
        ///             More text.
        /// </remarks>
        class Test {
        }

The section "More text" is taken to be a code block, even though it is not indented from previous comments >3 spaces.  One workaround noted was to replace the blank line with a manual <br>, at which point doxygen would no longer trigger the code block as the line is not preceded by a blank line.

Another example (from doxygen-users "Markdown: images and paragraph indentations") is shown below:

      /**
      \page newpage Some Test Page
       text

        text

         text

          Start talking about the image

          \image latex someimage.png "An image"

          And continue talking about that subject
      */

In this case, the "And continue talking" is interpreted as a code section, again even though it is not indented >3 spaces from the previous comment line.

I'm suspicious that the @image tag is reverting the parser's internal knowledge of indentation levels--such as causing doxygen to think that that line is not indented.  Then when it comes across the "And continue talking" line, it finds it indented >3 spaces from the previous line and treats it as a code section.

The preferred behavior from my perspective would be to not trigger the code sections in these cases.
Comment 1 Dimitri van Heesch 2013-06-15 12:22:59 UTC
Confirmed. Should be fixed in the next GIT update.
Comment 2 Dimitri van Heesch 2013-08-23 15:04:15 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.5. 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.