Browse code

Renaming ser-coding-style.txt to sr-coding-style.txt and adds "SIP-router" in the heading

...to make it known that this is not an old expired document...

oej authored on 21/10/2009 07:45:15
Showing 1 changed files
1 1
similarity index 72%
2 2
rename from doc/ser-coding-style.txt
3 3
rename to doc/sr-coding-style.txt
... ...
@@ -1,11 +1,12 @@
1 1
 # $Id$
2 2
 #
3
-# SER Coding Style
3
+# SIP-router Coding Style
4 4
 #
5 5
 #  2004-06-07  Andrei Pelinescu - Onciul <pelinescu-onciul@fokus.franhofer.de>
6 6
 
7 7
 
8 8
 Important rules:
9
+----------------
9 10
 - use tabs for identations
10 11
 - tabs are set to 4 spaces
11 12
 - break lines longer than 80 characters
... ...
@@ -26,6 +27,7 @@ Important rules:
26 26
 
27 27
 
28 28
 Not so important rules:
29
+-----------------------
29 30
 - don't declare and init variable in the same time (unless they are static or global)
30 31
   e.g.:
31 32
         use instead of int i=0;
... ...
@@ -41,6 +43,14 @@ Not so important rules:
41 41
 - try to describe what a function does in a comment at the head of the function
42 42
   (try to document at least the return values)
43 43
 
44
-If you are editing someone elses code, try to use his coding conventions (unless they contradict with some of the above rules).
44
+Doxygen
45
+-------
46
+- try to always add doxygen comments to functions and variables declared in your code. 
47
+  Especially remember to document public functions, functions and structures
48
+  that are part of the SIP-router API.
49
+- each file needs a declaration of the purpose of the file in the \file section
50
+
51
+If you are editing someone elses code, try to use his coding conventions
52
+(unless they contradict with some of the above rules).
45 53
 
46 54