CodingStyle

Coding style

Code formatting

• Files are encoded in UTF-8, with UNIX end-lines (LF)
• Indent with tabs, not spaces
• Do not indent a namespace scope
• Remove trailing whitespace
• Place opening brackets on a new line
• Use two line spaces between two function definitions

Naming conventions

• Class are written in CamelCase
• Class member functions are written in lowerCamelCase
• Class member variables start with a m_ prefix

Documentation

Use the following formatting for Doxygen headers:

/**
 * Function summary
 * @param argument: argument role
 * @return value description
 */