diff options
Diffstat (limited to 'Documentation/CodingStyle')
-rw-r--r-- | Documentation/CodingStyle | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle new file mode 100644 index 0000000000..c5d730c0a6 --- /dev/null +++ b/Documentation/CodingStyle @@ -0,0 +1,55 @@ +CODING STANDARDS: + +Functions and methods do not return errorcodes, but use assert for +checking status. + +INDENTATION, in emacs: + + +(add-hook 'c-mode-hook + '(lambda ()(setq c-basic-offset 4))) + + +(add-hook 'c++-mode-hook + '(lambda() (c-set-style "Stroustrup") + ) + ) + + +CLASSES and TYPES: + + This_is_a_class + +DATA MEMBERS + + Class:member + +if the member's name resembles its type, then we use + + Class Fubular { ..} + + Class::fubular_ + +COMMENTS + +/// short description +class Class { + /// + Data data_member_; + /** + .. + */ + + /****************/ + + /// short memo + member(); + /** + long doco of member() + */ +}; +/** + Class documentation. +*/ + +Unfortunately most of the code isn't really documented that good.
\ No newline at end of file |