Re: Generating TOC for .md files

Albert <[email protected]> Mon, 1 Mar 2021 17:39:48 +0100
Newsgroups gmane.text.doxygen.devel
Message-ID <CABOOx7b25269W4ok=LHGeveLLGGncgaA+eePnr4o_D5QPr5z3Q@mail.gmail.com>
--===============4005860128328036319==
Content-Type: multipart/alternative; boundary="0000000000004885b505bc7c465a"

--0000000000004885b505bc7c465a
Content-Type: text/plain; charset="UTF-8"

Randy,

It is easier to communicate over an issue in the doxygen github issue
tracker, so best is to move n that direction.
Furthermore:
- Can you please attach to such an issue a, small, self contained example
(source+configuration file in a tar or zip) that allows us to reproduce the
problem? Please don't add external links as they might not be persistent.
- Please also specify the full doxygen version used (`doxygen -v`).

<http://www.avg.com/email-signature?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail>
Virus-free.
www.avg.com
<http://www.avg.com/email-signature?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail>
<#DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2>

On Mon, Mar 1, 2021 at 5:00 PM Randy Yates <[email protected]> wrote:

> if i've specified the "recurse" option, and one of my file types is
> .md (markdown), so that i can get my document files into my generated
> doxy output, how do i group multiple .md files, say, in one specific
> subfolder, under one top-level menu in the doxy output's toc pane (the
> left pane on the main page)?
>
> so e.g., if i have msg/doc1.md and msg/doc2.md, i want there to be one
> Messages entry in the doxygen output with each of the document titles
> as submenus, for example, "How to clean your oven" and "Roast Duck
> Soup Recipe", respectively.
>
> so the doxygen-generated output would have:
>
> Message
>  How to clean your oven
>  Roast Duck Soup Recipe
>
> with the .md contents under each?
>
> i am aware of the "# doctitle" method for naming docs in the toc pane,
> but not how to group them
>
> more generally, where is the format of the doc header comment formats
> inside .md files for doxygen?
>
>  --Randy Yates, DSP/Embedded Firmware Developer
>
>
> _______________________________________________
> Doxygen-develop mailing list
> [email protected]
> https://lists.sourceforge.net/lists/listinfo/doxygen-develop
>

--0000000000004885b505bc7c465a
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr"><div>Randy,</div><div><br></div><div>It is easier to commu=
nicate over an issue in the doxygen github issue tracker, so best is to mov=
e n that direction.</div><div>Furthermore:</div><div>- Can you please attac=
h to such an issue a, small, self contained example (source+configuration f=
ile in a tar or zip) that allows us to reproduce the problem? Please don&#3=
9;t add external links as they might not be persistent. =C2=A0<br>- Please =
also specify the full doxygen version used (`doxygen -v`).</div></div><div =
id=3D"DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2"><br>
<table style=3D"border-top:1px solid #d3d4de">
	<tr>
        <td style=3D"width:55px;padding-top:13px"><a href=3D"http://www.avg=
.com/email-signature?utm_medium=3Demail&amp;utm_source=3Dlink&amp;utm_campa=
ign=3Dsig-email&amp;utm_content=3Dwebmail" target=3D"_blank"><img src=3D"ht=
tps://ipmcdn.avast.com/images/icons/icon-envelope-tick-green-avg-v1.png" al=
t=3D"" width=3D"46" height=3D"29" style=3D"width: 46px; height: 29px;"></a>=
</td>
		<td style=3D"width:470px;padding-top:12px;color:#41424e;font-size:13px;fo=
nt-family:Arial,Helvetica,sans-serif;line-height:18px">Virus-free. <a href=
=3D"http://www.avg.com/email-signature?utm_medium=3Demail&amp;utm_source=3D=
link&amp;utm_campaign=3Dsig-email&amp;utm_content=3Dwebmail" target=3D"_bla=
nk" style=3D"color:#4453ea">www.avg.com</a>
		</td>
	</tr>
</table><a href=3D"#DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2" width=3D"1" heigh=
t=3D"1"></a></div><br><div class=3D"gmail_quote"><div dir=3D"ltr" class=3D"=
gmail_attr">On Mon, Mar 1, 2021 at 5:00 PM Randy Yates &lt;<a href=3D"mailt=
o:[email protected]">[email protected]</a>&gt; wrote:<br></div><blockquote class=
=3D"gmail_quote" style=3D"margin:0px 0px 0px 0.8ex;border-left:1px solid rg=
b(204,204,204);padding-left:1ex">if i&#39;ve specified the &quot;recurse&qu=
ot; option, and one of my file types is<br>
.md (markdown), so that i can get my document files into my generated<br>
doxy output, how do i group multiple .md files, say, in one specific<br>
subfolder, under one top-level menu in the doxy output&#39;s toc pane (the<=
br>
left pane on the main page)?<br>
<br>
so e.g., if i have msg/doc1.md and msg/doc2.md, i want there to be one<br>
Messages entry in the doxygen output with each of the document titles<br>
as submenus, for example, &quot;How to clean your oven&quot; and &quot;Roas=
t Duck<br>
Soup Recipe&quot;, respectively.<br>
<br>
so the doxygen-generated output would have:<br>
<br>
Message<br>
=C2=A0How to clean your oven<br>
=C2=A0Roast Duck Soup Recipe<br>
<br>
with the .md contents under each?<br>
<br>
i am aware of the &quot;# doctitle&quot; method for naming docs in the toc =
pane,<br>
but not how to group them<br>
<br>
more generally, where is the format of the doc header comment formats<br>
inside .md files for doxygen?<br>
<br>
=C2=A0--Randy Yates, DSP/Embedded Firmware Developer<br>
<br>
<br>
_______________________________________________<br>
Doxygen-develop mailing list<br>
<a href=3D"mailto:[email protected]" target=3D"_blank">=
[email protected]</a><br>
<a href=3D"https://lists.sourceforge.net/lists/listinfo/doxygen-develop" re=
l=3D"noreferrer" target=3D"_blank">https://lists.sourceforge.net/lists/list=
info/doxygen-develop</a><br>
</blockquote></div>

--0000000000004885b505bc7c465a--


--===============4005860128328036319==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline


--===============4005860128328036319==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

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

--===============4005860128328036319==--