libstdc++-v3/doc/html/manual/bk01apas04.html

   1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Documentation Style</title><meta name="generator" content="DocBook XSL Stylesheets V1.74.0" /><meta name="keywords" content="&#10;      ISO C++&#10;    , &#10;      library&#10;    " /><link rel="home" href="../spine.html" title="The GNU C++ Library Documentation" /><link rel="up" href="appendix_contributing.html" title="Appendix A. Contributing" /><link rel="prev" href="bk01apas03.html" title="Coding Style" /><link rel="next" href="bk01apas05.html" title="Design Notes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Documentation Style</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="bk01apas03.html">Prev</a> </td><th width="60%" align="center">Appendix A. Contributing</th><td width="20%" align="right"> <a accesskey="n" href="bk01apas05.html">Next</a></td></tr></table><hr /></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="contrib.doc_style"></a>Documentation Style</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="doc_style.doxygen"></a>Doxygen</h3></div></div></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="doxygen.prereq"></a>Prerequisites</h4></div></div></div><p>
   4         Prerequisite tools are Bash 2.x,
   5         <a class="ulink" href="http://www.doxygen.org/" target="_top">Doxygen</a>, and
   6         the <a class="ulink" href="http://www.gnu.org/software/coreutils/" target="_top">GNU
   7         coreutils</a>. (GNU versions of find, xargs, and possibly
   8         sed and grep are used, just because the GNU versions make
   9         things very easy.)
  10       </p><p>
  11         To generate the pretty pictures and hierarchy
  12         graphs, the
  13         <a class="ulink" href="http://www.research.att.com/sw/tools/graphviz/download.html" target="_top">Graphviz</a>
  14         package will need to be installed.
  15       </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="doxygen.rules"></a>Generating the Doxygen Files</h4></div></div></div><p>
  16         The following Makefile rules run Doxygen to generate HTML
  17         docs, XML docs, and the man pages.
  18       </p><p>
  19       </p><pre class="screen"><strong class="userinput"><code>make doc-html-doxygen</code></strong></pre><p>
  20       </p><p>
  21       </p><pre class="screen"><strong class="userinput"><code>make doc-xml-doxygen</code></strong></pre><p>
  22       </p><p>
  23       </p><pre class="screen"><strong class="userinput"><code>make doc-man-doxygen</code></strong></pre><p>
  24       </p><p>
  25         Careful observers will see that the Makefile rules simply call
  26         a script from the source tree, <code class="filename">run_doxygen</code>, which
  27         does the actual work of running Doxygen and then (most
  28         importantly) massaging the output files. If for some reason
  29         you prefer to not go through the Makefile, you can call this
  30         script directly. (Start by passing <code class="literal">--help</code>.)
  31       </p><p>
  32         If you wish to tweak the Doxygen settings, do so by editing
  33         <code class="filename">doc/doxygen/user.cfg.in</code>. Notes to fellow
  34         library hackers are written in triple-# comments.
  35       </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="doxygen.markup"></a>Markup</h4></div></div></div><p>
  36         In general, libstdc++ files should be formatted according to
  37         the rules found in the
  38         <a class="link" href="bk01apas03.html" title="Coding Style">Coding Standard</a>. Before
  39         any doxygen-specific formatting tweaks are made, please try to
  40         make sure that the initial formatting is sound.
  41       </p><p>
  42         Adding Doxygen markup to a file (informally called
  43         “<span class="quote">doxygenating</span>”) is very simple. The Doxygen manual can be
  44         found
  45         <a class="ulink" href="http://www.stack.nl/~dimitri/doxygen/download.html#latestman" target="_top">here</a>.
  46         We try to use a very-recent version of Doxygen.
  47       </p><p>
  48         For classes, use
  49         <code class="classname">deque</code>/<code class="classname">vector</code>/<code class="classname">list</code>
  50         and <code class="classname">std::pair</code> as examples.  For
  51         functions, see their member functions, and the free functions
  52         in <code class="filename">stl_algobase.h</code>. Member functions of
  53         other container-like types should read similarly to these
  54         member functions.
  55       </p><p>
  56         These points accompany the first list in section 3.1 of the
  57         Doxygen manual:
  58       </p><div class="orderedlist"><ol type="1"><li><p>Use the Javadoc style...</p></li><li><p>
  59             ...not the Qt style. The intermediate *'s are preferred.
  60           </p></li><li><p>
  61             Use the triple-slash style only for one-line comments (the
  62             “<span class="quote">brief</span>” mode).  Very recent versions of Doxygen permit
  63             full-mode comments in triple-slash blocks, but the
  64             formatting still comes out wonky.
  65           </p></li><li><p>
  66             This is disgusting. Don't do this.
  67           </p></li></ol></div><p>
  68         Use the @-style of commands, not the !-style. Please be
  69         careful about whitespace in your markup comments. Most of the
  70         time it doesn't matter; doxygen absorbs most whitespace, and
  71         both HTML and *roff are agnostic about whitespace. However,
  72         in &lt;pre&gt; blocks and @code/@endcode sections, spacing can
  73         have “<span class="quote">interesting</span>” effects.
  74       </p><p>
  75         Use either kind of grouping, as
  76         appropriate. <code class="filename">doxygroups.cc</code> exists for this
  77         purpose. See <code class="filename">stl_iterator.h</code> for a good example
  78         of the “<span class="quote">other</span>” kind of grouping.
  79       </p><p>
  80         Please use markup tags like @p and @a when referring to things
  81         such as the names of function parameters. Use @e for emphasis
  82         when necessary. Use @c to refer to other standard names.
  83         (Examples of all these abound in the present code.)
  84       </p></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="doc_style.docbook"></a>Docbook</h3></div></div></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="docbook.prereq"></a>Prerequisites</h4></div></div></div><p>
  85         Editing the DocBook sources requires an XML editor. Many
  86         exist: some notable options
  87         include <span class="command"><strong>emacs</strong></span>, <span class="application">Kate</span>,
  88         or <span class="application">Conglomerate</span>.
  89       </p><p>
  90         Some editors support special “<span class="quote">XML Validation</span>”
  91         modes that can validate the file as it is
  92         produced. Recommended is the <span class="command"><strong>nXML Mode</strong></span>
  93         for <span class="command"><strong>emacs</strong></span>.
  94       </p><p>
  95         Besides an editor, additional DocBook files and XML tools are
  96         also required.
  97       </p><p>
  98         Access to the DocBook stylesheets and DTD is required. The
  99         stylesheets are usually packaged by vendor, in something
 100         like <code class="filename">docbook-style-xsl</code>. To exactly match
 101         generated output, please use a version of the stylesheets
 102         equivalent
 103         to <code class="filename">docbook-style-xsl-1.74.0-5</code>. The
 104         installation directory for this package corresponds to
 105         the <code class="literal">XSL_STYLE_DIR</code>
 106         in <code class="filename">doc/Makefile.am</code> and defaults
 107         to <code class="filename">/usr/share/sgml/docbook/xsl-stylesheets</code>.
 108       </p><p>
 109         For processing XML, an XML processor and some style
 110         sheets are necessary. Defaults are <span class="command"><strong>xsltproc</strong></span>
 111         provided by <code class="filename">libxslt</code>.
 112       </p><p>
 113         For validating the XML document, you'll need
 114         something like <span class="command"><strong>xmllint</strong></span> and access to the
 115         DocBook DTD. These are provided
 116         by a vendor package like <code class="filename">lixml2</code>.
 117       </p><p>
 118         For PDF output, something that transforms valid XML to PDF is
 119         required. Possible solutions include <span class="command"><strong>xmlto</strong></span>,
 120         <a class="ulink" href="http://xmlgraphics.apache.org/fop/" target="_top">Apache
 121         FOP</a>, or <span class="command"><strong>prince</strong></span>. Other options are
 122         listed on the DocBook web <a class="ulink" href="http://wiki.docbook.org/topic/DocBookPublishingTools" target="_top">pages</a>. Please
 123         consult the <code class="email">&lt;<a class="email" href="mailto:libstdc++@gcc.gnu.org">libstdc++@gcc.gnu.org</a>&gt;</code> list when
 124         preparing printed manuals for current best practice and suggestions.
 125       </p><p>
 126         Make sure that the XML documentation and markup is valid for
 127         any change. This can be done easily, with the validation rules
 128         in the <code class="filename">Makefile</code>, which is equivalent to doing:
 129       </p><pre class="screen">
 130           <strong class="userinput"><code>
 131 xmllint --noout --valid <code class="filename">xml/index.xml</code>
 132           </code></strong>
 133         </pre></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="docbook.rules"></a>Generating the DocBook Files</h4></div></div></div><p>
 134         The following Makefile rules generate (in order): an HTML
 135         version of all the documentation, a PDF version of the same, a
 136         single XML document, and the result of validating the entire XML
 137         document.
 138       </p><p>
 139       </p><pre class="screen"><strong class="userinput"><code>make doc-html</code></strong></pre><p>
 140       </p><p>
 141       </p><pre class="screen"><strong class="userinput"><code>make doc-pdf</code></strong></pre><p>
 142       </p><p>
 143       </p><pre class="screen"><strong class="userinput"><code>make doc-xml-single</code></strong></pre><p>
 144       </p><p>
 145       </p><pre class="screen"><strong class="userinput"><code>make doc-xml-validate</code></strong></pre><p>
 146       </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="docbook.examples"></a>File Organization and Basics</h4></div></div></div><div class="literallayout"><p><br />
 147       <span class="emphasis"><em>Which files are important</em></span><br />
 148 <br />
 149       All Docbook files are in the directory<br />
 150       libstdc++-v3/doc/xml<br />
 151 <br />
 152       Inside this directory, the files of importance:<br />
 153       spine.xml         - index to documentation set<br />
 154       manual/spine.xml  - index to manual<br />
 155       manual/*.xml      - individual chapters and sections of the manual<br />
 156       faq.xml           - index to FAQ<br />
 157       api.xml           - index to source level / API <br />
 158 <br />
 159       All *.txml files are template xml files, i.e., otherwise empty files with<br />
 160       the correct structure, suitable for filling in with new information.<br />
 161 <br />
 162       <span class="emphasis"><em>Canonical Writing Style</em></span><br />
 163 <br />
 164       class template<br />
 165       function template<br />
 166       member function template<br />
 167       (via C++ Templates, Vandevoorde)<br />
 168 <br />
 169       class in namespace std: allocator, not std::allocator<br />
 170 <br />
 171       header file: iostream, not &lt;iostream&gt;<br />
 172 <br />
 173 <br />
 174       <span class="emphasis"><em>General structure</em></span><br />
 175 <br />
 176       &lt;set&gt;<br />
 177       &lt;book&gt;<br />
 178       &lt;/book&gt;<br />
 179 <br />
 180       &lt;book&gt;<br />
 181       &lt;chapter&gt;<br />
 182       &lt;/chapter&gt;<br />
 183       &lt;/book&gt;<br />
 184 <br />
 185       &lt;book&gt;        <br />
 186       &lt;part&gt;<br />
 187       &lt;chapter&gt;<br />
 188       &lt;section&gt;<br />
 189       &lt;/section&gt;<br />
 190 <br />
 191       &lt;sect1&gt;<br />
 192       &lt;/sect1&gt;<br />
 193 <br />
 194       &lt;sect1&gt;<br />
 195       &lt;sect2&gt;<br />
 196       &lt;/sect2&gt;<br />
 197       &lt;/sect1&gt;<br />
 198       &lt;/chapter&gt;<br />
 199 <br />
 200       &lt;chapter&gt;<br />
 201       &lt;/chapter&gt;<br />
 202       &lt;/part&gt;  <br />
 203       &lt;/book&gt;<br />
 204 <br />
 205       &lt;/set&gt;<br />
 206     </p></div></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="docbook.markup"></a>Markup By Example</h4></div></div></div><p>
 207 Complete details on Docbook markup can be found in the DocBook Element
 208 Reference, <a class="ulink" href="http://www.docbook.org/tdg/en/html/part2.html" target="_top">online</a>. An
 209 incomplete reference for HTML to Docbook conversion is detailed in the
 210 table below.
 211 </p><div class="table"><a id="id552441"></a><p class="title"><b>Table A.1. HTML to Docbook XML markup comparison</b></p><div class="table-contents"><table summary="HTML to Docbook XML markup comparison" border="1"><colgroup><col align="left" /><col align="left" /></colgroup><thead><tr><th align="left">HTML</th><th align="left">XML</th></tr></thead><tbody><tr><td align="left">&lt;p&gt;</td><td align="left">&lt;para&gt;</td></tr><tr><td align="left">&lt;pre&gt;</td><td align="left">&lt;computeroutput&gt;, &lt;programlisting&gt;,
 212         &lt;literallayout&gt;</td></tr><tr><td align="left">&lt;ul&gt;</td><td align="left">&lt;itemizedlist&gt;</td></tr><tr><td align="left">&lt;ol&gt;</td><td align="left">&lt;orderedlist&gt;</td></tr><tr><td align="left">&lt;il&gt;</td><td align="left">&lt;listitem&gt;</td></tr><tr><td align="left">&lt;dl&gt;</td><td align="left">&lt;variablelist&gt;</td></tr><tr><td align="left">&lt;dt&gt;</td><td align="left">&lt;term&gt;</td></tr><tr><td align="left">&lt;dd&gt;</td><td align="left">&lt;listitem&gt;</td></tr><tr><td align="left">&lt;a href=""&gt;</td><td align="left">&lt;ulink url=""&gt;</td></tr><tr><td align="left">&lt;code&gt;</td><td align="left">&lt;literal&gt;, &lt;programlisting&gt;</td></tr><tr><td align="left">&lt;strong&gt;</td><td align="left">&lt;emphasis&gt;</td></tr><tr><td align="left">&lt;em&gt;</td><td align="left">&lt;emphasis&gt;</td></tr><tr><td align="left">"</td><td align="left">&lt;quote&gt;</td></tr></tbody></table></div></div><br class="table-break" /><p>
 213   And examples of detailed markup for which there are no real HTML
 214   equivalents are listed in the table below.
 215 </p><div class="table"><a id="id554436"></a><p class="title"><b>Table A.2. Docbook XML Element Use</b></p><div class="table-contents"><table summary="Docbook XML Element Use" border="1"><colgroup><col align="left" /><col align="left" /></colgroup><thead><tr><th align="left">Element</th><th align="left">Use</th></tr></thead><tbody><tr><td align="left">&lt;structname&gt;</td><td align="left">&lt;structname&gt;char_traits&lt;/structname&gt;</td></tr><tr><td align="left">&lt;classname&gt;</td><td align="left">&lt;classname&gt;string&lt;/classname&gt;</td></tr><tr><td align="left">&lt;function&gt;</td><td align="left">
 216         <p>&lt;function&gt;clear()&lt;/function&gt;</p>
 217         <p>&lt;function&gt;fs.clear()&lt;/function&gt;</p>
 218       </td></tr><tr><td align="left">&lt;type&gt;</td><td align="left">&lt;type&gt;long long&lt;/type&gt;</td></tr><tr><td align="left">&lt;varname&gt;</td><td align="left">&lt;varname&gt;fs&lt;/varname&gt;</td></tr><tr><td align="left">&lt;literal&gt;</td><td align="left">
 219         <p>&lt;literal&gt;-Weffc++&lt;/literal&gt;</p>
 220         <p>&lt;literal&gt;rel_ops&lt;/literal&gt;</p>
 221       </td></tr><tr><td align="left">&lt;constant&gt;</td><td align="left">
 222         <p>&lt;constant&gt;_GNU_SOURCE&lt;/constant&gt;</p>
 223         <p>&lt;constant&gt;3.0&lt;/constant&gt;</p>
 224       </td></tr><tr><td align="left">&lt;command&gt;</td><td align="left">&lt;command&gt;g++&lt;/command&gt;</td></tr><tr><td align="left">&lt;errortext&gt;</td><td align="left">&lt;errortext&gt;In instantiation of&lt;/errortext&gt;</td></tr><tr><td align="left">&lt;filename&gt;</td><td align="left">
 225         <p>&lt;filename class="headerfile"&gt;ctype.h&lt;/filename&gt;</p>
 226         <p>&lt;filename class="directory"&gt;/home/gcc/build&lt;/filename&gt;</p>
 227       </td></tr></tbody></table></div></div><br class="table-break" /></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="bk01apas03.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="appendix_contributing.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="bk01apas05.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Coding Style </td><td width="20%" align="center"><a accesskey="h" href="../spine.html">Home</a></td><td width="40%" align="right" valign="top"> Design Notes</td></tr></table></div></body></html>