[sword-cvs] sword/include roman.h,1.4,1.5 swgenbook.h,1.4,1.5 swmodule.h,1.61,1.62 swversion.h,1.10,1.11
sword@www.crosswire.org
sword@www.crosswire.org
Tue, 4 Mar 2003 15:32:57 -0700
Update of /usr/local/cvsroot/sword/include
In directory www:/tmp/cvs-serv30226/include
Modified Files:
roman.h swgenbook.h swmodule.h swversion.h
Log Message:
Martin: documentation updates.
Index: roman.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/roman.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** roman.h 1 Oct 2002 19:52:40 -0000 1.4
--- roman.h 4 Mar 2003 22:32:55 -0000 1.5
***************
*** 23,28 ****
--- 23,34 ----
SWORD_NAMESPACE_START
+ /** Checks if a string is a roman numeral.
+ */
char isroman(const char *);
/* char* to_rom(int num, char *p); */
+
+ /** Converts a roman numeral to a string.
+ * @param s Roman numeral to convert.
+ */
int from_rom(const char *s);
Index: swgenbook.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/swgenbook.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** swgenbook.h 28 Feb 2003 13:12:43 -0000 1.4
--- swgenbook.h 4 Mar 2003 22:32:55 -0000 1.5
***************
*** 1,5 ****
/******************************************************************************
! * swld.h - code for base class 'SWLD'. SWLD is the basis for all
! * types of Lexicon and Dictionary modules (hence the 'LD').
*
* $Id$
--- 1,4 ----
/******************************************************************************
! * swgenbook.h
*
* $Id$
***************
*** 31,36 ****
SWORD_NAMESPACE_START
! /** the basis for all types of Lexicon and
! * Dictionary modules (hence the 'LD').
*/
class SWDLLEXPORT SWGenBook : public SWModule {
--- 30,34 ----
SWORD_NAMESPACE_START
! /** The basis for all Book modules.
*/
class SWDLLEXPORT SWGenBook : public SWModule {
***************
*** 40,44 ****
public:
! /** Initializes data for instance of SWLD
*/
SWGenBook(const char *imodname = 0, const char *imoddesc = 0,
--- 38,42 ----
public:
! /** Initializes data for instance of SWGenBook
*/
SWGenBook(const char *imodname = 0, const char *imoddesc = 0,
Index: swmodule.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/swmodule.h,v
retrieving revision 1.61
retrieving revision 1.62
diff -C2 -d -r1.61 -r1.62
*** swmodule.h 28 Feb 2003 13:12:43 -0000 1.61
--- swmodule.h 4 Mar 2003 22:32:55 -0000 1.62
***************
*** 188,196 ****
* @param ikey key with which to set this module
* @return error status
! * @deprecated See setKey()
*/
char SetKey(const SWKey *ikey) { return setKey(ikey); }
virtual char setKey(const SWKey *ikey);
!
virtual long Index() const { return entryIndex; }
--- 188,203 ----
* @param ikey key with which to set this module
* @return error status
! * @deprecated Use setKey() instead.
*/
char SetKey(const SWKey *ikey) { return setKey(ikey); }
+ /**
+ * Sets a key to this module for position to a
+ * particular record or set of records
+ *
+ * @param ikey key with which to set this module
+ * @return error status
+ */
virtual char setKey(const SWKey *ikey);
!
virtual long Index() const { return entryIndex; }
***************
*** 198,214 ****
/**
! * Sets the key of this module. Similar to @see SetKey(const SWKey*) .
* @param ikey The SWKey which should be used as new key.
* @return Error status
! * @deprecated See setKey()
*/
char SetKey(const SWKey &ikey) { return setKey(ikey); }
char setKey(const SWKey &ikey) { return SetKey(&ikey); }
/** Gets the current module key
* @return the current key of this module
- * @deprecated See getKey()
*/
SWKey &Key() const { return *getKey(); }
SWKey *getKey() const;
--- 205,228 ----
/**
! * Sets the key of this module.
* @param ikey The SWKey which should be used as new key.
* @return Error status
! * @deprecated Use setKey() instead.
*/
char SetKey(const SWKey &ikey) { return setKey(ikey); }
+ /**
+ * Sets the key of this module.
+ * @param ikey The SWKey which should be used as new key.
+ * @return Error status
+ */
char setKey(const SWKey &ikey) { return SetKey(&ikey); }
/** Gets the current module key
* @return the current key of this module
*/
SWKey &Key() const { return *getKey(); }
+ /** Gets the current module key
+ * @return the current key of this module
+ */
SWKey *getKey() const;
***************
*** 218,232 ****
* @param ikey new current key for the module
* @return the keytext of the current module key
! * @deprecated See setKey()
*/
char Key(const SWKey & ikey) { return setKey(ikey); }
! /******************************************************************************
! * SWModule::KeyText - Sets/gets module KeyText
! *
! * ENT: ikeytext - value which to set keytext
! * [0] - only get
*
! * RET: pointer to keytext
*/
virtual const char *KeyText(const char *ikeytext = 0) {
--- 232,244 ----
* @param ikey new current key for the module
* @return the keytext of the current module key
! * @deprecated Use setKey() instead.
*/
char Key(const SWKey & ikey) { return setKey(ikey); }
! /**
! * Sets/gets module KeyText
*
! * @param ikeytext Value which to set keytext; [0]-only get
! * @return pointer to keytext
*/
virtual const char *KeyText(const char *ikeytext = 0) {
***************
*** 234,238 ****
return *getKey();
}
-
/** Calls this modules display object and passes itself
*
--- 246,249 ----
***************
*** 243,248 ****
/** Sets/gets display driver
*
! * @param idisp value which to set disp;
! * [0] - only get
* @return pointer to disp
*/
--- 254,258 ----
/** Sets/gets display driver
*
! * @param idisp Value which to set disp; [0]-only get
* @return pointer to disp
*/
***************
*** 250,255 ****
/** Sets/gets module name
*
! * @param imodname value which to set modname;
! * [0] - only get
* @return pointer to modname
*/
--- 260,264 ----
/** Sets/gets module name
*
! * @param imodname Value which to set modname; [0]-only get
* @return pointer to modname
*/
***************
*** 257,262 ****
/** Sets/gets module description
*
! * @param imoddesc value which to set moddesc;
! * [0] - only get
* @return pointer to moddesc
*/
--- 266,270 ----
/** Sets/gets module description
*
! * @param imoddesc Value which to set moddesc; [0]-only get
* @return pointer to moddesc
*/
***************
*** 264,269 ****
/** Sets/gets module type
*
! * @param imodtype value which to set modtype;
! * [0] - only get
* @return pointer to modtype
*/
--- 272,276 ----
/** Sets/gets module type
*
! * @param imodtype Value which to set modtype; [0]-only get
* @return pointer to modtype
*/
***************
*** 271,276 ****
/** Sets/gets module direction
*
! * @param newdir value which to set direction;
! * [-1] - only get
* @return new direction
*/
--- 278,282 ----
/** Sets/gets module direction
*
! * @param newdir Value which to set direction; [-1]-only get
* @return new direction
*/
***************
*** 278,283 ****
/** Sets/gets module encoding
*
! * @param enc value which to set encoding;
! * [-1] - only get
* @return Encoding
*/
--- 284,288 ----
/** Sets/gets module encoding
*
! * @param enc Value which to set encoding; [-1]-only get
* @return Encoding
*/
***************
*** 285,297 ****
/** 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
*
! * @param imodlang value which to set modlang;
! * [0] - only get
* @return pointer to modlang
*/
--- 290,300 ----
/** Sets/gets module markup
*
! * @param markup Vvalue which to set markup; [-1]-only get
! * @return Markup
*/
virtual char Markup(signed char markup = -1);
/** Sets/gets module language
*
! * @param imodlang Value which to set modlang; [0]-only get
* @return pointer to modlang
*/
***************
*** 323,327 ****
*/
virtual signed char createSearchFramework() { return 0; } // special search framework
! /**
*
*/
--- 326,330 ----
*/
virtual signed char createSearchFramework() { return 0; } // special search framework
! /** Not yet useful.
*
*/
***************
*** 366,380 ****
*/
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()
- *
*/
virtual void deleteEntry() {}
--- 369,380 ----
*/
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()
*/
virtual void deleteEntry() {}
***************
*** 400,404 ****
*/
virtual void setPosition(SW_POSITION pos);
! /** Adds a RenderFilter to this module's @see renderfilters queue
* @param newfilter the filter to add
* @return *this
--- 400,404 ----
*/
virtual void setPosition(SW_POSITION pos);
! /** Adds a RenderFilter to this module's renderfilters queue
* @param newfilter the filter to add
* @return *this
***************
*** 408,412 ****
return *this;
}
! /** Removes a RenderFilter from this module's @see renderfilters queue
* @param oldfilter the filter to remove
* @return *this
--- 408,412 ----
return *this;
}
! /** Removes a RenderFilter from this module's renderfilters queue
* @param oldfilter the filter to remove
* @return *this
***************
*** 416,420 ****
return *this;
}
! /** Replaces a RenderFilter in this module's @see renderfilters queue
* @param oldfilter the filter to remove
* @param newfilter the filter to add in its place
--- 416,420 ----
return *this;
}
! /** Replaces a RenderFilter in this module's renderfilters queue
* @param oldfilter the filter to remove
* @param newfilter the filter to add in its place
***************
*** 445,449 ****
return *this;
}
! /** Removes an EncodingFilter from this module's @see encodingfilters queue
* @param oldfilter the filter to remove
* @return *this
--- 445,449 ----
return *this;
}
! /** Removes an EncodingFilter from this module's encodingfilters queue
* @param oldfilter the filter to remove
* @return *this
***************
*** 453,457 ****
return *this;
}
! /** Replaces an EncodingFilter in this module's @see encodingfilters queue
* @param oldfilter the filter to remove
* @param newfilter the filter to add in its place
--- 453,457 ----
return *this;
}
! /** Replaces an EncodingFilter in this module's encodingfilters queue
* @param oldfilter the filter to remove
* @param newfilter the filter to add in its place
***************
*** 563,568 ****
*/
virtual const char *RenderText(SWKey * tmpKey);
!
! /**
*
* option to specify behaviour when iterating over consecutive entried linked
--- 563,567 ----
*/
virtual const char *RenderText(SWKey * tmpKey);
! /**
*
* option to specify behaviour when iterating over consecutive entried linked
***************
*** 571,583 ****
*/
virtual void setSkipConsecutiveLinks(bool val) { skipConsecutiveLinks = val; }
virtual bool getSkipConsecutiveLinks() { return skipConsecutiveLinks; }
virtual AttributeTypeList &getEntryAttributes() const { return entryAttributes; }
virtual void processEntryAttributes(bool val) const { procEntAttr = val; }
virtual bool isProcessEntryAttributes() const { return procEntAttr; }
-
-
// OPERATORS -----------------------------------------------------------------
!
SWMODULE_OPERATORS
--- 570,588 ----
*/
virtual void setSkipConsecutiveLinks(bool val) { skipConsecutiveLinks = val; }
+ /** DOCS NEEDED.
+ */
virtual bool getSkipConsecutiveLinks() { return skipConsecutiveLinks; }
+ /** DOCS NEEDED.
+ */
virtual AttributeTypeList &getEntryAttributes() const { return entryAttributes; }
+ /** DOCS NEEDED.
+ */
virtual void processEntryAttributes(bool val) const { procEntAttr = val; }
+ /** DOCS NEEDED.
+ */
virtual bool isProcessEntryAttributes() const { return procEntAttr; }
// OPERATORS -----------------------------------------------------------------
!
SWMODULE_OPERATORS
Index: swversion.h
===================================================================
RCS file: /usr/local/cvsroot/sword/include/swversion.h,v
retrieving revision 1.10
retrieving revision 1.11
diff -C2 -d -r1.10 -r1.11
*** swversion.h 1 Mar 2003 18:57:06 -0000 1.10
--- swversion.h 4 Mar 2003 22:32:55 -0000 1.11
***************
*** 30,40 ****
SWORD_NAMESPACE_START
class SWVersion {
public:
int major, minor, minor2, minor3;
!
SWVersion(const char *version = "0.0");
int compare(const SWVersion &vi) const;
const char *getText() const;
operator const char *() const { return getText(); }
bool operator>(const SWVersion &vi) const {return (compare(vi) > 0);}
--- 30,54 ----
SWORD_NAMESPACE_START
+ /** A basic tool class to handle program version numbers.
+ */
class SWVersion {
public:
+ /** The different version subnumbers.
+ */
int major, minor, minor2, minor3;
! /**The constructor.
! * @param version Version string to be parsed.
! */
SWVersion(const char *version = "0.0");
+ /** Compare 2 Versions with each other.
+ * @param vi Version number to compare with.
+ * @return >0:this>vi; 0:this==vi; <0:this<vi
+ */
int compare(const SWVersion &vi) const;
+ /** @return The parsed version number text.
+ */
const char *getText() const;
+ /** @return The parsed version number text.
+ */
operator const char *() const { return getText(); }
bool operator>(const SWVersion &vi) const {return (compare(vi) > 0);}
***************
*** 42,46 ****
bool operator==(const SWVersion &vi) const {return (compare(vi) == 0);}
! // current sword library version
static SWVersion currentVersion;
};
--- 56,63 ----
bool operator==(const SWVersion &vi) const {return (compare(vi) == 0);}
! /** Current sword library version.
! * Use this to check (e.g. at compile time) if the
! * version of the sword lib is recent enough for your program.
! */
static SWVersion currentVersion;
};