From: Wolfgang Bangerth
Date: Mon, 26 Jun 2000 16:09:48 +0000 (+0000)
Subject: Note restrictions on the documentation of enums.
X-Git-Tag: v8.0.0~20340
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=12685f0fc9f0b33ecc175c1f70dea0d836351e32;p=dealii.git
Note restrictions on the documentation of enums.
git-svn-id: https://svn.dealii.org/trunk@3083 0785d39b-7218-0410-832d-ea1e28bc413d
---
diff --git a/deal.II/doc/development/writing-documentation.html b/deal.II/doc/development/writing-documentation.html
index 880a93edc2..43580ebd16 100644
--- a/deal.II/doc/development/writing-documentation.html
+++ b/deal.II/doc/development/writing-documentation.html
@@ -118,6 +118,18 @@
included into the online documentation of the class.
+
+ There is one exception to the rule that every member can be
+ documented separately: due to internal restrictions of the
+ kdoc2
tool by which the documentation is generated,
+ elements of en enumeration type (i.e. an enum
object
+ in technical terminus) may not be documented right above their
+ declaration, but must be documented atop of the enum
+ declaration. (This is due to the fact that inside enums,
+ kdoc2
does not parse the elements separately at
+ present, but rather the whole enum as one.)
+
+
Extended Layout