From: Guido Kanschat Date: Mon, 7 Mar 2005 22:41:45 +0000 (+0000) Subject: validated X-Git-Tag: v8.0.0~14492 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b054d6a04fc5b3641b7ebfb2fc910446c2b70421;p=dealii.git validated git-svn-id: https://svn.dealii.org/trunk@10036 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/doc/development/writing-documentation.html b/deal.II/doc/development/writing-documentation.html index d1c43af0fc..859e2e0897 100644 --- a/deal.II/doc/development/writing-documentation.html +++ b/deal.II/doc/development/writing-documentation.html @@ -49,7 +49,7 @@

- +

Writing API documentation

@@ -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 +

-

- +

Writing example programs

The Tutorial