[kln2-devel] commenting new source

[Marek W. <Mar...@fu...>]

Hi e-body,

Number of changes made by different people grows (not everything is CVS
yet, though). Some comments to the new source is very, very much needed.

I suggest doxygen format, because I used it already in all other parts of
the code. See how it is done e.g. in src/keypressed.h (you can compare the
source with doxygen/html/classKeyPressDialog.html ).

Basically:
- comments should be placed just _before_ variables/classes
- //! starts a short description
- /*! */ contains a longer description (e.g. usage suggestions).
(note the exclamation mark, which marks comments which should be included
in doxygen docs).

I know, I haven't been careful enough to do this for all my submissions,
but please, try to provide at least short //! descriptions for all new and
changed methods and properties. You have just written the code - it
shouldn't take much time.

~Marek


-- 

     \/   /|\  Marek Wieckowski
  #####  | | |
 = . . =  \|/  Institute of Theoretical Physics
    U      |   Warsaw University
  / ~ \___ |
 <|   |    |
  > . <    |   http://www.fuw.edu.pl/~wiecko
 <<___>>   |   http://klearnnotes2.sourceforge.net