</p>
<li> <em>Typewriter font:</em>
+
<p>
- One would often like to use a typewriter font for variable,
- function, or class names. For this, the <code>@p
- one_word_without_spaces</code> tag is used, which generates
- output in which the single word after the tag is set in
- typewriter font. If you want to put multiple words into
- typewriter font, then enclosing them in the HTML
- <code><tt></code> is the way to go.
+ In order to use typewriter font for instance for function
+ arguments or variables, use the <code><tt></code> HTML
+ tag. For a single word, you can also use the form <code>@p
+ one_word_without_spaces</code>.
</p>
<p>
- As a convention, we always write variable and function
- names as <code>@p name</code> in order to give them a visible
- distinction.
+ If you refer to member variables and member functions
+ <acronym>doxygen</acronym> has better options than this: use
+ <tt>function_name()</tt> to reference member functions and
+ <tt>#variable_name</tt> for member variables to create links
+ automatically. Refer to the documentation of <a
+ href="http:www.doxygen.org"><acronym>doxygen</acronym></a> to
+ get even more options for global variables.
</p>
<li> <em>Emphasis:</em>
<p>
To generate output in italics, use the <code>@em
- one_word_without_spaces</code> tag.
+ one_word_without_spaces</code> tag or the <tt><em></tt>
+ HTML tag. To generate boldface, use <tt><b></tt>
+ </p>
+
+ <li> <em>Formulæ:</em>
+ <p>
+ For simple and short formulæ use the <tt><i></tt>
+ HTML tag. Remark that you can use <tt><sub></tt> and
+ <tt><sup></tt> to get subscripts an superscripts,
+ resp. Only for longer formulæ use
+ <tt>$formula$</tt> to generate an LaTeX formula which will be
+ included as a graphical image.
</p>
<li> <em>Sections:</em>
<p>
- Sections can be generated using <code>@section TAG Section_name,
- tag. Here, <code>TAG</code> is a symbolic name for the
- section, which can be used for cross references.
+ Sections in class and function documentations can be
+ generated using the <tt><hN></tt> HTML headline
+ tags. Headlines inside class documentation should start at
+ level 3 (<tt><h3></tt>) to stay consistent with the
+ structure of the <acronym>doxygen</acronym> output.
+ </p>
+
+ <p>
+ Sections cannot be referenced, unless you add a <tt><A
+ NAME="..."></tt> name anchor to them. If you really have
+ to do this, please make sure the name does not interfere with
+ <acronym>doxygen</acronym> generated anchors.
</p>
</ul>
</p>
<a name="examples">
<h3>Writing example programs</h3>
+ <h4>The Tutorial</h4>
<p>
At present, the tools that extract information from the example
programs are rather dumb. They are, to be precise, two Perl
something along these lines.
</p>
-
+ <h4>Code examples for the usage of single classes</h4>
+ <p>
+ Writing example files for classes is supported by
+ <acronym>doxygen</acronym>. These example files go into
+ <tt>deal.II/examples/doxygen</tt>. If they are short,
+ documentation should be inside and they are included into the
+ documentation with <code>@include filename</code>.
+ </p>
+
+ <p>
+ Larger example files should be documented using the
+ <acronym>doxygen</acronym> command <code>@dotinclude</code> and
+ related commands.
+ </p>
<hr>
<address>