From 70d3a915fa7b375e4b3c4198ae7c7c9687927942 Mon Sep 17 00:00:00 2001 From: Nikola Pajkovsky Date: Wed, 21 Jul 2010 09:40:12 +0200 Subject: rename and lower-case doc files Signed-off-by: Nikola Pajkovsky --- doc/CodingStyle | 64 --------------------------------------------------------- 1 file changed, 64 deletions(-) delete mode 100644 doc/CodingStyle (limited to 'doc/CodingStyle') diff --git a/doc/CodingStyle b/doc/CodingStyle deleted file mode 100644 index 3a254b7f..00000000 --- a/doc/CodingStyle +++ /dev/null @@ -1,64 +0,0 @@ -Coding style used in abrt -================================= - -1. Class --------- -1.1 Class has to start with 'C' - -1.2 Method ------------ -1.2.1 method starts witch a capital letter -1.2.2 method name can contain only letters -1.2.3 parameter of a method has to start with the letter 'p' - -1.3 Attribute -------------- -1.3.1 non-float attribute has to start with "m_n" -1.3.2 float attribute has to start with "m_f" -1.3.3 double attribute has to start with "m_d" -1.3.4 bool attribute has to start with "m_b" -1.3.5 string/char attribute has to start with "m_s" -1.3.6 pointer attribute has to start with "m_p" -1.3.7 template attribute has to start with a template name "m_map" -1.3.8 otherwise "m_" - -2. Type -------- -2.1 every type has to end with "_t" -2.2 types created from templates has to start with a template name -2.3 words in a type has to be separated with "_" - -3. Statement ------------- -3.1 "if", "while" and "for" has to have {} every time. -3.2 { is on the new line every time - -4. Example ----------- - -typedef std::map map_new_type_t; - -class CAwesomeClass -{ - private: - map_new_type_t m_NewType; - std::string m_sName; - COtherClass* m_pOtherClass; - void PrivateFunction(int pParameter); - public: - CAwesomeClass(std::string pName) : - m_sName(pName), m_pOtherClass(NULL) - {} -}; - -void CAwesomeClass::PrivateFunction(int pParameter) -{ - if (pParameter != "") - { - // do something - } - else - { - // do something else - } -} -- cgit