[sword-devel] doc

Martin Gruner sword-devel@crosswire.org
Tue, 22 May 2001 22:52:41 +0200


I just saw that there is a new unicode to rtf filter in cvs.
May I encourage you to comment the header files instead of the source files?

The JavaDoc style header comments are used for the api doc which is 
automatically generated by doxygen. It will be helpfule for people who are 
learning the api.

At the moment unicodertf.h says:  

/** This filter converts GBF text into plain text  */
class SWDLLEXPORT UnicodeRTF:public SWFilter {

which is not quite correct. The source file contains the correct version. 
Please get used to at least copy the comment from the source file(s) you 
create to the corresponding header files.

Thank you.