release: 0.0.57

[lilypond.git] / Documentation / CodingStyle.pod

diff --git a/Documentation/CodingStyle.pod b/Documentation/CodingStyle.pod
index 1a4b1263d451181dfad6809235da3e89f3958f51..4592783fb27e713903d68ec48efe45fac0e44b08 100644 (file)
--- a/Documentation/CodingStyle.pod
+++ b/Documentation/CodingStyle.pod
@@ -63,9 +63,11 @@ If you like using font-lock, you can also add this to your F<.emacs>:
 
        (setq font-lock-maximum-decoration t)
        (setq c++-font-lock-keywords-3 
-             (cons
-              '("\\b\\([a-zA-Z_]+_\\)\\b" 1 font-lock-variable-name-face)
-              c++-font-lock-keywords-3))
+             (append
+              c++-font-lock-keywords-3
+              '(("\\b\\([a-zA-Z_]+_\\)\\b" 1 font-lock-variable-name-face)
+              ("\\b\\([A-Z]+[a-z_]+\\)\\b" 1 font-lock-type-face))
+              ))
 
 =head2 CLASSES and TYPES:
 
@@ -80,6 +82,12 @@ If you like using font-lock, you can also add this to your F<.emacs>:
 the C<type> is a Hungarian notation postfix for C<Type>. See below
 
 
+=head2 BROKEN CODE
+
+Broken code (hardwired dependencies, hardwired constants, slow
+algorithms and obvious limitations) should be marked as such:
+either with a verbose TODO, or with a short "ugh" comment.
+
 =head2 COMMENTS
 
 The source is commented in the DOC++ style.  Check out doc++ at
@@ -96,6 +104,8 @@ http://www.zib.de/Visual/software/doc++/index.html
                short description.
                Long class documentation.
                (Hungarian postfix)
+
+               TODO Fix boring_member()
        */
        class Class {
                /**
@@ -114,9 +124,13 @@ http://www.zib.de/Visual/software/doc++/index.html
                Rettype member(Argtype);
 
                /// memo only
-               boring_member();
+               boring_member() {
+                       data_member_ = 121; // ugh
+               }
        };
 
+
+       
 Unfortunately most of the code isn't really documented that good.
 
 
@@ -226,8 +240,7 @@ not very useful if not used consistently
 
 =item *
 
-usefullness in I<very large> 
-(but how many classes is very large?)
+usefullness in I<very large> (but how many classes is very large?)
 remains an issue.
 
 =back