Recent changes to Coding Guidelines.

Coding Guidelines. modified by Siraj Razick

Siraj Razick — Wed, 04 Mar 2015 20:28:58 -0000

--- v2
+++ v3
@@ -13,6 +13,6 @@
 * C++ API documentation should be compatible with Doxygen
 * Doxygen comments should be added to the implementation files (.cpp).
 * Include guards in header files should be named as : NAMESPACE_CLASS_NAME_H
+* Logically related member functions should be grouped and non related functions should be separated by a new line.

-

Coding Guidelines. modified by Siraj Razick

Siraj Razick — Wed, 04 Mar 2015 20:28:58 -0000

--- v1
+++ v2
@@ -1,3 +1,5 @@
+### Basic Rules
+
 * Avoid indenting namespaces.
 * Use Camel Case for Class Names and starts with a Uppercase letter.
 * Use Camel case for member functions and starts with a lowercase letter.
@@ -6,3 +8,11 @@
 * Pointers should have a postfix "Ptr"
 * Shared pointers should have a postfix "ShPtr"
 * Use [Astyle Gist](https://gist.github.com/siraj/eb0505149452bc0caca1) to auto indent code.
+* Each line should never exceed 80 char's
+* Use Opaque pointers in public API headers.
+* C++ API documentation should be compatible with Doxygen
+* Doxygen comments should be added to the implementation files (.cpp).
+* Include guards in header files should be named as : NAMESPACE_CLASS_NAME_H
+
+
+

Coding Guidelines. modified by Siraj Razick

Siraj Razick — Wed, 04 Mar 2015 20:28:57 -0000

Avoid indenting namespaces.
Use Camel Case for Class Names and starts with a Uppercase letter.
Use Camel case for member functions and starts with a lowercase letter.
Argument variable name should be prefixed with letter 'a'
Member variables should be prefixed with letter 'm'
Pointers should have a postfix "Ptr"
Shared pointers should have a postfix "ShPtr"
Use Astyle Gist to auto indent code.