Commit 4e2ae0be authored by BRAMAS Berenger's avatar BRAMAS Berenger

just remove some typos in the doc

parent 02ae1276
......@@ -10,7 +10,7 @@
* <li> Mix capital and normal letter to write names (IAmAStaticName, iAmAName) no underscore (but if you have several variables that looks the same be careful: thisIsAXVariable thisIsAYVariable) </li>
* <li> Put const every where it is possible (method, value, pointer etc.) </li>
* <li> Declare variables usually as late as possible (we are not in old C so do not declare every thing at the beginning of a function). Of course, variable that are used in a loop but with always the same value can be declared at the function beginning. </li>
* <li> Declare index in the for loop where they are used (and their names should start with "idx") </li>
* <li> Declare index inside the for loop where they are used (and their names should start with "idx" if appropriate) </li>
* <li> Use pre-inc if possible (even if the compiler will optimized post-inc for native type) </li>
* <li> If a parameter is changed by a function use pointer else use const ref (if the size of object is less than 20 Bytes you can pass it by value, moreover if it is intensively used!)</li>
* <li> Please do not name variables with one letter (except if it is related to a mathematical formula but then this one should be in the comment in latex format)</li>
......@@ -29,7 +29,7 @@
* First of all, many classes are Templates and so, even if it is possible to split declaration and implementation
* of templates in different files such approach is not supported by all compiler, it then better
* for templates to stay in their hpp.
* For other class the debate is more open.
* For other classes the debate is more open.
* Even if it is not a argument, it is interesting to notice that all modern languages are one file per class (C#, Java, Ruby, Python, ...).
* \subsection cons Cons
......@@ -59,6 +59,6 @@
* In our project we have plenty of templates.
* Our project is not that big and many people arrived to work on it, and for now, all of them finally like to have all in the hpp when they discovered the project.
* It someone wants to know what a class is proposing, then it can do as it is usual, he looks to the doc (who is looking to Qt header to know QVector methods??).
* If someone wants to know what a class is proposing, then he can do as it is usual, he looks to the doc (who looks to Qt header to know QVector methods??).
**/
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment