From e1f29ead2c9b1348ead77613752f145ccc5a16a9 Mon Sep 17 00:00:00 2001 From: guido Date: Tue, 30 Aug 2005 22:00:53 +0000 Subject: [PATCH] information on excluding from documentation git-svn-id: https://svn.dealii.org/trunk@11351 0785d39b-7218-0410-832d-ea1e28bc413d --- .../doc/development/writing-documentation.html | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) 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
    +	 
    -- 2.39.5