Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update README.coding to match the current practice for getters/setters.
authorArnaud Giersch <arnaud.giersch@univ-fcomte.fr>
Fri, 23 Oct 2020 13:28:39 +0000 (15:28 +0200)
committerArnaud Giersch <arnaud.giersch@univ-fcomte.fr>
Fri, 23 Oct 2020 14:13:28 +0000 (16:13 +0200)
README.coding

index 44414b9..7417d89 100644 (file)
@@ -35,11 +35,11 @@ SimGrid4 will follow the these rules:
     - Example: src/kernel/activity/Activity.cpp
                include/simgrid/activity/Activity.hpp
   C
-  - Field getters are named sg_object_field() eg sg_link_name()
-    Field setters are named sg_object_field_set() eg sg_link_data_set()
+  - Field getters are named sg_object_get_field() e.g. sg_link_get_name()
+    Field setters are named sg_object_set_field() e.g. sg_link_set_data()
   - variables and functions are in snake_case()
-  - typedefs do not hide the pointers, ie * must be explicit
-    char * sg_host_get_name(sg_host_t * host);
+  - typedefs do not hide the pointers, i.e. * must be explicit
+    char* sg_host_get_name(sg_host_t* host);
   
 
 This is different from the old convention (described below), that