From 0cc0d697b577146ecc79496232887873f7fbd718 Mon Sep 17 00:00:00 2001
From: guido
- One would often like to use a typewriter font for variable,
- function, or class names. For this, the @p
- one_word_without_spaces
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
- <tt>
is the way to go.
+ In order to use typewriter font for instance for function
+ arguments or variables, use the <tt>
HTML
+ tag. For a single word, you can also use the form @p
+ one_word_without_spaces
.
- As a convention, we always write variable and function
- names as @p name
in order to give them a visible
- distinction.
+ If you refer to member variables and member functions
+ doxygen has better options than this: use
+ function_name() to reference member functions and
+ #variable_name for member variables to create links
+ automatically. Refer to the documentation of doxygen to
+ get even more options for global variables.
To generate output in italics, use the @em
- one_word_without_spaces
tag.
+ one_word_without_spaces tag or the <em>
+ HTML tag. To generate boldface, use <b>
+
+ For simple and short formulæ use the <i> + HTML tag. Remark that you can use <sub> and + <sup> to get subscripts an superscripts, + resp. Only for longer formulæ use + $formula$ to generate an LaTeX formula which will be + included as a graphical image.
- Sections can be generated using @section TAG Section_name,
- tag. Here,
TAG
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 <hN> HTML headline
+ tags. Headlines inside class documentation should start at
+ level 3 (<h3>) to stay consistent with the
+ structure of the doxygen output.
+
+ Sections cannot be referenced, unless you add a <A + NAME="..."> name anchor to them. If you really have + to do this, please make sure the name does not interfere with + doxygen generated anchors.
@@ -200,6 +222,7 @@At present, the tools that extract information from the example programs are rather dumb. They are, to be precise, two Perl @@ -221,7 +244,20 @@ something along these lines.
- +
+ Writing example files for classes is supported by
+ doxygen. These example files go into
+ deal.II/examples/doxygen. If they are short,
+ documentation should be inside and they are included into the
+ documentation with @include filename
.
+
+ Larger example files should be documented using the
+ doxygen command @dotinclude
and
+ related commands.
+