]> git.donarmstrong.com Git - lilypond.git/commitdiff
lilypond-0.0.8
authorfred <fred>
Sat, 2 Nov 1996 01:33:50 +0000 (01:33 +0000)
committerfred <fred>
Sat, 2 Nov 1996 01:33:50 +0000 (01:33 +0000)
Documentation/CodingStyle [new file with mode: 0644]

diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
new file mode 100644 (file)
index 0000000..c5d730c
--- /dev/null
@@ -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