API documentation

Hi Luis!

I generated the API documentation recently and recognized that comments like
/** API comment */
are not recognized by kdoc any more. The API documentation looks quite poor as 
if almost nothing is documented.

If you implement new classes, use comments like
/**
 * API documentation
 */

For methods that only reimplement virtual methods, /** */ can still be used.

I hacked a little script that converts the comments. Yon can use this to fix 
the comments for newly created files.
WARNING: The files to convert are hard coded inside the script (*.h at the 
moment)

I am not sure whether it is better for you to convert the comments in all 
files or not. Imagine I commit the converted files into CVS. How will the CVS 
server handle your files, that contain the same changes but have another 
version and time stamp?
Will your changes to the header files produce conflicts if all headers are 
changed on the server?

Andreas
-- 
--------------------------------------------------
 Andreas Zehender, Dipl. Ing. (BA)
 Student, 10th semester computer science
 http://www.azweb.de
 [email protected] | [email protected]      
--------------------------------------------------

#!/usr/bin/bash
perl -pi -e 's/([\s]*)\/\*\* (.+) \*\//\1\/\*\*\n\1 \* \2\n\1 \*\//' *.h
perl -pi -e 's/([\s]*)\/\*\* ([^*])/\1\/\*\*\n\1 \* \2/' *.h
perl -pi -e 's/([\s]*)(\* .*[\w\.\!\?]) \*\//\1\2\n\1\*\//' *.h