[sr-dev] git:master: Renaming ser-coding-style.txt to sr-coding-style.txt and adds " SIP-router" in the heading

Module: sip-router Branch: master Commit: 62c6c5df9cc502a3b1bac0b66144c3da617de20c URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=62c6c5d… Author: oej <oej(a)edvina.net> Committer: oej <oej(a)edvina.net> Date: Wed Oct 21 09:45:15 2009 +0200 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... --- doc/{ser-coding-style.txt => sr-coding-style.txt} | 14 ++++++++++++-- 1 files changed, 12 insertions(+), 2 deletions(-) diff --git a/doc/ser-coding-style.txt b/doc/sr-coding-style.txt similarity index 72% rename from doc/ser-coding-style.txt rename to doc/sr-coding-style.txt index 5a2d2f5..eedcf30 100644 --- a/doc/ser-coding-style.txt +++ b/doc/sr-coding-style.txt @@ -1,11 +1,12 @@ # $Id$ # -# SER Coding Style +# SIP-router Coding Style # # 2004-06-07 Andrei Pelinescu - Onciul <pelinescu-onciul(a)fokus.franhofer.de> 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).