[sword-cvs] sword/include utf8transliterator.h,1.21,1.22

[sword@www.crosswire.org]

Update of /usr/local/cvsroot/sword/include
In directory www:/tmp/cvs-serv9573/include

Modified Files:
	utf8transliterator.h 
Log Message:
changed comment to javadoc-style
Chris, if possible please add more documentation so
that developers can more easily use this class

Index: utf8transliterator.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/utf8transliterator.h,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -d -r1.21 -r1.22
--- utf8transliterator.h	26 Sep 2003 20:19:37 -0000	1.21
+++ utf8transliterator.h	5 Oct 2003 19:07:35 -0000	1.22
@@ -44,7 +44,12 @@
 typedef std::map <const UnicodeString, SWTransData> SWTransMap;
 typedef std::pair<UnicodeString, SWTransData> SWTransPair;
 
-// This Filter uses ICU for transliteration
+// Chris, please add more javadoc-style documentation in this header file
+// so that the information will show up in the doxygen-generated
+// api-docs.
+
+/** This Filter uses ICU for transliteration
+*/
 class SWDLLEXPORT UTF8Transliterator : public SWFilter {
 private: