[sword-cvs] sword/include encfiltmgr.h,1.2,1.3 listkey.h,1.17,1.18 localemgr.h,1.13,1.14 markupfiltmgr.h,1.3,1.4 swbuf.h,1.9,1.10 swcom.h,1.12,1.13 swconfig.h,1.20,1.21 swgenbook.h,1.3,1.4 swkey.h,1.23,1.24 swld.h,1.13,1.14 swmgr.h,1.52,1.53 swmodule.h,1.60,1.61 swtext.h,1.13,1.14 versekey.h,1.28,1.29
sword@www.crosswire.org
sword@www.crosswire.org
Fri, 28 Feb 2003 06:12:45 -0700
Update of /usr/local/cvsroot/sword/include
In directory www:/tmp/cvs-serv420/include
Modified Files:
encfiltmgr.h listkey.h localemgr.h markupfiltmgr.h swbuf.h
swcom.h swconfig.h swgenbook.h swkey.h swld.h swmgr.h
swmodule.h swtext.h versekey.h
Log Message:
updates to the api-documentation; doc syntax errors fixed. minor
additions to the docs.
Index: encfiltmgr.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/encfiltmgr.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** encfiltmgr.h 1 Oct 2002 19:52:40 -0000 1.2
--- encfiltmgr.h 28 Feb 2003 13:12:43 -0000 1.3
***************
*** 27,31 ****
SWORD_NAMESPACE_START
! /** This class is like a normal @ref SWMgr,
* but you can additonally specify which encoding
* you want to use.
--- 27,31 ----
SWORD_NAMESPACE_START
! /** This class is like a normal SWMgr,
* but you can additonally specify which encoding
* you want to use.
***************
*** 50,56 ****
/** Constructor of SWEncodingMgr.
*
- * @param iconfig
- * @param isysconfig
- * @param autoload If this bool is true the constructor starts loading the installed modules. If you reimplemented SWMgr you can set autoload=false to load the modules with your own reimplemented function.
* @param encoding The desired encoding.
*/
--- 50,53 ----
***************
*** 64,68 ****
/** Markup sets/gets the encoding after initialization
*
! * @param m The new encoding or ENC_UNKNOWN if you just want to get the current markup.
* @return The current (possibly changed) encoding format.
*/
--- 61,65 ----
/** Markup sets/gets the encoding after initialization
*
! * @param enc The new encoding or ENC_UNKNOWN if you just want to get the current markup.
* @return The current (possibly changed) encoding format.
*/
Index: listkey.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/listkey.h,v
retrieving revision 1.17
retrieving revision 1.18
diff -C2 -d -r1.17 -r1.18
*** listkey.h 21 Oct 2002 22:48:24 -0000 1.17
--- listkey.h 28 Feb 2003 13:12:43 -0000 1.18
***************
*** 94,101 ****
/** Positions this key
*
! * @param p position
* @return *this
*/
! virtual void setPosition(SW_POSITION);
/** Decrements a number of elements
*/
--- 94,101 ----
/** Positions this key
*
! * @param pos position
* @return *this
*/
! virtual void setPosition(SW_POSITION pos);
/** Decrements a number of elements
*/
Index: localemgr.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/localemgr.h,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -d -r1.13 -r1.14
*** localemgr.h 16 Feb 2003 02:43:13 -0000 1.13
--- localemgr.h 28 Feb 2003 13:12:43 -0000 1.14
***************
*** 77,81 ****
/** Get the list of available locales.
*
! * @ret Returns a list of strings, which contains the names of the available locales.
*/
virtual std::list < std::string > getAvailableLocales ();
--- 77,81 ----
/** Get the list of available locales.
*
! * @return Returns a list of strings, which contains the names of the available locales.
*/
virtual std::list < std::string > getAvailableLocales ();
***************
*** 84,88 ****
* This function uses both parameters to return the translated version of the given text.
*
! * @param The text to translate into the language given by the first parameter.
* @param localeName The name of the locale Sword should use
* @return Returns the translated text.
--- 84,88 ----
* This function uses both parameters to return the translated version of the given text.
*
! * @param text The text to translate into the language given by the first parameter.
* @param localeName The name of the locale Sword should use
* @return Returns the translated text.
***************
*** 92,96 ****
/** Get the default locale name. To set it use @see setDefaultLocaleName
*
! * @ret Returns the default locale name
*/
virtual const char *getDefaultLocaleName ();
--- 92,96 ----
/** Get the default locale name. To set it use @see setDefaultLocaleName
*
! * @return Returns the default locale name
*/
virtual const char *getDefaultLocaleName ();
Index: markupfiltmgr.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/markupfiltmgr.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** markupfiltmgr.h 1 Oct 2002 19:52:40 -0000 1.3
--- markupfiltmgr.h 28 Feb 2003 13:12:43 -0000 1.4
***************
*** 27,34 ****
SWORD_NAMESPACE_START
! /** This class is like a normal @ref SWEncodingMgr,
! * but you can additonally specify which markup
! * you want to use.
! */
class SWDLLEXPORT MarkupFilterMgr : public EncodingFilterMgr {
protected:
--- 27,34 ----
SWORD_NAMESPACE_START
! /** This class is like a normal SWEncodingMgr,
! * but you can additonally specify which markup
! * you want to use.
! */
class SWDLLEXPORT MarkupFilterMgr : public EncodingFilterMgr {
protected:
***************
*** 38,44 ****
SWFilter* fromosis;
! /*
! * current markup value
! */
char markup;
--- 38,44 ----
SWFilter* fromosis;
! /**
! * current markup value
! */
char markup;
***************
*** 47,53 ****
/** Constructor of SWMarkupMgr.
*
- * @param iconfig
- * @param isysconfig
- * @param autoload If this bool is true the constructor starts loading the installed modules. If you reimplemented SWMgr you can set autoload=false to load the modules with your own reimplemented function.
* @param encoding The desired encoding.
* @param markup The desired markup format.
--- 47,50 ----
Index: swbuf.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/swbuf.h,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -d -r1.9 -r1.10
*** swbuf.h 27 Feb 2003 23:57:55 -0000 1.9
--- swbuf.h 28 Feb 2003 13:12:43 -0000 1.10
***************
*** 53,57 ****
public:
! /******************************************************************************
* SWBuf Constructor - Creates an empty SWBuf object or an SWBuf initialized
* to a value from a const char *
--- 53,57 ----
public:
! /**
* SWBuf Constructor - Creates an empty SWBuf object or an SWBuf initialized
* to a value from a const char *
***************
*** 60,64 ****
SWBuf(const char *initVal = 0);
! /******************************************************************************
* SWBuf Constructor - Creates an SWBuf initialized
* to a value from a char
--- 60,64 ----
SWBuf(const char *initVal = 0);
! /**
* SWBuf Constructor - Creates an SWBuf initialized
* to a value from a char
***************
*** 67,71 ****
SWBuf(char initVal);
! /******************************************************************************
* SWBuf Constructor - Creates an SWBuf initialized
* to a value from another SWBuf
--- 67,71 ----
SWBuf(char initVal);
! /**
* SWBuf Constructor - Creates an SWBuf initialized
* to a value from another SWBuf
***************
*** 77,81 ****
inline char getFillByte() { return fillByte; }
! /******************************************************************************
* SWBuf Destructor - Cleans up instance of SWBuf
*/
--- 77,81 ----
inline char getFillByte() { return fillByte; }
! /**
* SWBuf Destructor - Cleans up instance of SWBuf
*/
***************
*** 88,92 ****
/**
! *
*/
inline char &charAt(unsigned int pos) { return ((pos <= (unsigned int)(end - buf)) ? buf[pos] : nullStr[0]); }
--- 88,93 ----
/**
! * @param pos The position of the requested character.
! * @return The character at the specified position
*/
inline char &charAt(unsigned int pos) { return ((pos <= (unsigned int)(end - buf)) ? buf[pos] : nullStr[0]); }
***************
*** 104,134 ****
inline unsigned int length() const { return end - buf; }
! /******************************************************************************
! * SWBuf::set - sets this buf to a new value
*/
void set(const char *newVal);
! /******************************************************************************
* SWBuf::set - sets this buf to a new value
*/
void set(const SWBuf &newVal);
! /******************************************************************************
! * SWBuf::setSize - Size this buffer to a specific length
*/
void setSize(unsigned int len);
! /******************************************************************************
! * SWBuf::append - appends a value to the current value of this SWBuf
*/
void append(const char *str);
! /******************************************************************************
* SWBuf::append - appends a value to the current value of this SWBuf
*/
void append(const SWBuf &str);
! /******************************************************************************
* SWBuf::append - appends a value to the current value of this SWBuf
*/
inline void append(char ch) {
--- 105,146 ----
inline unsigned int length() const { return end - buf; }
! /**
! * SWBuf::set - sets this buf to a new value.
! * If the allocated memory is bigger than the new string, it will NOT be resized.
! * @param newVal the value to set this buffer to.
*/
void set(const char *newVal);
! /**
* SWBuf::set - sets this buf to a new value
+ * If the allocated memory is bigger than the new string, it will NOT be resized.
+ * @param newVal the value to set this buffer to.
*/
void set(const SWBuf &newVal);
! /**
! * SWBuf::setSize - Size this buffer to a specific length.
! * @param len The new size of the buffer. One byte for the null will be added.
*/
void setSize(unsigned int len);
! /**
! * SWBuf::append - appends a value to the current value of this SWBuf.
! * If the allocated memory is not enough, it will be resized accordingly.
! * @param str Append this.
*/
void append(const char *str);
! /**
* SWBuf::append - appends a value to the current value of this SWBuf
+ * If the allocated memory is not enough, it will be resized accordingly.
+ * @param str Append this.
*/
void append(const SWBuf &str);
! /**
* SWBuf::append - appends a value to the current value of this SWBuf
+ * If the allocated memory is not enough, it will be resized accordingly.
+ * @param ch Append this.
*/
inline void append(char ch) {
***************
*** 139,146 ****
}
! /******************************************************************************
* SWBuf::appendFormatted - appends formatted strings to the current value of this SWBuf
* WARNING: This function can only write at most
* JUNKBUFSIZE to the string per call.
*/
void appendFormatted(const char *format, ...);
--- 151,160 ----
}
! /**
* SWBuf::appendFormatted - appends formatted strings to the current value of this SWBuf
* WARNING: This function can only write at most
* JUNKBUFSIZE to the string per call.
+ * @param format The format string. Same syntax as printf, for example.
+ * @param ... Add all arguments here.
*/
void appendFormatted(const char *format, ...);
Index: swcom.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/swcom.h,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -d -r1.12 -r1.13
*** swcom.h 1 Oct 2002 19:52:40 -0000 1.12
--- swcom.h 28 Feb 2003 13:12:43 -0000 1.13
***************
*** 37,44 ****
/** Initializes data for instance of SWCom
- *
- * @param imodname Internal name for module
- * @param imoddesc Name to display to user for module
- * @param idisp Display object to use for displaying
*/
SWCom(const char *imodname = 0, const char *imoddesc = 0,
--- 37,40 ----
Index: swconfig.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/swconfig.h,v
retrieving revision 1.20
retrieving revision 1.21
diff -C2 -d -r1.20 -r1.21
*** swconfig.h 1 Oct 2002 22:04:58 -0000 1.20
--- swconfig.h 28 Feb 2003 13:12:43 -0000 1.21
***************
*** 71,75 ****
/** Merges the values of addFrom
! * @param The config which values should be merged to this config object. Already existing values will be overwritten.
*/
virtual void augment(SWConfig &addFrom);
--- 71,75 ----
/** Merges the values of addFrom
! * @param addFrom The config which values should be merged to this config object. Already existing values will be overwritten.
*/
virtual void augment(SWConfig &addFrom);
Index: swgenbook.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/swgenbook.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** swgenbook.h 1 Oct 2002 19:52:40 -0000 1.3
--- swgenbook.h 28 Feb 2003 13:12:43 -0000 1.4
***************
*** 41,48 ****
public:
/** Initializes data for instance of SWLD
- *
- * @param imodname Internal name for module
- * @param imoddesc Name to display to user for module
- * @param idisp Display object to use for displaying
*/
SWGenBook(const char *imodname = 0, const char *imoddesc = 0,
--- 41,44 ----
Index: swkey.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/swkey.h,v
retrieving revision 1.23
retrieving revision 1.24
diff -C2 -d -r1.23 -r1.24
*** swkey.h 1 Oct 2002 19:52:40 -0000 1.23
--- swkey.h 28 Feb 2003 13:12:43 -0000 1.24
***************
*** 88,97 ****
/** initializes instance of SWKey
*
! * @param ikey text key
*/
SWKey(const char *ikey = 0);
/** Copy Constructor
! * @param The SWKey object to copy.
*/
SWKey(SWKey const &k);
--- 88,97 ----
/** initializes instance of SWKey
*
! * @param ikey Initialize from text key.
*/
SWKey(const char *ikey = 0);
/** Copy Constructor
! * @param k The SWKey object to copy.
*/
SWKey(SWKey const &k);
***************
*** 123,127 ****
* @return value of persist
*/
! char Persist(signed char ikey);
/** Gets and clears error status
--- 123,127 ----
* @return value of persist
*/
! char Persist(signed char ipersist);
/** Gets and clears error status
***************
*** 177,181 ****
/** Increments key a number of entries
*
! * @param increment Number of entries to jump forward
* @return *this
*/
--- 177,181 ----
/** Increments key a number of entries
*
! * @param steps Number of entries to jump forward
* @return *this
*/
Index: swld.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/swld.h,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -d -r1.13 -r1.14
*** swld.h 1 Oct 2002 19:52:40 -0000 1.13
--- swld.h 28 Feb 2003 13:12:43 -0000 1.14
***************
*** 39,46 ****
public:
/** Initializes data for instance of SWLD
- *
- * @param imodname Internal name for module
- * @param imoddesc Name to display to user for module
- * @param idisp Display object to use for displaying
*/
SWLD(const char *imodname = 0, const char *imoddesc = 0,
--- 39,42 ----
Index: swmgr.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/swmgr.h,v
retrieving revision 1.52
retrieving revision 1.53
diff -C2 -d -r1.52 -r1.53
*** swmgr.h 20 Feb 2003 07:25:20 -0000 1.52
--- swmgr.h 28 Feb 2003 13:12:43 -0000 1.53
***************
*** 200,203 ****
--- 200,204 ----
/**
*
+ * @param iConfigPath Path to config files.
* @param autoload If this bool is true the constructor starts loading the
* installed modules. If you reimplemented SWMgr you can set autoload=false
***************
*** 232,236 ****
virtual void setGlobalOption(const char *option, const char *value);
/** Gives the value of the given option
! * @param The option, which should be used to return the value of it
* @return The value of the given option
*/
--- 233,237 ----
virtual void setGlobalOption(const char *option, const char *value);
/** Gives the value of the given option
! * @param option The option, which should be used to return the value of it
* @return The value of the given option
*/
***************
*** 289,293 ****
*
* @param modName For this module we change the unlockKey
! * @paran key This is the new unlck key we use for te module.
*/
virtual signed char setCipherKey(const char *modName, const char *key);
--- 290,294 ----
*
* @param modName For this module we change the unlockKey
! * @param key This is the new unlck key we use for te module.
*/
virtual signed char setCipherKey(const char *modName, const char *key);
Index: swmodule.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/swmodule.h,v
retrieving revision 1.60
retrieving revision 1.61
diff -C2 -d -r1.60 -r1.61
*** swmodule.h 27 Feb 2003 08:17:05 -0000 1.60
--- swmodule.h 28 Feb 2003 13:12:43 -0000 1.61
***************
*** 138,146 ****
* This function is a placeholder and does nothing.
* You can define your own function for search progress
! * evaluation, and pass it over to @ref Search.
*/
static void nullPercent(char percent, void *userData);
/**
! * Set this bool to false to terminate the search which is executed by this module (@ref #Search).
* This is useful for threaded applications to terminate the search in another thread.
*/
--- 138,146 ----
* This function is a placeholder and does nothing.
* You can define your own function for search progress
! * evaluation, and pass it over to Search().
*/
static void nullPercent(char percent, void *userData);
/**
! * Set this bool to false to terminate the search which is executed by this module (Search()).
* This is useful for threaded applications to terminate the search in another thread.
*/
***************
*** 148,160 ****
/** Initializes data for instance of SWModule
*
! * @param imodname Internal name for module; see also @ref Name
! * @param imoddesc Name to display to user for module;
! * see also @ref Description
! * @param idisp Display object to use for displaying
! * see also @ref Disp
! * @param imodtype Type of Module
! * (All modules will be displayed with
! * others of same type under their modtype heading)
! * see also @ref Type
*/
SWModule(const char *imodname = 0, const char *imoddesc = 0, SWDisplay * idisp = 0, char *imodtype = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, const char* modlang = 0);
--- 148,159 ----
/** Initializes data for instance of SWModule
*
! * @param imodname Internal name for module; see also Name().
! * @param imoddesc Name to display to user for module; see also Description()
! * @param idisp Display object to use for displaying; see also Disp()
! * @param imodtype Type of Module (All modules will be displayed with others of same type under their modtype heading); see also Type()
! * @param encoding Encoding of the module.
! * @param dir Direction of text flow.
! * @param markup Markup of the module.
! * @param modlang Language of the module.
*/
SWModule(const char *imodname = 0, const char *imoddesc = 0, SWDisplay * idisp = 0, char *imodtype = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, const char* modlang = 0);
***************
*** 274,294 ****
* @param newdir value which to set direction;
* [-1] - only get
! * @return char direction
*/
virtual char Direction(signed char newdir = -1);
/** Sets/gets module encoding
*
! * @param newdir value which to set encoding;
* [-1] - only get
! * @return char encoding
*/
virtual char Encoding(signed char enc = -1);
/** Sets/gets module markup
*
! * @param newdir value which to set markup;
* [-1] - only get
! * @return char markup
*/
! virtual char Markup(signed char enc = -1);
/** Sets/gets module language
*
--- 273,293 ----
* @param newdir value which to set direction;
* [-1] - only get
! * @return new direction
*/
virtual char Direction(signed char newdir = -1);
/** Sets/gets module encoding
*
! * @param enc value which to set encoding;
* [-1] - only get
! * @return Encoding
*/
virtual char Encoding(signed char enc = -1);
/** Sets/gets module markup
*
! * @param markup value which to set markup;
* [-1] - only get
! * @return char Markup
*/
! virtual char Markup(signed char markup = -1);
/** Sets/gets module language
*
***************
*** 307,312 ****
--- 306,314 ----
* <=0 ->regex; 1->phrase; 2->multiword;
* @param flags options flags for search
+ * @param scope Key containing the scope. VerseKey or ListKey are useful here.
* @param justCheckIfSupported if set, don't search,
* only tell if this function supports requested search.
+ * @param percent Callback function to get the current search status in %.
+ * @param percentUserData User data that is given to the callback function as parameter.
*
* @return listkey set to verses that contain istr
***************
*** 363,377 ****
* @return error
*/
! static signed char createModule(const char *) { return -1; }
/** Modify the current module entry text
! * - only if module @ref isWritable
* @return *this
*/
virtual void setEntry(const char *inbuf, long len = -1) { }
/** Link the current module entry to another module entry
! * - only if module @ref isWritable
*/
virtual void linkEntry(const SWKey *sourceKey) { }
! /** Delete current module entry - only if module @ref isWritable
*
*/
--- 365,379 ----
* @return error
*/
! static signed char createModule(const char *path) { return -1; }
/** Modify the current module entry text
! * - only if module isWritable()
* @return *this
*/
virtual void setEntry(const char *inbuf, long len = -1) { }
/** Link the current module entry to another module entry
! * - only if module isWritable()
*/
virtual void linkEntry(const SWKey *sourceKey) { }
! /** Delete current module entry - only if module isWritable()
*
*/
***************
*** 382,386 ****
/** Decrements module key a number of entries
*
! * @param decrement Number of entries to jump backward
* @return *this
*/
--- 384,388 ----
/** Decrements module key a number of entries
*
! * @param steps Number of entries to jump backward
* @return *this
*/
***************
*** 388,392 ****
/** Increments module key a number of entries
*
! * @param increment Number of entries to jump forward
* @return *this
*/
--- 390,394 ----
/** Increments module key a number of entries
*
! * @param steps Number of entries to jump forward
* @return *this
*/
***************
*** 394,401 ****
/** Positions this modules to an entry
*
! * @param p position (e.g. TOP, BOTTOM)
* @return *this
*/
! virtual void setPosition(SW_POSITION p);
/** Adds a RenderFilter to this module's @see renderfilters queue
* @param newfilter the filter to add
--- 396,403 ----
/** Positions this modules to an entry
*
! * @param pos position (e.g. TOP, BOTTOM)
* @return *this
*/
! virtual void setPosition(SW_POSITION pos);
/** Adds a RenderFilter to this module's @see renderfilters queue
* @param newfilter the filter to add
***************
*** 429,433 ****
/** RenderFilter a text buffer
* @param buf the buffer to filter
- * @param size the allocated size of the buffer
* @param key key location from where this buffer was extracted
* @return *this
--- 431,434 ----
***************
*** 467,471 ****
/** encodingFilter a text buffer
* @param buf the buffer to filter
- * @param size the allocated size of the buffer
* @param key key location from where this buffer was extracted
* @return *this
--- 468,471 ----
***************
*** 474,478 ****
filterBuffer(encodingFilters, buf, key);
}
! /** Adds a StripFilter to this module's @ref stripfilters queue
* @param newfilter the filter to add
* @return *this
--- 474,478 ----
filterBuffer(encodingFilters, buf, key);
}
! /** Adds a StripFilter to this module's stripfilters queue
* @param newfilter the filter to add
* @return *this
***************
*** 484,488 ****
/** StripFilter a text buffer
* @param buf the buffer to filter
- * @param size the allocated size of the buffer
* @param key key location from where this buffer was extracted
* @return *this
--- 484,487 ----
***************
*** 491,495 ****
filterBuffer(stripFilters, buf, key);
}
! /** Adds a RawFilter to this module's @ref rawfilters queue
* @param newfilter the filter to add
* @return *this
--- 490,494 ----
filterBuffer(stripFilters, buf, key);
}
! /** Adds a RawFilter to this module's rawfilters queue
* @param newfilter the filter to add
* @return *this
***************
*** 502,506 ****
* @param filters the FilterList of filters to iterate
* @param buf the buffer to filter
- * @param size the allocated size of the buffer
* @param key key location from where this buffer was extracted
* @return *this
--- 501,504 ----
***************
*** 514,518 ****
/** RawFilter a text buffer
* @param buf the buffer to filter
- * @param size the allocated size of the buffer
* @param key key location from where this buffer was extracted
* @return *this
--- 512,515 ----
***************
*** 521,525 ****
filterBuffer(rawFilters, buf, key);
}
! /** Adds an OptionFilter to this module's @ref optionfilters queue
* @param newfilter the filter to add
* @return *this
--- 518,522 ----
filterBuffer(rawFilters, buf, key);
}
! /** Adds an OptionFilter to this module's optionfilters queue
* @param newfilter the filter to add
* @return *this
***************
*** 531,535 ****
/** OptionFilter a text buffer
* @param buf the buffer to filter
- * @param size the allocated size of the buffer
* @param key key location from where this buffer was extracted
* @return *this
--- 528,531 ----
***************
*** 551,554 ****
--- 547,551 ----
* if buf is NULL, the current text will be used
* @param len max len of buf OR current text -- will be applied anyway
+ * @param render Perform the rendering.
* @return this module's text at specified key location massaged by Render filters
*/
Index: swtext.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/swtext.h,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -d -r1.13 -r1.14
*** swtext.h 1 Oct 2002 19:52:40 -0000 1.13
--- swtext.h 28 Feb 2003 13:12:43 -0000 1.14
***************
*** 37,44 ****
public:
/** Initializes data for instance of SWText
- *
- * @param imodname Internal name for module
- * @param imoddesc Name to display to user for module
- * @param idisp Display object to use for displaying
*/
SWText(const char *imodname = 0, const char *imoddesc = 0,
--- 37,40 ----
Index: versekey.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/versekey.h,v
retrieving revision 1.28
retrieving revision 1.29
diff -C2 -d -r1.28 -r1.29
*** versekey.h 1 Oct 2002 19:52:40 -0000 1.28
--- versekey.h 28 Feb 2003 13:12:43 -0000 1.29
***************
*** 165,169 ****
*
* @param ikey text key (will take various forms of 'BOOK CH:VS'.
! * See @ref #parse for more detailed information)
*/
VerseKey(const char *ikey = 0);
--- 165,169 ----
*
* @param ikey text key (will take various forms of 'BOOK CH:VS'.
! * See parse() for more detailed information)
*/
VerseKey(const char *ikey = 0);
***************
*** 173,183 ****
*
* @param ikey base key (will take various forms of 'BOOK CH:VS'.
! * See @ref #parse for more detailed information)
*/
VerseKey(const SWKey * ikey);
/** VerseKey Constructor - initializes instance of VerseKey
! * with boundariess - see also @ref #LowerBound
! * and @ref #UpperBound
* @param min the lower boundary of the new VerseKey
* @param max the upper boundary of the new VerseKey
--- 173,183 ----
*
* @param ikey base key (will take various forms of 'BOOK CH:VS'.
! * See parse() for more detailed information)
*/
VerseKey(const SWKey * ikey);
/** VerseKey Constructor - initializes instance of VerseKey
! * with boundariess - see also LowerBound()
! * and UpperBound()
* @param min the lower boundary of the new VerseKey
* @param max the upper boundary of the new VerseKey
***************
*** 207,211 ****
/** sets the upper boundary for this VerseKey
* and returns the new boundary
! * @param lb the new upper boundary for this VerseKey
* @return the upper boundary the key was set to
*/
--- 207,211 ----
/** sets the upper boundary for this VerseKey
* and returns the new boundary
! * @param ub the new upper boundary for this VerseKey
* @return the upper boundary the key was set to
*/
***************
*** 245,266 ****
/** Positions this key
*
! * @param p position
* @return *this
*/
! virtual void setPosition(SW_POSITION);
/** Decrements key a number of verses
*
! * @param decrement Number of verses to jump backward
* @return *this
*/
! virtual void decrement(int step);
/** Increments key a number of verses
*
! * @param increment Number of verses to jump forward
* @return *this
*/
! virtual void increment(int step);
virtual char Traversable() { return 1; }
--- 245,266 ----
/** Positions this key
*
! * @param newpos Position to set to.
* @return *this
*/
! virtual void setPosition(SW_POSITION newpos);
/** Decrements key a number of verses
*
! * @param steps Number of verses to jump backward
* @return *this
*/
! virtual void decrement(int steps);
/** Increments key a number of verses
*
! * @param steps Number of verses to jump forward
* @return *this
*/
! virtual void increment(int steps);
virtual char Traversable() { return 1; }