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 880a93edc2ad3a3673564f8ed4de3ff60df025aa..43580ebd169900a16f130208466cb2695cc56ebb 100644 (file)
--- 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.
     </p>
 
+    <p>
+    There is one exception to the rule that every member can be
+    documented separately: due to internal restrictions of the
+    <code>kdoc2</code> tool by which the documentation is generated,
+    elements of en enumeration type (i.e. an <code>enum</code> object
+    in technical terminus) may not be documented right above their
+    declaration, but must be documented atop of the <code>enum</code>
+    declaration. (This is due to the fact that inside enums,
+    <code>kdoc2</code> does not parse the elements separately at
+    present, but rather the whole enum as one.)
+    </p>
+
     
     <h4>Extended Layout</h4>