[prev in list] [next in list] [prev in thread] [next in thread] 

List:       doxygen-users
Subject:    [Doxygen-users] Markdown not working within \includedoc
From:       Greg Ercolano <erco () seriss ! com>
Date:       2018-05-14 17:04:46
Message-ID: 5AF9C1AE.4090105 () seriss ! com
[Download RAW message or body]

    Hi all, another question.

    I have several C++ classes that need a common page or two of documentation
    for each, and am exploring consolidating that content into a single .dox file,
    and using \includedoc to pull it in, e.g.

///
/// Class description goes here.
///
/// \includedoc test.dox
///

    But when I do this, some of the markdown in test.dox is not being handled
    correctly (see screenshots below).

    Here's an /exact/ paste of what I have in test.dox:

_________________________________________________________ snip
This content is in test.dox. Here's some bullet points:

  - One
  - Two

Header Number 1
===============
Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Header Number 2
---------------
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Here's a table:

Color    | Description
-------- | -----------
Red      | Component side
Green    | Solder side

This is the end of test.dox
_________________________________________________________ snip

    If I paste that content directly into a doxygen comment
    (without \includedoc) it looks as I'd expect:
    http://seriss.com/people/erco/tmp/doxygen-includedoc-good.png

    But if I use \includedoc on the same content, it looks like this:
    http://seriss.com/people/erco/tmp/doxygen-includedoc-bad.png

    Note bullets look OK, but headers and table are stretched out
    as if the markdown wasn't supported, as regular text content.

    Can't think what I'm missing here, especially since the bullets
    look OK. Shouldn't the markdown work inside \includedoc?

------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
[prev in list] [next in list] [prev in thread] [next in thread]