]> git.lyx.org Git - lyx.git/blob - sigc++/doc/conventions
export patch from Dekel
[lyx.git] / sigc++ / doc / conventions
1 Okay here are the conventions for this project.
2
3 macros   - all caps (MY_MACRO)
4 enum     - same as macros
5
6 classes  - cap each word lower others (Signal)
7 private classes - same as class with underscore or trailing _ (BasicSignal_Impl)
8
9 function - lowercase with underscore (foo_bar())
10 methods  - lowercase with underscore (m.foo_bar())
11 data     - lowercase (m.mydata)
12 private data - lowercase with trailing underscore (m.mydata_)
13
14
15 Namespaces are used where possible.  
16 If namespaces are not available use a class to fake it unless
17 that is not allowed.
18
19 Format is GNU or modified GNU (indent first bracket)
20
21 class MyClass
22   { 
23     MyClass();
24   } 
25