]> https://gitweb.dealii.org/ - dealii.git/commitdiff
.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Fri, 21 Aug 1998 17:51:13 +0000 (17:51 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Fri, 21 Aug 1998 17:51:13 +0000 (17:51 +0000)
git-svn-id: https://svn.dealii.org/trunk@500 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/Conventions

index 5b38a2b2ee8a6d2ba45e3199a91f6e9d2035c8d7..d3d5a9247bada8c1c547c1137d411b2f567468b8 100644 (file)
@@ -61,5 +61,12 @@ Here are some conventions for source code of the deal.II library:
   handle run time errors (like I/O failures) which must be on
   in any case, not only in debug mode.
 
-12./ Each class has to have at least 200 pages of documentation ;-)
+12./ Classes generally are named using uppercase letters to denote
+  word beginnings (e.g. TriaIterator) while functions and variables
+  use lowercase letters and underscores to denote different words.
+  The only exception are the iterator typedefs in Triangulation
+  and DoFHandler (named cell_iterator, active_line_iterator, etc)
+  to make the connection to the STL classes clear.
+
+13./ 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.