/**
short description.
Long class documentation.
+ (Hungarian postfix)
*/
class Class {
/** short description.
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
=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
=over 5
+=item C<byte>
+unsigned cher. (The postfix _by is ambiguous)
+
=item C<b>
bool
=item C<test_ch>
Variable Test: a character
-=item C<firstName_str>
+=item C<first_name_str>
Variable first_name: a String class object
=item C<first_name_ch_a>
-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:
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!