Changes between Version 5 and Version 6 of Code Conventions


Ignore:
Timestamp:
16.10.2013 13:58:18 (5 years ago)
Author:
foehst
Comment:

Fixed some typos

Legend:

Unmodified
Added
Removed
Modified
  • Code Conventions

    v5 v6  
    141141}}} 
    142142 
    143 The name of an enumeration itself is a typename and therefore must be prepended with a `t`. 
     143The name of an enumeration itself is a typename and therefore must be prefixed with a `t`. 
    144144 
    145145=== Templates === 
     
    299299==== Use Doxygen for you API ==== 
    300300 
    301 Of course, according to the last point the API of your code should contain self-exlpantory names. 
     301Of course, according to the last point the API of your code should contain self-explanatory names. 
    302302The problem of aging and hence lying comments exists here, too. 
    303303But we also want to create a proper API documentation using Doxygen. 
     
    375375 
    376376The best way to avoid this naming conflict is to access members (variables and methods) using the `this` pointer. 
    377 In addition to solving the shadowing problem shown above, this convention documents the origin of a variable or method for the reader and solves binding problems concerning template programming which strange convetions like adding underscores do not. 
     377In addition to solving the shadowing problem shown above, this convention documents the origin of a variable or method for the reader and solves binding problems concerning template programming which strange conventions like adding underscores do not. 
    378378 
    379379{{{ 
     
    464464 
    465465Therefore do not use std::cout or printf to write text to stdout or stderr. 
    466 Use `RRLIB_LOG_PRINT` or `RRLIB_LOG_PRINTF` or in Finroc `FINROC_LOG_PRINT` or `FINROC_LOG_PRINTF` to crete output with streamin or printf semantic. 
     466Use `RRLIB_LOG_PRINT` or `RRLIB_LOG_PRINTF` or in Finroc `FINROC_LOG_PRINT` or `FINROC_LOG_PRINTF` to create output with streaming or printf semantic.