Coding-rules.md

@@ -33,12 +33,14 @@ Here are gathered some good practice for coding.
 * Class and function documentation:
    * You can add to a class/function/member a (brief) description by introducing a doxygen comment of level 1 on the line before the declaration. (You can do it after on the same line using "//!<", which is pratical for enum type for example).
    * For the class description, use:
-> /* \class MyClass
-> * detailed description
-> * bla bla
-> * bla bla
-> */
-> class MyClass
+```
+/* \class MyClass
+* detailed description
+* bla bla
+* bla bla
+*/
+class MyClass
+```
   * For a member function, you can add a detailed description in addition to a brief one by using level 2 doxygen comment just after the level 1 or inside the function implementation.
   * You can group functions or variables together inside a same group by starting with the bookmark "//! @name My group" and closing it with "//! @}"
   * CodeLite is able to indentify doxygen comments and bookmarks and allow to generate automatic doxygen comments.