From: fred Date: Sun, 24 Mar 2002 19:32:38 +0000 (+0000) Subject: lilypond-0.0.33 X-Git-Tag: release/1.5.59~5339 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=c318e0846dd57cf25e989fd433a5d73b3906e00f;p=lilypond.git lilypond-0.0.33 --- diff --git a/Documentation/CodingStyle.pod b/Documentation/CodingStyle.pod index fdbab0668b..02b580c602 100644 --- a/Documentation/CodingStyle.pod +++ b/Documentation/CodingStyle.pod @@ -45,6 +45,7 @@ http://www.zib.de/Visual/software/doc++/index.html /** short description. Long class documentation. + (Hungarian postfix) */ class Class { /** short description. @@ -89,9 +90,9 @@ Standard methods: void print() const /** - protected member. Usually invoked by non-virtual A_virtual_func() + protected member. Usually invoked by non-virtual XXXX() */ - virtual do_A_virtual_func() + virtual do_XXXX() /**add some data to *this. Presence of these methods usually imply that it is not feasible to this @@ -109,22 +110,17 @@ Notation>. =head2 Hungarian -The Hungarian Notation was conceived by -or at least got its name from, -the hungarian programmer x. -It is a naming convention with the aim -to make code more readable (for fellow programmers) -and more accessible for programmers -that are new to a project. - -The essence of the Hungarian Notation -is that every identifier has a part -which identifies its type -(for functions this is the result type). -This is particularly useful in object oriented programming, -where a particular object implies a specific interface -(a set of member functions, perhaps some redefined operators), -and for accounting heap allocated memory pointers and links. +The Hungarian Notation was conceived by or at least got its name from, +the hungarian programmer x. It is a naming convention with the aim to +make code more readable (for fellow programmers) and more accessible +for programmers that are new to a project. + +The essence of the Hungarian Notation is that every identifier has a +part which identifies its type (for functions this is the result +type). This is particularly useful in object oriented programming, +where a particular object implies a specific interface (a set of +member functions, perhaps some redefined operators), and for +accounting heap allocated memory pointers and links. =head2 Advantages @@ -203,6 +199,9 @@ with the parts of the names separated by underscores. =over 5 +=item C +unsigned cher. (The postfix _by is ambiguous) + =item C bool @@ -276,7 +275,7 @@ Temporary variable: an unsigned integer =item C Variable Test: a character -=item C +=item C Variable first_name: a String class object =item C diff --git a/README b/README index 8c2b831b5a..83f807a7a0 100644 --- a/README +++ b/README @@ -1,11 +1,14 @@ -IMPORTANT: if you have downloaded a +IMPORTANT: + +if you have downloaded a *.pre* version, then this is version is *not* meant for producing nice output -(but to keep your patchsets up to date) +(but to keep your patchsets up to date). It might not even compile. ==================== + Please refer to the directory Documentation/, Documentation/README.* To generate the pretty-printed docs, do this: @@ -21,8 +24,9 @@ NOTE: LilyPond is a long way from finished and polished. I do appreciate criticism, comments, bugreports, patches, etc. Please send e-mail to +me, - hanwen@stack.urc.tue.nl + hanwen@stack.nl Have fun!