From: Guido Kanschat Date: Tue, 30 Aug 2005 22:00:53 +0000 (+0000) Subject: information on excluding from documentation X-Git-Tag: v8.0.0~13238 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5ef2a96c4d3dd6f6f4c177f7bf024b7cf5d4ecd1;p=dealii.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 doxygen generated anchors.

+ +
  • Exclusion from documentation: +

    doxygen 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 DOXYGEN when running + doxygen. Therefore, the following template can be + used to avoid documentation:

    +
    +	 documented code here
    +
    +	 #ifndef DOXYGEN
    +
    +	 code here is compiled, but ignored by doxygen
    +
    +	 #endif // DOXYGEN
    +