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

Markdown and @image (Origin: bugzilla #702189) #5212

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

On 2013-06-13 15:16:36 +0000, Kyle wrote:

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
, 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.

On 2013-06-15 12:22:59 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next GIT update.

On 2013-08-23 15:04:15 +0000, Dimitri van Heesch wrote:

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.

@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.