Using \includedoc with markdown

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

Using \includedoc with markdown

Anas Nashif
Hi,
Is it possible to include markdown files and have them included for example to expand on the @details of a function?

For example

/**
 * @brief This is an example
 * @details
 * @includedoc docs/example.md
 * ..
 */

The contents of example.md would be parsed and included as formatted text.

Or is there some other way to do this?

Thanks,
Anas


------------------------------------------------------------------------------

_______________________________________________
Doxygen-users mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
Reply | Threaded
Open this post in threaded view
|

Re: Using \includedoc with markdown

albert
Anas,

Did you try with a small test run? What was the result?

Albert

On Fri, Sep 23, 2016 at 1:22 PM, Anas Nashif <[hidden email]> wrote:
Hi,
Is it possible to include markdown files and have them included for example to expand on the @details of a function?

For example

/**
 * @brief This is an example
 * @details
 * @includedoc docs/example.md
 * ..
 */

The contents of example.md would be parsed and included as formatted text.

Or is there some other way to do this?

Thanks,
Anas


------------------------------------------------------------------------------

_______________________________________________
Doxygen-users mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-users



------------------------------------------------------------------------------

_______________________________________________
Doxygen-users mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
Reply | Threaded
Open this post in threaded view
|

Re: Using \includedoc with markdown

Anas Nashif
Hi,
Yes, I tried, the contents of the markdown file are being included as (without line breaks), so there is no transformation.

Anas

On Fri, Sep 23, 2016 at 8:32 AM, Albert <[hidden email]> wrote:
Anas,

Did you try with a small test run? What was the result?

Albert

On Fri, Sep 23, 2016 at 1:22 PM, Anas Nashif <[hidden email]> wrote:
Hi,
Is it possible to include markdown files and have them included for example to expand on the @details of a function?

For example

/**
 * @brief This is an example
 * @details
 * @includedoc docs/example.md
 * ..
 */

The contents of example.md would be parsed and included as formatted text.

Or is there some other way to do this?

Thanks,
Anas


------------------------------------------------------------------------------

_______________________________________________
Doxygen-users mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-users




------------------------------------------------------------------------------

_______________________________________________
Doxygen-users mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
Reply | Threaded
Open this post in threaded view
|

Re: Using \includedoc with markdown

albert
Anas,

Please create a small test case and attach it to this  thread, so we can see what can bee done.

Albert

On Fri, Sep 23, 2016 at 3:10 PM, Anas Nashif <[hidden email]> wrote:
Hi,
Yes, I tried, the contents of the markdown file are being included as (without line breaks), so there is no transformation.

Anas

On Fri, Sep 23, 2016 at 8:32 AM, Albert <[hidden email]> wrote:
Anas,

Did you try with a small test run? What was the result?

Albert

On Fri, Sep 23, 2016 at 1:22 PM, Anas Nashif <[hidden email]> wrote:
Hi,
Is it possible to include markdown files and have them included for example to expand on the @details of a function?

For example

/**
 * @brief This is an example
 * @details
 * @includedoc docs/example.md
 * ..
 */

The contents of example.md would be parsed and included as formatted text.

Or is there some other way to do this?

Thanks,
Anas


------------------------------------------------------------------------------

_______________________________________________
Doxygen-users mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-users





------------------------------------------------------------------------------

_______________________________________________
Doxygen-users mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/doxygen-users