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 86fcfeec66de1d693b6536bff58e6ca5cd47b4d1..13f89f9c46a1474ff74e58b36288c934e64b4ac8 100644 (file)
--- 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>