Re: The beauty of LATEX
Mateusz Łoskot <[email protected]>
| Newsgroups | gmane.comp.lib.boost.documentation |
|---|---|
| Message-ID | <CABUeae-51iDHWmsrtHg1PjXmM7d9pJ5A9kH=34k5X2VFepj=+g@mail.gmail.com> |
On 18 October 2011 12:37, Paul A. Bristow <[email protected]> wrote: > PS Just to give a concrete example of a reference section, I attach a snip of a newly generated item > from a reference section by a GSoC 2011 project's docs Checks C++ Reference Section. You will see > the (rather terse) info passed through (as well as the synopsis). Template Parameters: iteration_sense - must meet the iteration_sense concept requirement First, it should be possible to safely assume taht the right naming convention is used, so the name of template parameter indicates that it must meet certain requirements. IOW, user should not expect to see loose and random naming template <typename T1, typename T2, typename T2) modulus10_algorithm unless T1, T2 and T3 are specific concept names. Now, if the template parameter links to documentation of corresponding concept where the concept is defined The whole section "Template Parameters" is useless and, in all my incapability, I have tried to point it. Otherwise, there will be plenty of repeated "Template Parameters" sections (or repeated entries) and user won't get the picture that they are related in any way. Best regards, -- Mateusz Loskot, http://mateusz.loskot.net Charter Member of OSGeo, http://osgeo.org Member of ACCU, http://accu.org _______________________________________________ Boost-docs mailing list [email protected] http://lists.boost.org/mailman/listinfo.cgi/boost-docs