From bf22557407249ed3f975c92c4fd088b40fcb681f Mon Sep 17 00:00:00 2001
From: guido
@@ -69,7 +69,7 @@
Basically, every declaration, whether class or member
function/variable declaration, global function or namespace, may
be preceded by a comment of the following form:
-
+
/** * This is an example documentation. @@ -95,7 +95,7 @@ const unsigned int abc; };- +
doxygen will then generate a page for the class
TestClass
and document each of the member functions
and variables. The content of the @author
tag will be
@@ -110,24 +110,23 @@
doxygen supports a great number of tags for enumerations,
sectioning, markup, and other fields. For example, here is how to
generate
+
By writing comments like the following,
-
+
you can get itemized lists both in the online and printed
documentation:
+
/**
- *
- *
+ * <ul>
+ * <li> foo
+ * <li> bar
+ * </ul>
*/
-
In other words, one can use standard HTML tags for this @@ -138,7 +137,8 @@
If you write comments like this,
-
+
/** * @verbatim * void foobar () @@ -147,29 +147,25 @@ * }; * @endverbatim */ -+ you will get the lines between the verbatim environment with the same formatting and in typewriter font: -
+
void foobar ()
{
i = 0;
};
-
+
This is useful if you want to include small sample code snippets
into your documentation. In particular, it is important that
the formatting is preserved, which is not the case for all
other text.
-
- In order to use typewriter font for instance for function +
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
.
-
If you refer to member variables and member functions @@ -214,11 +210,10 @@ doxygen generated anchors.