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=" ISO C++ , library " /><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="source_code_style.html" title="Coding Style" /><link rel="next" href="source_design_notes.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="source_code_style.html">Prev</a> </td><th width="60%" align="center">Appendix A.
6 </th><td width="20%" align="right"> <a accesskey="n" href="source_design_notes.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>
7 Prerequisite tools are Bash 2.x,
8 <a class="ulink" href="http://www.doxygen.org/" target="_top">Doxygen</a>, and
9 the <a class="ulink" href="http://www.gnu.org/software/coreutils/" target="_top">GNU
10 coreutils</a>. (GNU versions of find, xargs, and possibly
11 sed and grep are used, just because the GNU versions make
14 To generate the pretty pictures and hierarchy
16 <a class="ulink" href="http://www.research.att.com/sw/tools/graphviz/download.html" target="_top">Graphviz</a>
17 package will need to be installed.
18 </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>
19 The following Makefile rules run Doxygen to generate HTML
20 docs, XML docs, and the man pages.
22 </p><pre class="screen"><strong class="userinput"><code>make doc-html-doxygen</code></strong></pre><p>
24 </p><pre class="screen"><strong class="userinput"><code>make doc-xml-doxygen</code></strong></pre><p>
26 </p><pre class="screen"><strong class="userinput"><code>make doc-man-doxygen</code></strong></pre><p>
28 Careful observers will see that the Makefile rules simply call
29 a script from the source tree, <code class="filename">run_doxygen</code>, which
30 does the actual work of running Doxygen and then (most
31 importantly) massaging the output files. If for some reason
32 you prefer to not go through the Makefile, you can call this
33 script directly. (Start by passing <code class="literal">--help</code>.)
35 If you wish to tweak the Doxygen settings, do so by editing
36 <code class="filename">doc/doxygen/user.cfg.in</code>. Notes to fellow
37 library hackers are written in triple-# comments.
38 </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>
39 In general, libstdc++ files should be formatted according to
40 the rules found in the
41 <a class="link" href="source_code_style.html" title="Coding Style">Coding Standard</a>. Before
42 any doxygen-specific formatting tweaks are made, please try to
43 make sure that the initial formatting is sound.
45 Adding Doxygen markup to a file (informally called
46 “<span class="quote">doxygenating</span>”) is very simple. The Doxygen manual can be
48 <a class="ulink" href="http://www.stack.nl/~dimitri/doxygen/download.html#latestman" target="_top">here</a>.
49 We try to use a very-recent version of Doxygen.
52 <code class="classname">deque</code>/<code class="classname">vector</code>/<code class="classname">list</code>
53 and <code class="classname">std::pair</code> as examples. For
54 functions, see their member functions, and the free functions
55 in <code class="filename">stl_algobase.h</code>. Member functions of
56 other container-like types should read similarly to these
59 These points accompany the first list in section 3.1 of the
61 </p><div class="orderedlist"><ol type="1"><li><p>Use the Javadoc style...</p></li><li><p>
62 ...not the Qt style. The intermediate *'s are preferred.
64 Use the triple-slash style only for one-line comments (the
65 “<span class="quote">brief</span>” mode). Very recent versions of Doxygen permit
66 full-mode comments in triple-slash blocks, but the
67 formatting still comes out wonky.
69 This is disgusting. Don't do this.
70 </p></li></ol></div><p>
71 Use the @-style of commands, not the !-style. Please be
72 careful about whitespace in your markup comments. Most of the
73 time it doesn't matter; doxygen absorbs most whitespace, and
74 both HTML and *roff are agnostic about whitespace. However,
75 in <pre> blocks and @code/@endcode sections, spacing can
76 have “<span class="quote">interesting</span>” effects.
78 Use either kind of grouping, as
79 appropriate. <code class="filename">doxygroups.cc</code> exists for this
80 purpose. See <code class="filename">stl_iterator.h</code> for a good example
81 of the “<span class="quote">other</span>” kind of grouping.
83 Please use markup tags like @p and @a when referring to things
84 such as the names of function parameters. Use @e for emphasis
85 when necessary. Use @c to refer to other standard names.
86 (Examples of all these abound in the present code.)
87 </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>
88 Editing the DocBook sources requires an XML editor. Many
89 exist: some notable options
90 include <span class="command"><strong>emacs</strong></span>, <span class="application">Kate</span>,
91 or <span class="application">Conglomerate</span>.
93 Some editors support special “<span class="quote">XML Validation</span>”
94 modes that can validate the file as it is
95 produced. Recommended is the <span class="command"><strong>nXML Mode</strong></span>
96 for <span class="command"><strong>emacs</strong></span>.
98 Besides an editor, additional DocBook files and XML tools are
101 Access to the DocBook stylesheets and DTD is required. The
102 stylesheets are usually packaged by vendor, in something
103 like <code class="filename">docbook-style-xsl</code>. To exactly match
104 generated output, please use a version of the stylesheets
106 to <code class="filename">docbook-style-xsl-1.74.0-5</code>. The
107 installation directory for this package corresponds to
108 the <code class="literal">XSL_STYLE_DIR</code>
109 in <code class="filename">doc/Makefile.am</code> and defaults
110 to <code class="filename">/usr/share/sgml/docbook/xsl-stylesheets</code>.
112 For processing XML, an XML processor and some style
113 sheets are necessary. Defaults are <span class="command"><strong>xsltproc</strong></span>
114 provided by <code class="filename">libxslt</code>.
116 For validating the XML document, you'll need
117 something like <span class="command"><strong>xmllint</strong></span> and access to the
118 DocBook DTD. These are provided
119 by a vendor package like <code class="filename">lixml2</code>.
121 For PDF output, something that transforms valid XML to PDF is
122 required. Possible solutions include <span class="command"><strong>xmlto</strong></span>,
123 <a class="ulink" href="http://xmlgraphics.apache.org/fop/" target="_top">Apache
124 FOP</a>, or <span class="command"><strong>prince</strong></span>. Other options are
125 listed on the DocBook web <a class="ulink" href="http://wiki.docbook.org/topic/DocBookPublishingTools" target="_top">pages</a>. Please
126 consult the <code class="email"><<a class="email" href="mailto:libstdc++@gcc.gnu.org">libstdc++@gcc.gnu.org</a>></code> list when
127 preparing printed manuals for current best practice and suggestions.
129 Make sure that the XML documentation and markup is valid for
130 any change. This can be done easily, with the validation rules
131 in the <code class="filename">Makefile</code>, which is equivalent to doing:
132 </p><pre class="screen">
133 <strong class="userinput"><code>
134 xmllint --noout --valid <code class="filename">xml/index.xml</code>
136 </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>
137 The following Makefile rules generate (in order): an HTML
138 version of all the documentation, a PDF version of the same, a
139 single XML document, and the result of validating the entire XML
142 </p><pre class="screen"><strong class="userinput"><code>make doc-html</code></strong></pre><p>
144 </p><pre class="screen"><strong class="userinput"><code>make doc-pdf</code></strong></pre><p>
146 </p><pre class="screen"><strong class="userinput"><code>make doc-xml-single</code></strong></pre><p>
148 </p><pre class="screen"><strong class="userinput"><code>make doc-xml-validate</code></strong></pre><p>
149 </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 />
150 <span class="emphasis"><em>Which files are important</em></span><br />
152 All Docbook files are in the directory<br />
153 libstdc++-v3/doc/xml<br />
155 Inside this directory, the files of importance:<br />
156 spine.xml - index to documentation set<br />
157 manual/spine.xml - index to manual<br />
158 manual/*.xml - individual chapters and sections of the manual<br />
159 faq.xml - index to FAQ<br />
160 api.xml - index to source level / API <br />
162 All *.txml files are template xml files, i.e., otherwise empty files with<br />
163 the correct structure, suitable for filling in with new information.<br />
165 <span class="emphasis"><em>Canonical Writing Style</em></span><br />
168 function template<br />
169 member function template<br />
170 (via C++ Templates, Vandevoorde)<br />
172 class in namespace std: allocator, not std::allocator<br />
174 header file: iostream, not <iostream><br />
177 <span class="emphasis"><em>General structure</em></span><br />
184 <chapter><br />
185 </chapter><br />
190 <chapter><br />
191 <section><br />
192 </section><br />
201 </chapter><br />
203 <chapter><br />
204 </chapter><br />
209 </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>
210 Complete details on Docbook markup can be found in the DocBook Element
211 Reference, <a class="ulink" href="http://www.docbook.org/tdg/en/html/part2.html" target="_top">online</a>. An
212 incomplete reference for HTML to Docbook conversion is detailed in the
214 </p><div class="table"><a id="id435551"></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"><p></td><td align="left"><para></td></tr><tr><td align="left"><pre></td><td align="left"><computeroutput>, <programlisting>,
215 <literallayout></td></tr><tr><td align="left"><ul></td><td align="left"><itemizedlist></td></tr><tr><td align="left"><ol></td><td align="left"><orderedlist></td></tr><tr><td align="left"><il></td><td align="left"><listitem></td></tr><tr><td align="left"><dl></td><td align="left"><variablelist></td></tr><tr><td align="left"><dt></td><td align="left"><term></td></tr><tr><td align="left"><dd></td><td align="left"><listitem></td></tr><tr><td align="left"><a href=""></td><td align="left"><ulink url=""></td></tr><tr><td align="left"><code></td><td align="left"><literal>, <programlisting></td></tr><tr><td align="left"><strong></td><td align="left"><emphasis></td></tr><tr><td align="left"><em></td><td align="left"><emphasis></td></tr><tr><td align="left">"</td><td align="left"><quote></td></tr></tbody></table></div></div><br class="table-break" /><p>
216 And examples of detailed markup for which there are no real HTML
217 equivalents are listed in the table below.
218 </p><div class="table"><a id="id500888"></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"><structname></td><td align="left"><structname>char_traits</structname></td></tr><tr><td align="left"><classname></td><td align="left"><classname>string</classname></td></tr><tr><td align="left"><function></td><td align="left">
219 <p><function>clear()</function></p>
220 <p><function>fs.clear()</function></p>
221 </td></tr><tr><td align="left"><type></td><td align="left"><type>long long</type></td></tr><tr><td align="left"><varname></td><td align="left"><varname>fs</varname></td></tr><tr><td align="left"><literal></td><td align="left">
222 <p><literal>-Weffc++</literal></p>
223 <p><literal>rel_ops</literal></p>
224 </td></tr><tr><td align="left"><constant></td><td align="left">
225 <p><constant>_GNU_SOURCE</constant></p>
226 <p><constant>3.0</constant></p>
227 </td></tr><tr><td align="left"><command></td><td align="left"><command>g++</command></td></tr><tr><td align="left"><errortext></td><td align="left"><errortext>In instantiation of</errortext></td></tr><tr><td align="left"><filename></td><td align="left">
228 <p><filename class="headerfile">ctype.h</filename></p>
229 <p><filename class="directory">/home/gcc/build</filename></p>
230 </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="source_code_style.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="source_design_notes.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>