From: Wolfgang Bangerth Date: Tue, 19 May 1998 13:50:09 +0000 (+0000) Subject: . X-Git-Tag: v8.0.0~22940 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4b27a4e5a1152763a217ab9dc11e58408d6e5586;p=dealii.git . git-svn-id: https://svn.dealii.org/trunk@314 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/Conventions b/deal.II/deal.II/Conventions index 9e1f34d6a3..eb6228ec65 100644 --- a/deal.II/deal.II/Conventions +++ b/deal.II/deal.II/Conventions @@ -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 ;-)