[sword-svn] r2206 - trunk/include

[scribe at www.crosswire.org]

Author: scribe
Date: 2008-09-23 16:20:51 -0700 (Tue, 23 Sep 2008)
New Revision: 2206

Modified:
   trunk/include/swmodule.h
   trunk/include/treekey.h
   trunk/include/versekey.h
   trunk/include/versetreekey.h
Log:
updated docs from ghellings


Modified: trunk/include/swmodule.h
===================================================================
--- trunk/include/swmodule.h	2008-09-22 01:51:19 UTC (rev 2205)
+++ trunk/include/swmodule.h	2008-09-23 23:20:51 UTC (rev 2206)
@@ -450,7 +450,7 @@
 	/** Adds a RenderFilter to this module's renderFilters queue.
 	 *	Render Filters are called when the module is asked to produce
 	 *	renderable text.
-	 * @param newFilter the filter to add
+	 * @param newfilter the filter to add
 	 * @return *this
 	 */
 	virtual SWModule &AddRenderFilter(SWFilter *newfilter) {

Modified: trunk/include/treekey.h
===================================================================
--- trunk/include/treekey.h	2008-09-22 01:51:19 UTC (rev 2205)
+++ trunk/include/treekey.h	2008-09-23 23:20:51 UTC (rev 2206)
@@ -128,7 +128,7 @@
 
 	/** Set the key to this path.  If the path doesn't exist, then
 	 *	nodes are created as necessary
-	 * @keyPath = path to set/create; if unsupplied, then use any unsnapped setText value.
+	 * @param keyPath path to set/create; if unsupplied, then use any unsnapped setText value.
 	 */
 	virtual void assureKeyPath(const char *keyPath = 0);
 	virtual void save() {}

Modified: trunk/include/versekey.h
===================================================================
--- trunk/include/versekey.h	2008-09-22 01:51:19 UTC (rev 2205)
+++ trunk/include/versekey.h	2008-09-23 23:20:51 UTC (rev 2206)
@@ -186,7 +186,7 @@
 	/** sets the lower boundary for this	VerseKey
 	* and returns the new boundary
 	*
-	* @param lb the new lower boundary for this	VerseKey
+	* @param ub the new upper boundary for this	VerseKey
 	* @return the lower boundary the key was set to
 	*/
 	VerseKey &LowerBound(const VerseKey &ub);

Modified: trunk/include/versetreekey.h
===================================================================
--- trunk/include/versetreekey.h	2008-09-22 01:51:19 UTC (rev 2205)
+++ trunk/include/versetreekey.h	2008-09-23 23:20:51 UTC (rev 2206)
@@ -54,6 +54,7 @@
 	/**
 	* VerseKey Constructor - initializes Instance of VerseKey
 	*
+	* @param treeKey a TreeKey which will form the basis of this VerseTreeKey
 	* @param ikey text key (will take various forms of 'BOOK CH:VS'.
 	* See parse() for more detailed information)
 	*/
@@ -62,6 +63,7 @@
 	/**
 	* VerseKey Constructor - initializes instance of VerseKey
 	*
+	* @param treeKey a TreeKey which will form the basis of this VerseTreeKey
 	* @param ikey base key (will take various forms of 'BOOK CH:VS'.
 	*	See parse() for more detailed information)
 	*/	
@@ -70,6 +72,7 @@
 	/** VerseKey Constructor - initializes instance of VerseKey
 	* with boundariess - see also LowerBound()
 	* and UpperBound()
+	* @param treeKey a TreeKey which will form the basis of this VerseTreeKey
 	* @param min the lower boundary of the new	VerseKey
 	* @param max the upper boundary of the new	VerseKey
 	*/