[sword-svn] r1726 - trunk/include

[mgruner at crosswire.org]

Author: mgruner
Date: 2005-02-23 06:11:41 -0700 (Wed, 23 Feb 2005)
New Revision: 1726

Modified:
   trunk/include/stringmgr.h
   trunk/include/swfilter.h
   trunk/include/swkey.h
Log:
small JavaDoc additions for 1.5.8


Modified: trunk/include/stringmgr.h
===================================================================
--- trunk/include/stringmgr.h	2005-02-22 01:58:29 UTC (rev 1725)
+++ trunk/include/stringmgr.h	2005-02-23 13:11:41 UTC (rev 1726)
@@ -41,7 +41,7 @@
 	* @return The global string handle
 	*/
 	static StringMgr* getSystemStringMgr();
-	/* Checks whether Utf8 support is available.
+	/** Checks whether Utf8 support is available.
 	* Override the function supportsUnicode() to tell whether your implementation has utf8 support.
 	* @return True if this implementation provides support for Utf8 handling or false if just latin1 handling is available
 	*/
@@ -50,13 +50,14 @@
 	};
 	
 	/** Converts the param to an upper case Utf8 string
-	* @param The text encoded in utf8 which should be turned into an upper case string
+	* @param text The text encoded in utf8 which should be turned into an upper case string
+	* @param max Only change max chars
 	*/	
-	virtual char* upperUTF8(char*, const unsigned int max = 0);
+	virtual char* upperUTF8(char* text, const unsigned int max = 0);
 	/** Converts the param to an uppercase latin1 string
-	* @param The text encoded in latin1 which should be turned into an upper case string
+	* @param text The text encoded in latin1 which should be turned into an upper case string
 	*/	
-	virtual char* upperLatin1(char*);
+	virtual char* upperLatin1(char* text);
 	
 
 protected:

Modified: trunk/include/swfilter.h
===================================================================
--- trunk/include/swfilter.h	2005-02-22 01:58:29 UTC (rev 1725)
+++ trunk/include/swfilter.h	2005-02-23 13:11:41 UTC (rev 1726)
@@ -73,9 +73,9 @@
 	 * e.g maybe a strong's filter mioght be set to "on" / "off" -
 	 * that would mean to show or not to show the strongs in the text,
 	 * see also getOptionValues()
-	 * @param ival the new option valus
+	 * @param ival the new option value
 	 */
-	virtual void setOptionValue (const char */*ival*/) { }
+	virtual void setOptionValue (const char * ival) { }
 
 	/** This is the main filter function
 	 * @param text The text to be filtered/converted

Modified: trunk/include/swkey.h
===================================================================
--- trunk/include/swkey.h	2005-02-22 01:58:29 UTC (rev 1725)
+++ trunk/include/swkey.h	2005-02-23 13:11:41 UTC (rev 1726)
@@ -188,7 +188,7 @@
 
 	virtual bool isTraversable() { return false; }
 
-	/** Use this function to get te current position withing a module.
+	/** Use this function to get te current position within a module.
 	* Here's a small example how to use this function and @ref Index(long).
 	* This function uses the GerLut module and chooses a random verse from the
 	* Bible and returns it.
@@ -209,8 +209,9 @@
 	*   return text;
 	* @endcode
 	*/
-
 	virtual long Index() const { return index; }
+	/** See documentation for @ref Index()
+	*/
 	virtual long Index(long iindex) { index = iindex; return index; }
 
 	SWKEY_OPERATORS