Browse Source

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 16 years ago
parent
commit
62c6c5df9c
1 changed files with 12 additions and 2 deletions
  1. 12 2
      doc/sr-coding-style.txt

+ 12 - 2
doc/ser-coding-style.txt → doc/sr-coding-style.txt

@@ -1,11 +1,12 @@
 # $Id$
 #
-# SER Coding Style
+# SIP-router Coding Style
 #
 #  2004-06-07  Andrei Pelinescu - Onciul <[email protected]>
 
 
 Important rules:
+----------------
 - use tabs for identations
 - tabs are set to 4 spaces
 - break lines longer than 80 characters
@@ -26,6 +27,7 @@ Important rules:
 
 
 Not so important rules:
+-----------------------
 - don't declare and init variable in the same time (unless they are static or global)
   e.g.:
         use instead of int i=0;
@@ -41,6 +43,14 @@ Not so important rules:
 - try to describe what a function does in a comment at the head of the function
   (try to document at least the return values)
 
-If you are editing someone elses code, try to use his coding conventions (unless they contradict with some of the above rules).
+Doxygen
+-------
+- try to always add doxygen comments to functions and variables declared in your code. 
+  Especially remember to document public functions, functions and structures
+  that are part of the SIP-router API.
+- each file needs a declaration of the purpose of the file in the \file section
+
+If you are editing someone elses code, try to use his coding conventions
+(unless they contradict with some of the above rules).