add s4u-cloud-simple to the list of examples

[simgrid.git] / README.coding

diff --git a/README.coding b/README.coding
index 1154448..6b3d048 100644 (file)
--- a/README.coding
+++ b/README.coding
@@ -24,7 +24,8 @@ SimGrid4 will follow the these rules:
     (because of a bug in Sonar coverage computation)
   C++
   - fields, methods and variables are in snake_case()
     (because of a bug in Sonar coverage computation)
   C++
   - fields, methods and variables are in snake_case()

-  - Classes and Enum are in UpperCamelCase
+  - Classes and Enum names are in UpperCamelCase
+  - Enum values are in UPPER_SNAKE_CASE (as constants)

   - public filenames: api_Class.cpp and api/Class.hpp.
     - Example: src/s4u/s4u_ConditionVariable.cpp and
                include/simgrid/s4u/ConditionVariable.hpp
   - public filenames: api_Class.cpp and api/Class.hpp.
     - Example: src/s4u/s4u_ConditionVariable.cpp and
                include/simgrid/s4u/ConditionVariable.hpp


@@ -42,6 +43,30 @@ SimGrid4 will follow the these rules:
 This is different from the old convention (described below), that
 should not be used in S4U and its bindings, nor in the kernel.
 
 This is different from the old convention (described below), that
 should not be used in S4U and its bindings, nor in the kernel.
 

+**
+** Commenting the source: doxygen
+**
+****************************************************
+
+The global structure of the documentation is in doc/modules.doc
+
+The structure of each module (xbt, msg, etc) is in doc/module-<module>.doc
+
+The structure of a module is in its public header. This way, you're sure to
+see all the public interface (and only it). The different parts of the
+interface are grouped using the @name construct, even if it's buggy. Since
+parts often get reordered, it's better to add numbers to the parts (so that
+users can see the intended order).
+
+The documentation of each type and macro are also in the public header since
+this is were they live.
+
+The documentation of each function must be in the C++ file were it lives.
+
+Any public element (function, type and macro) must have a @brief part.
+
+We use @ as a command marker, not \ (so, use @brief not \brief)
+

 **
 ** OLD Type naming standard in SimGrid3
 **
 **
 ** OLD Type naming standard in SimGrid3
 **


@@ -67,31 +92,6 @@ Example:
 Moreover, only toto_t (and e_toto_t) are public. The rest (mainly s_toto_t)
 is private.
 
 Moreover, only toto_t (and e_toto_t) are public. The rest (mainly s_toto_t)
 is private.
 

-If you see any part of the code not following this convention, this is a
-bug. Please report it (or fix it yourself if you can).
-
-**
-** Commenting the source: doxygen
-**
-****************************************************
-
-The global structure of the documentation is in doc/modules.doc
-
-The structure of each module (xbt, msg, etc) is in doc/module-<module>.doc
-
-The structure of a module is in its public header. This way, you're sure to
-see all the public interface (and only it). The different parts of the
-interface are grouped using the @name construct, even if it's buggy. Since
-parts often get reordered, it's better to add numbers to the parts (so that
-users can see the intended order).
-
-The documentation of each type and macro are also in the public header since
-this is were they live.
-
-The documentation of each function must be in the C file were it lives.
-
-Any public element (function, type and macro) must have a @brief part.
-

 
 *
 * SimGrid Hacker Survival Guide (FIXME: should be betterly placed)
 
 *
 * SimGrid Hacker Survival Guide (FIXME: should be betterly placed)