Re: [boost-docs] Query regarding boostbook and documentation
Rene Rivera <[email protected]> Sun, 10 Jan 2016 21:08:43 -0600
| Newsgroups | gmane.comp.lib.boost.documentation |
|---|---|
| Message-ID | <CAHEh_GgUkeV63oQePKEyYyskM_8ktatFHh883uw904a4YOerBw@mail.gmail.com> |
--===============3595476909605232388== Content-Type: multipart/alternative; boundary=001a113fb96a29336c0529064182 --001a113fb96a29336c0529064182 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable On Sun, Jan 10, 2016 at 3:18 PM, Raffi Enficiaud < [email protected]> wrote: > Le 09/01/16 22:53, Soul Studios a =C3=A9crit : > >> b) DOxygen is here to stay. I would like to see >>> someone take up the challenge of making an extension >>> which supports type requirements (aka concepts). >>> From the users point of view, this would look like >>> the following: >>> >> >> I personally would not want to see Doxygen becoming a requirement, >> though I understand many like it. Personally I find it an impediment to >> writing clean, readable code. >> > > To clarify a bit: I never suggested Doxygen be a requirement. I am just > saying that /if you want or need/, you can use it together with quickbook= , > and this chain of action is quite well supported already by the boost > machinery. > Also.. If you use quickbook you can import docs from source comments directly into your regular quickbook docs. This is how the Predef docs manage to stay modular and maintainable by placing the docs in the source file they document. You could probably write some quickbook macros that give you an equivalent feel as Doxygen that makes it easier to write class/template/etc docs. --=20 -- Rene Rivera -- Grafik - Don't Assume Anything -- Robot Dreams - http://robot-dreams.net -- rrivera/acm.org (msn) - grafikrobot/aim,yahoo,skype,efnet,gmail --001a113fb96a29336c0529064182 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable <div dir=3D"ltr"><div class=3D"gmail_extra"><div class=3D"gmail_quote">On S= un, Jan 10, 2016 at 3:18 PM, Raffi Enficiaud <span dir=3D"ltr"><<a href= =3D"mailto:[email protected]" target=3D"_blank">raffi.enficia= [email protected]</a>></span> wrote:<br><blockquote class=3D"gmail_quot= e" style=3D"margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">= Le 09/01/16 22:53, Soul Studios a =C3=A9crit :<span class=3D""><br> <blockquote class=3D"gmail_quote" style=3D"margin:0 0 0 .8ex;border-left:1p= x #ccc solid;padding-left:1ex"><blockquote class=3D"gmail_quote" style=3D"m= argin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"> b) DOxygen is here to stay.=C2=A0 I would like to see<br> someone take up the challenge of making an extension<br> which supports type requirements (aka concepts).<br> =C2=A0From the users point of view, this would look like<br> the following:<br> </blockquote> <br> I personally would not want to see Doxygen becoming a requirement,<br> though I understand many like it. Personally I find it an impediment to<br> writing clean, readable code.<br> </blockquote> <br></span> To clarify a bit: I never suggested Doxygen be a requirement. I am just say= ing that /if you want or need/, you can use it together with quickbook, and= this chain of action is quite well supported already by the boost machiner= y.<br></blockquote><div><br></div><div>Also.. If you use quickbook you can = import docs from source comments directly into your regular quickbook docs.= This is how the Predef docs manage to stay modular and maintainable by pla= cing the docs in the source file they document.</div><div><br></div><div>Yo= u could probably write some quickbook macros that give you an equivalent fe= el as Doxygen that makes it easier to write class/template/etc docs.</div><= /div><div><br></div>-- <br><div class=3D"gmail_signature"><div dir=3D"ltr">= -- Rene Rivera<br>-- Grafik - Don't Assume Anything<br>-- Robot Dreams = -=C2=A0<a href=3D"http://robot-dreams.net/" target=3D"_blank">http://robot-= dreams.net</a><br>-- rrivera/<a href=3D"http://acm.org/" target=3D"_blank">= acm.org</a>=C2=A0(msn)=C2=A0-=C2=A0grafikrobot/aim,yahoo,skype,efnet,gmail<= /div></div> </div></div> --001a113fb96a29336c0529064182-- --===============3595476909605232388== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ Boost-docs mailing list [email protected] http://lists.boost.org/mailman/listinfo.cgi/boost-docs --===============3595476909605232388==--