[Marble-commits] KDE/kdeedu/marble

[Bastian Holst]

SVN commit 1112108 by bholst:

standardizing the include guard names
http://reviewboard.kde.org/r/3506/


 M  +17 -0     CODING  


--- trunk/KDE/kdeedu/marble/CODING #1112107:1112108
@@ -49,7 +49,24 @@
 
    All other classes should not have the "Marble" prefix. 
 
+ - All header files should contain an include guard which prevents from
+   including a header file more than once. The include guard name consists
+   of the Marble namespace prefix (if the class is part of the Marble 
+   namespace), the name of the class and an H. The name is in full upper case
+   and separated with an underscore.
 
+   Correct:
+      #ifndef MARBLE_ROUTINGWIDGET_H
+      #define MARBLE_ROUTINGWIDGET_H
+      ...
+      #endif // MARBLE_ROUTINGWIDGET_H
+
+   Wrong:
+      MARBLE_ROUTING_WIDGET_H
+      MARBLEROUTINGWIDGET_H
+      ROUTINGWIDGET_H
+      ROUTING_WIDGET_H
+
  - camelCasing with the first letter being lower cased should be used 
    for methods and variables (e.g. myMethodName()). Full 
    upper cased names should be used for constants (e.g. RAD2DEG).