CodingStyle

   1 CODING STANDARDS:
   2
   3 Functions and methods do not return errorcodes, but use assert for
   4 checking status.
   5
   6 INDENTATION, in emacs:
   7
   8
   9 (add-hook 'c-mode-hook
  10           '(lambda ()(setq c-basic-offset 4)))
  11
  12
  13 (add-hook 'c++-mode-hook
  14           '(lambda() (c-set-style "Stroustrup")
  15              )
  16           )
  17
  18
  19 CLASSES and TYPES:
  20
  21         This_is_a_class
  22
  23 DATA MEMBERS
  24
  25         Class:member
  26
  27 if the member's name resembles its type, then we use
  28
  29         Class Fubular { ..}
  30
  31         Class::fubular_
  32
  33 COMMENTS
  34
  35 /// short description
  36 class Class {
  37         ///
  38         Data data_member_;
  39         /**
  40                 ..
  41         */
  42
  43         /****************/
  44
  45         /// short memo
  46         member();
  47         /**
  48                 long doco of member()
  49         */
  50 };
  51 /**
  52         Class documentation.
  53 */
  54
  55 Unfortunately most of the code isn't really documented that good.