Documentation Style

Prerequisite tools are Bash 2.0 or later, Doxygen, and the GNU coreutils. (GNU versions of find, xargs, and possibly sed and grep are used, just because the GNU versions make things very easy.)

To generate the pretty pictures and hierarchy graphs, the Graphviz package will need to be installed. For PDF output, pdflatex is required.

In general, libstdc++ files should be formatted according to the rules found in the Coding Standard. Before any doxygen-specific formatting tweaks are made, please try to make sure that the initial formatting is sound.

Adding Doxygen markup to a file (informally called doxygenating) is very simple. The Doxygen manual can be found here. We try to use a very-recent version of Doxygen.

For classes, use deque/vector/list and std::pair as examples. For functions, see their member functions, and the free functions in stl_algobase.h. Member functions of other container-like types should read similarly to these member functions.

Some commentary to accompany the first list in the Special Documentation Blocks section of the Doxygen manual:

  1. For longer comments, use the Javadoc style...

  2. ...not the Qt style. The intermediate *'s are preferred.

  3. Use the triple-slash style only for one-line comments (the brief mode).

  4. This is disgusting. Don't do this.

Some specific guidelines:

Use the @-style of commands, not the !-style. Please be careful about whitespace in your markup comments. Most of the time it doesn't matter; doxygen absorbs most whitespace, and both HTML and *roff are agnostic about whitespace. However, in <pre> blocks and @code/@endcode sections, spacing can have interesting effects.

Use either kind of grouping, as appropriate. doxygroups.cc exists for this purpose. See stl_iterator.h for a good example of the other kind of grouping.

Please use markup tags like @p and @a when referring to things such as the names of function parameters. Use @e for emphasis when necessary. Use @c to refer to other standard names. (Examples of all these abound in the present code.)

Complicated math functions should use the multi-line format. An example from random.h:


  /**
   * @brief A model of a linear congruential random number generator.
   *
   * @f[
   *     x_{i+1}\leftarrow(ax_{i} + c) \bmod m
   * @f]
   */

Be careful about using certain, special characters when writing Doxygen comments. Single and double quotes, and separators in filenames are two common trouble spots. When in doubt, consult the following table.


Editing the DocBook sources requires an XML editor. Many exist: some notable options include emacs, Kate, or Conglomerate.

Some editors support special XML Validation modes that can validate the file as it is produced. Recommended is the nXML Mode for emacs.

Besides an editor, additional DocBook files and XML tools are also required.

Access to the DocBook 5.0 stylesheets and schema is required. The stylesheets are usually packaged by vendor, in something like docbook5-style-xsl. To exactly match generated output, please use a version of the stylesheets equivalent to docbook5-style-xsl-1.75.2-3. The installation directory for this package corresponds to the XSL_STYLE_DIR in doc/Makefile.am and defaults to /usr/share/sgml/docbook/xsl-ns-stylesheets.

For processing XML, an XML processor and some style sheets are necessary. Defaults are xsltproc provided by libxslt.

For validating the XML document, you'll need something like xmllint and access to the relevant DocBook schema. These are provided by a vendor package like libxml2 and docbook5-schemas-5.0-4

For PDF output, something that transforms valid Docbook XML to PDF is required. Possible solutions include dblatex, xmlto, or prince. Of these, dblatex is the default. Other options are listed on the DocBook web pages. Please consult the list when preparing printed manuals for current best practice and suggestions.

For Texinfo output, something that transforms valid Docbook XML to Texinfo is required. The default choice is docbook2X.

Please make sure that the XML documentation and markup is valid for any change. This can be done easily, with the validation rule detailed below, which is equivalent to doing:

	  
xmllint --noout --valid xml/index.xml
	  
	


      Which files are important

      All Docbook files are in the directory
      libstdc++-v3/doc/xml

      Inside this directory, the files of importance:
      spine.xml   - index to documentation set
      manual/spine.xml  - index to manual
      manual/*.xml   - individual chapters and sections of the manual
      faq.xml   - index to FAQ
      api.xml   - index to source level / API

      All *.txml files are template xml files, i.e., otherwise empty files with
      the correct structure, suitable for filling in with new information.

      Canonical Writing Style

      class template
      function template
      member function template
      (via C++ Templates, Vandevoorde)

      class in namespace std: allocator, not std::allocator

      header file: iostream, not <iostream>


      General structure

      <set>
      <book>
      </book>

      <book>
      <chapter>
      </chapter>
      </book>

      <book>
      <part>
      <chapter>
      <section>
      </section>

      <sect1>
      </sect1>

      <sect1>
      <sect2>
      </sect2>
      </sect1>
      </chapter>

      <chapter>
      </chapter>
      </part>
      </book>

      </set>