From 5eee193c9084f9e719153e1cb89863ac1d8bdadb Mon Sep 17 00:00:00 2001 From: wolf Date: Mon, 26 Jun 2000 16:09:48 +0000 Subject: [PATCH] Note restrictions on the documentation of enums. git-svn-id: https://svn.dealii.org/trunk@3083 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/doc/development/writing-documentation.html | 12 ++++++++++++ 1 file changed, 12 insertions(+) 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

-- 2.39.5