From: guido <guido@0785d39b-7218-0410-832d-ea1e28bc413d>
Date: Tue, 30 Aug 2005 22:00:53 +0000 (+0000)
Subject: information on excluding from documentation
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e1f29ead2c9b1348ead77613752f145ccc5a16a9;p=dealii-svn.git

information on excluding from documentation


git-svn-id: https://svn.dealii.org/trunk@11351 0785d39b-7218-0410-832d-ea1e28bc413d
---

diff --git a/deal.II/doc/development/writing-documentation.html b/deal.II/doc/development/writing-documentation.html
index 86fcfeec66..13f89f9c46 100644
--- a/deal.II/doc/development/writing-documentation.html
+++ b/deal.II/doc/development/writing-documentation.html
@@ -224,6 +224,23 @@
 	 to do this, please make sure the name does not interfere with
 	 <acronym>doxygen</acronym> generated anchors.
 	 </p>
+
+    <li> <em>Exclusion from documentation:</em>
+         <p> <acronym>doxygen</acronym> sometimes has problems with inlined
+	 functions of template classes. For these cases (and other cases of
+	 parts of the code to be excluded from documentation), we define a
+	 preprocessor symbol <tt>DOXYGEN</tt> when running
+	 <acronym>doxygen</acronym>. Therefore, the following template can be
+	 used to avoid documentation:</p>
+	 <pre>
+	 documented code here
+
+	 #ifndef DOXYGEN
+
+	 code here is compiled, but ignored by doxygen
+
+	 #endif // DOXYGEN
+	 </pre>
     </ul>