From: wolf Date: Tue, 10 Aug 1999 15:17:31 +0000 (+0000) Subject: Move this file to /common. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b49977e4e31270e118c60fccd193ed768a07555d;p=dealii-svn.git Move this file to /common. git-svn-id: https://svn.dealii.org/trunk@1664 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/Conventions b/deal.II/deal.II/Conventions deleted file mode 100644 index d3d5a9247b..0000000000 --- a/deal.II/deal.II/Conventions +++ /dev/null @@ -1,72 +0,0 @@ -Here are some conventions for source code of the deal.II library: -================================================================= - -1./ Functions which return the number of something (number of cells, - degrees of freedom, etc) should start with n_* - -2./ Function which set a bit or flag should start with set_*; - functions which clear bits of flags should be named clear_* - -3./ After each function, at least three empty lines are expected to - enable better readability. One empty line occurs in functions to - group blocks of code, two empty lines are not enough to distinguish - visibly enough. - -4./ Whenever an integer variable can only assume nonnegative values, - it has to be marked as unsigned. - -5./ Whenever an argument will not be changed, it should be marked - const, even if it passed by value. This makes programs more readable - and lets the compiler issue warnings if such a parameter variable is - changed, which is often either involuntarily or poor style. - -6./ Whenever a function does not change any of the member variable of - the embedding class/object, it should be marked as const. - -7./ Function and variable names may not consist of only one or two - letters, unless the variable is a pure counting index. - -8./ Use the geometry information in GeometryInfo to get the - number of faces per cell, the number of children per cell, the - child indices of the child cells adjacent to face 3, etc, rather - than writing them into the directly as 2*dim, (1<