doxygen-users

[Doxygen-users] Main page in Markdown

[Alessandro A. <ant...@gm...>]

Hi, everyone.

I am using doxygen 1.8.9.1 under Cygwin in a Windows 7 64 bits and I'm
having
difficulties to generate the main page of a C library in Markdown. The
problematic piece of text follows:

~~~~~~~~~~~~
The following pages have more comments and important notes on this library.

- [Macros](#macrospage)
- [Functions](#functionspage)
- [Formated Strings](#printfformat)
- [Formated Scanning](#scanfformat)
- [Time Formating](#timeformat)

Function Macros        {#macrospage}
------------------------------------

Following standard naming conventions ...
~~~~~~~~~~~~

As you can see I'm just list some items linked with sections in the same
file.
Despite that the link part is processed and rendered Ok (the <li> element
has
an anchor tag <a href="#macrospace">) the section "Function Macros" (and all
others) are not rendered in the final HTML. They are simply gone.

I tried the section creation with the syntax above and also with the sharped
syntax accepted by Mardown, as shown below:

~~~~~~~~~~~~
## Function Macros ##   {#macrospage}
~~~~~~~~~~~~

And I also tried without the ending sharps:

~~~~~~~~~~~~
## Function Macros      {#macrospage}
~~~~~~~~~~~~

None of them rendered the final HTML correctly. Am I doing something wrong?

I also installed the Windows native version of Doxygen (1.8.9.1) and got the
same result.

Anyone has this issue either?

Re: [Doxygen-users] Main page in Markdown

[Albert <alb...@gm...>]

Hi Allessandro,

What is the extension of the file you want to include?
In case .c or .cpp  etc it might miss /** etc. In case of another
extension, maybe EXTENSION_MAPPING to md might help.

Albert

On Sat, Jan 17, 2015 at 2:49 PM, Alessandro Antonello <
ant...@gm...> wrote:

> Hi, everyone.
>
> I am using doxygen 1.8.9.1 under Cygwin in a Windows 7 64 bits and I'm
> having
> difficulties to generate the main page of a C library in Markdown. The
> problematic piece of text follows:
>
> ~~~~~~~~~~~~
> The following pages have more comments and important notes on this library.
>
> - [Macros](#macrospage)
> - [Functions](#functionspage)
> - [Formated Strings](#printfformat)
> - [Formated Scanning](#scanfformat)
> - [Time Formating](#timeformat)
>
> Function Macros        {#macrospage}
> ------------------------------------
>
> Following standard naming conventions ...
> ~~~~~~~~~~~~
>
> As you can see I'm just list some items linked with sections in the same
> file.
> Despite that the link part is processed and rendered Ok (the <li> element
> has
> an anchor tag <a href="#macrospace">) the section "Function Macros" (and
> all
> others) are not rendered in the final HTML. They are simply gone.
>
> I tried the section creation with the syntax above and also with the
> sharped
> syntax accepted by Mardown, as shown below:
>
> ~~~~~~~~~~~~
> ## Function Macros ##   {#macrospage}
> ~~~~~~~~~~~~
>
> And I also tried without the ending sharps:
>
> ~~~~~~~~~~~~
> ## Function Macros      {#macrospage}
> ~~~~~~~~~~~~
>
> None of them rendered the final HTML correctly. Am I doing something wrong?
>
> I also installed the Windows native version of Doxygen (1.8.9.1) and got
> the
> same result.
>
> Anyone has this issue either?
>
>
>
> ------------------------------------------------------------------------------
> New Year. New Location. New Benefits. New Data Center in Ashburn, VA.
> GigeNET is offering a free month of service with a new server in Ashburn.
> Choose from 2 high performing configs, both with 100TB of bandwidth.
> Higher redundancy.Lower latency.Increased capacity.Completely compliant.
> http://p.sf.net/sfu/gigenet
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

Re: [Doxygen-users] Main page in Markdown

[Christoph L. <chr...@li...>]

Am 17.01.2015 um 14:49 schrieb Alessandro Antonello:
> I am using doxygen 1.8.9.1 under Cygwin in a Windows 7 64 bits and I'm 
> having
> difficulties to generate the main page of a C library in Markdown. The
> problematic piece of text follows:
>
> ~~~~~~~~~~~~
> The following pages have more comments and important notes on this 
> library.
>
> - [Macros](#macrospage)
> - [Functions](#functionspage)
> - [Formated Strings](#printfformat)
> - [Formated Scanning](#scanfformat)
> - [Time Formating](#timeformat)
>
> Function Macros        {#macrospage}
> ------------------------------------

I've been having trouble with this type of headings, too, and am now 
using "@section" and "@subsection" instead, as in:

@subsection macrospage Function Macros

Re: [Doxygen-users] Main page in Markdown

[Alessandro A. <ant...@gm...>]

Hi, all.

Thanks for the answers.

Albert. The file extension is '.md' and it is already mapped in the
'doxyfile'
configuration file. The file has 343 lines and is parsed Ok. The only
problem
is the headings that are not rendered as <h2> tags as it should be.

Hi, Christoph Lipka. I didn't understand your answer. My file is a Markdown
file. How can I put a '@subsection' inside it? Or are you suggesting to
change
the entire file to Doxygen markup?


2015-01-17 12:23 GMT-02:00 Christoph Lipka <chr...@li...>:

>  Am 17.01.2015 um 14:49 schrieb Alessandro Antonello:
>
>  I am using doxygen 1.8.9.1 under Cygwin in a Windows 7 64 bits and I'm
> having
> difficulties to generate the main page of a C library in Markdown. The
> problematic piece of text follows:
>
>  ~~~~~~~~~~~~
> The following pages have more comments and important notes on this library.
>
>  - [Macros](#macrospage)
> - [Functions](#functionspage)
> - [Formated Strings](#printfformat)
> - [Formated Scanning](#scanfformat)
> - [Time Formating](#timeformat)
>
>  Function Macros        {#macrospage}
> ------------------------------------
>
>
> I've been having trouble with this type of headings, too, and am now using
> "@section" and "@subsection" instead, as in:
>
> @subsection macrospage Function Macros
>
>
>
> ------------------------------------------------------------------------------
> New Year. New Location. New Benefits. New Data Center in Ashburn, VA.
> GigeNET is offering a free month of service with a new server in Ashburn.
> Choose from 2 high performing configs, both with 100TB of bandwidth.
> Higher redundancy.Lower latency.Increased capacity.Completely compliant.
> http://p.sf.net/sfu/gigenet
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>