Re: [PATCH] Support for C++ comments next to arguments of macro function
Albert <[email protected]> Sun, 10 Dec 2017 20:25:16 +0100
| Newsgroups | gmane.text.doxygen.devel |
|---|---|
| Message-ID | <CABOOx7aQpXKVm0RhMXx+1V=17_ZVow7ZqSdbZ6X0_oVvsqSTSQ@mail.gmail.com> |
--===============4974341645073207485== Content-Type: multipart/alternative; boundary="001a113fe8b2b3b25605600160dc" --001a113fe8b2b3b25605600160dc Content-Type: text/plain; charset="UTF-8" Dear Christian, Not sure if this is wanted., especially when the second part of the comment spans multiple lines. In this case we see now multiple lines in the comment although the intention, by the documentation writer, was just one block but this could lead to an incredible long line in the original source. Albert <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 Sun, Dec 10, 2017 at 8:14 PM, Christian Schoenebeck via Doxygen-develop < [email protected]> wrote: > On Sonntag, 10. Dezember 2017 19:50:06 CET Albert wrote: > > Dear Christian, > > > > What happens in case of multi-line inline comments? > > E.g.: > > DECLARE_ENUM(Foo_t, > > foo1 = 0x000000001, ///< First comment. > > ///< continuation of first comment > > foo2 = 22, ///< Second comment. > > ///< continuation of second comment > > foo3 > > ); > > Internally that example macro would first be expanded by the lexer like > this: > > enum Foo_t { foo1 = 0x000000001, /**< First comment. */ > /**< continuation of first comment */ foo2 = 22, > /**< Second comment. */ /**< continuation of second > comment */ foo3 }; > > Everything in one line at this point. > > And in the final (i.e. html) document the enum member "foo1" for example > would then end up with the following explanation text (tested): > > --------------------------- > First comment > [NEW-LINE] > continuation of first comment > --------------------------- > > Best regards, > Christian Schoenebeck > > ------------------------------------------------------------ > ------------------ > Check out the vibrant tech community on one of the world's most > engaging tech sites, Slashdot.org! http://sdm.link/slashdot > _______________________________________________ > Doxygen-develop mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/doxygen-develop > --001a113fe8b2b3b25605600160dc Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable <div dir=3D"ltr"><div>Dear Christian,<br><br>Not sure if this is wanted., e= specially when the second part of the comment spans multiple lines. In this= case we see now multiple lines in the comment although the intention, by t= he documentation writer, was just one block but this could lead to an incre= dible long line in the original source.<br><br></div>Albert<br></div><div i= d=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&utm_source=3Dlink&utm_campa= ign=3Dsig-email&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&utm_source=3D= link&utm_campaign=3Dsig-email&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><div class=3D"gmail_extra"><br><div class=3D"gmail_quote"= >On Sun, Dec 10, 2017 at 8:14 PM, Christian Schoenebeck via Doxygen-develop= <span dir=3D"ltr"><<a href=3D"mailto:[email protected].= net" target=3D"_blank">[email protected]</a>></span>= wrote:<br><blockquote class=3D"gmail_quote" style=3D"margin:0 0 0 .8ex;bor= der-left:1px #ccc solid;padding-left:1ex"><span class=3D"">On Sonntag, 10. = Dezember 2017 19:50:06 CET Albert wrote:<br> > Dear Christian,<br> ><br> > What happens in case of multi-line inline comments?<br> > E.g.:<br> > DECLARE_ENUM(Foo_t,<br> >=C2=A0 =C2=A0 =C2=A0 foo1 =3D 0x000000001, ///< First comment.<br> >=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 = =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0///< conti= nuation of first comment<br> >=C2=A0 =C2=A0 =C2=A0 foo2 =3D 22, ///< Second comment.<br> >=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 = =C2=A0///< continuation of second comment<br> >=C2=A0 =C2=A0 =C2=A0 foo3<br> >=C2=A0 );<br> <br> </span>Internally that example macro would first be expanded by the lexer l= ike this:<br> <br> enum Foo_t {=C2=A0 =C2=A0 =C2=A0foo1 =3D 0x000000001, /**< First comment= . */=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 = =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 /**< continuatio= n of first comment */=C2=A0 =C2=A0 =C2=A0foo2 =3D 22, /**< Second commen= t. */=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 = /**< continuation of second comment */=C2=A0 =C2=A0 =C2=A0foo3 };<br> <br> Everything in one line at this point.<br> <br> And in the final (i.e. html) document the enum member "foo1" for = example would then end up with the following explanation text (tested):<br> <br> ---------------------------<br> First comment<br> [NEW-LINE]<br> continuation of first comment<br> ---------------------------<br> <div class=3D"HOEnZb"><div class=3D"h5"><br> Best regards,<br> Christian Schoenebeck<br> <br> ------------------------------<wbr>------------------------------<wbr>-----= -------------<br> Check out the vibrant tech community on one of the world's most<br> engaging tech sites, Slashdot.org! <a href=3D"http://sdm.link/slashdot" rel= =3D"noreferrer" target=3D"_blank">http://sdm.link/slashdot</a><br> ______________________________<wbr>_________________<br> Doxygen-develop mailing list<br> <a href=3D"mailto:[email protected]">Doxygen-develop@li= sts.<wbr>sourceforge.net</a><br> <a href=3D"https://lists.sourceforge.net/lists/listinfo/doxygen-develop" re= l=3D"noreferrer" target=3D"_blank">https://lists.sourceforge.net/<wbr>lists= /listinfo/doxygen-develop</a><br> </div></div></blockquote></div><br></div> --001a113fe8b2b3b25605600160dc-- --===============4974341645073207485== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline ------------------------------------------------------------------------------ Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot --===============4974341645073207485== 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 --===============4974341645073207485==--