]> https://gitweb.dealii.org/ - dealii.git/commitdiff
.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Tue, 19 May 1998 13:50:09 +0000 (13:50 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Tue, 19 May 1998 13:50:09 +0000 (13:50 +0000)
git-svn-id: https://svn.dealii.org/trunk@314 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/Conventions

index 9e1f34d6a394675645644660af715f4fa05b4f7d..eb6228ec654c4f58e94a276ca87f2ef024da3613 100644 (file)
@@ -38,5 +38,22 @@ Here are some conventions for source code of the deal.II library:
   place, payable by cheque when the deal.II project is considered
   finished by the author(s).
 
-9./ Each class has to have at least 200 pages of documentation ;-)
+9./ The layout of class declarations is the following: first the
+  block of public functions, beginning with the constructors, then
+  the destructors. If there are public member variables, these have
+  to occur before the constructor. Public variables shall only be
+  used if constant or unavoidable.
+
+  After the public members, the protected and finally the private
+  members are to be listed. The order is as above: first variables
+  then functions.
+
+  Exceptions shall be declared at the end of the public section
+  before the non-public sections start.
+
+10./ If a function has both input and output parameters, usually the
+  input parameters shall precede the output parameters, unless there
+  are good reasons to change this order.
+
+11./ Each class has to have at least 200 pages of documentation ;-)
 

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.