[sword-cvs] sword/include gbfredletterwords.h,1.4,1.5 swbuf.h,1.30,1.31 swmodule.h,1.71,1.72

[sword@www.crosswire.org]

Update of /cvs/core/sword/include
In directory www:/tmp/cvs-serv21494/include

Modified Files:
	gbfredletterwords.h swbuf.h swmodule.h 
Log Message:
apidoc updates

Index: gbfredletterwords.h
===================================================================
RCS file: /cvs/core/sword/include/gbfredletterwords.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- gbfredletterwords.h	5 Jul 2003 04:58:42 -0000	1.4
+++ gbfredletterwords.h	27 Mar 2004 09:24:35 -0000	1.5
@@ -33,7 +33,7 @@
 public:
 	GBFRedLetterWords();
 	virtual ~GBFRedLetterWords();
-	virtual char processText(SWBuf &text, const SWKey *key = 0, const SWModule * = 0);
+	virtual char processText(SWBuf &text, const SWKey *key = 0, const SWModule *module = 0);
 };
 
 SWORD_NAMESPACE_END

Index: swbuf.h
===================================================================
RCS file: /cvs/core/sword/include/swbuf.h,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -d -r1.30 -r1.31
--- swbuf.h	14 Mar 2004 03:39:54 -0000	1.30
+++ swbuf.h	27 Mar 2004 09:24:35 -0000	1.31
@@ -182,6 +182,8 @@
 	/** 
 	* SWBuf::insert - inserts the given string at position into this string
 	* @param pos The position where to insert. pos=0 inserts at the beginning, pos=1 after the first char, etc. Using pos=length() is the same as calling append(s)
+	* @param str Append this.
+	* @param max Append only max chars.
 	*/
 	void insert(const unsigned long pos, const char* str, const signed long max = -1 );
 	void insert(const unsigned long pos, const SWBuf &str, const signed long max = -1 ) {

Index: swmodule.h
===================================================================
RCS file: /cvs/core/sword/include/swmodule.h,v
retrieving revision 1.71
retrieving revision 1.72
diff -u -d -r1.71 -r1.72
--- swmodule.h	28 Feb 2004 20:14:29 -0000	1.71
+++ swmodule.h	27 Mar 2004 09:24:35 -0000	1.72
@@ -257,26 +257,38 @@
 	}
 
 
-	/** Sets/gets module name
+	/** Gets module name
 	*
-	* @param imodname Value which to set modname; [0]-only get
 	* @return pointer to modname
 	*/
 	virtual char *Name() const;
+	/** Sets module name
+	*
+	* @param imodname Value which to set modname; [0]-only get
+	* @return pointer to modname
+	*/
 	virtual char *Name(const char *imodname);
-	/** Sets/gets module description
+	/** Gets module description
 	*
-	* @param imoddesc Value which to set moddesc; [0]-only get
 	* @return pointer to moddesc
 	*/
 	virtual char *Description() const;
+	/** Sets module description
+	*
+	* @param imoddesc Value which to set moddesc; [0]-only get
+	* @return pointer to moddesc
+	*/
 	virtual char *Description(const char *imoddesc);
-	/** Sets/gets module type
+	/** Gets module type
 	*
-	* @param imodtype Value which to set modtype; [0]-only get
 	* @return pointer to modtype
 	*/
 	virtual char *Type() const;
+	/** Sets module type
+	*
+	* @param imodtype Value which to set modtype; [0]-only get
+	* @return pointer to modtype
+	*/
 	virtual char *Type(const char *imodtype);
 	/** Sets/gets module direction
 	*