1 files changed, 0 insertions, 650 deletions
diff --git a/doc/api-documentation/man/man3/versekey.3 b/doc/api-documentation/man/man3/versekey.3
deleted file mode 100644
index bc77131..0000000
--- a/doc/api-documentation/man/man3/versekey.3
+++ /dev/null
@@ -1,650 +0,0 @@
-.TH "VerseKey" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*-
-.ad l
-.nh
-.SH NAME
-VerseKey \- Class VerseKey The \fBSWKey\fR implementation used for verse based modules like Bibles or commentaries. 
-.SH SYNOPSIS
-.br
-.PP
-\fC#include <versekey.h>\fR
-.PP
-Inherits \fBSWKey\fR.
-.PP
-.SS Public Methods
-
-.in +1c
-.ti -1c
-.RI "\fBVerseKey\fR (const char *ikey=0)"
-.br
-.RI "\fIVerseKey Constructor - initializes Instance of VerseKey.\fR"
-.ti -1c
-.RI "\fBVerseKey\fR (const \fBSWKey\fR *ikey)"
-.br
-.RI "\fIVerseKey Constructor - initializes instance of VerseKey.\fR"
-.ti -1c
-.RI "\fBVerseKey\fR (const char *min, const char *max)"
-.br
-.RI "\fIVerseKey Constructor - initializes instance of VerseKey with boundariess - see also \fBLowerBound\fR and \fBUpperBound\fR.\fR"
-.ti -1c
-.RI "\fBVerseKey\fR (VerseKey const &k)"
-.br
-.RI "\fIVerseKey Copy Constructor - will create a new VerseKey based on an existing one.\fR"
-.ti -1c
-.RI "virtual \fB~VerseKey\fR ()"
-.br
-.RI "\fIVerseKey Destructor Cleans up an instance of VerseKey.\fR"
-.ti -1c
-.RI "VerseKey& \fBLowerBound\fR (const char *lb)"
-.br
-.RI "\fIsets the lower boundary for this VerseKey and returns the new boundary.\fR"
-.ti -1c
-.RI "VerseKey& \fBUpperBound\fR (const char *ub)"
-.br
-.RI "\fIsets the upper boundary for this VerseKey and returns the new boundary.\fR"
-.ti -1c
-.RI "VerseKey& \fBLowerBound\fR () const"
-.br
-.RI "\fIgets the lower boundary of this VerseKey.\fR"
-.ti -1c
-.RI "VerseKey& \fBUpperBound\fR () const"
-.br
-.RI "\fIgets the upper boundary of this VerseKey.\fR"
-.ti -1c
-.RI "void \fBClearBounds\fR ()"
-.br
-.RI "\fIclears the boundaries of this VerseKey.\fR"
-.ti -1c
-.RI "virtual \fBSWKey\fR* \fBclone\fR () const"
-.br
-.RI "\fICreates a new \fBSWKey\fR based on the current VerseKey see also the Copy Constructor.\fR"
-.ti -1c
-.RI "virtual const char* \fBgetText\fR () const"
-.br
-.RI "\fIrefreshes keytext before returning if cast to a (char *) is requested.\fR"
-.ti -1c
-.RI "virtual void \fBsetText\fR (const char *ikey)"
-.br
-.RI "\fIEquates this \fBSWKey\fR to a character string.\fR"
-.ti -1c
-.RI "virtual void \fBcopyFrom\fR (const \fBSWKey\fR &ikey)"
-.br
-.RI "\fIEquates this \fBSWKey\fR to another \fBSWKey\fR object.\fR"
-.ti -1c
-.RI "virtual void \fBcopyFrom\fR (const VerseKey &ikey)"
-.br
-.RI "\fIEquates this VerseKey to another VerseKey.\fR"
-.ti -1c
-.RI "virtual void \fBsetPosition\fR (SW_POSITION)"
-.br
-.RI "\fIPositions this key.\fR"
-.ti -1c
-.RI "virtual void \fBdecrement\fR (int step)"
-.br
-.RI "\fIDecrements key a number of verses.\fR"
-.ti -1c
-.RI "virtual void \fBincrement\fR (int step)"
-.br
-.RI "\fIIncrements key a number of verses.\fR"
-.ti -1c
-.RI "virtual char \fBTraversable\fR ()"
-.br
-.ti -1c
-.RI "virtual char \fBTestament\fR () const"
-.br
-.RI "\fIGets testament.\fR"
-.ti -1c
-.RI "virtual char \fBBook\fR () const"
-.br
-.RI "\fIGets book.\fR"
-.ti -1c
-.RI "virtual int \fBChapter\fR () const"
-.br
-.RI "\fIGets chapter.\fR"
-.ti -1c
-.RI "virtual int \fBVerse\fR () const"
-.br
-.RI "\fIGets verse.\fR"
-.ti -1c
-.RI "virtual char \fBTestament\fR (char itestament)"
-.br
-.RI "\fISets/gets testament.\fR"
-.ti -1c
-.RI "virtual char \fBBook\fR (char ibook)"
-.br
-.RI "\fISets/gets book.\fR"
-.ti -1c
-.RI "virtual int \fBChapter\fR (int ichapter)"
-.br
-.RI "\fISets/gets chapter.\fR"
-.ti -1c
-.RI "virtual int \fBVerse\fR (int iverse)"
-.br
-.RI "\fISets/gets verse.\fR"
-.ti -1c
-.RI "virtual void \fBNormalize\fR (char autocheck=0)"
-.br
-.RI "\fIchecks limits and normalizes if necessary (e.g.\fR"
-.ti -1c
-.RI "virtual char \fBAutoNormalize\fR (char iautonorm=MAXPOS(char))"
-.br
-.RI "\fISets/gets flag that tells VerseKey to automatically normalize itself when modified.\fR"
-.ti -1c
-.RI "virtual char \fBHeadings\fR (char iheadings=MAXPOS(char))"
-.br
-.RI "\fISets/gets flag that tells VerseKey to include chapter/book/testament/module headings.\fR"
-.ti -1c
-.RI "virtual long \fBNewIndex\fR () const"
-.br
-.ti -1c
-.RI "virtual long \fBIndex\fR () const"
-.br
-.RI "\fIGets index based upon current verse.\fR"
-.ti -1c
-.RI "virtual long \fBIndex\fR (long iindex)"
-.br
-.RI "\fISets index based upon current verse.\fR"
-.ti -1c
-.RI "virtual \fBListKey\fR \fBParseVerseList\fR (const char *buf, const char *defaultKey="Genesis 1:1", bool expandRange=false)"
-.br
-.ti -1c
-.RI "virtual int \fBcompare\fR (const \fBSWKey\fR &ikey)"
-.br
-.RI "\fICompares another \fBSWKey\fR object.\fR"
-.ti -1c
-.RI "virtual int \fB_compare\fR (const VerseKey &ikey)"
-.br
-.RI "\fICompares another VerseKey object.\fR"
-.ti -1c
-.RI "virtual void \fBsetBookAbbrevs\fR (const struct abbrev *bookAbbrevs, unsigned int size=0)"
-.br
-.ti -1c
-.RI "virtual void \fBsetBooks\fR (const char *iBMAX, struct sbook **ibooks)"
-.br
-.ti -1c
-.RI "virtual void \fBsetLocale\fR (const char *name)"
-.br
-.ti -1c
-.RI "virtual SWKEY_OPERATORS \fBSWKey\fR& \fBoperator=\fR (const VerseKey &ikey)"
-.br
-.in -1c
-.SS Public Attributes
-
-.in +1c
-.ti -1c
-.RI "const char* \fBBMAX\fR"
-.br
-.ti -1c
-.RI "struct sbook** \fBbooks\fR"
-.br
-.in -1c
-.SS Static Public Attributes
-
-.in +1c
-.ti -1c
-.RI "const char \fBbuiltin_BMAX\fR [2]"
-.br
-.ti -1c
-.RI "struct sbook* \fBbuiltin_books\fR [2]"
-.br
-.ti -1c
-.RI "const struct abbrev \fBbuiltin_abbrevs\fR []"
-.br
-.in -1c
-.SS Private Methods
-
-.in +1c
-.ti -1c
-.RI "int \fBgetBookAbbrev\fR (char *abbr)"
-.br
-.ti -1c
-.RI "void \fBinitBounds\fR () const"
-.br
-.ti -1c
-.RI "void \fBinitstatics\fR ()"
-.br
-.RI "\fIinitialize and allocate books array.\fR"
-.ti -1c
-.RI "void \fBinit\fR ()"
-.br
-.RI "\fIinitializes this \fBVerseKey\fR().\fR"
-.ti -1c
-.RI "void \fBfreshtext\fR () const"
-.br
-.RI "\fIRefresh keytext based on testament|book|chapter|verse default auto normalization to true default display headings option is false.\fR"
-.ti -1c
-.RI "virtual char \fBparse\fR ()"
-.br
-.RI "\fIParse a character array into testament|book|chapter|verse.\fR"
-.ti -1c
-.RI "int \fBfindindex\fR (long *array, int size, long value)"
-.br
-.RI "\fIBinary search to find the index closest, but less than the given value.\fR"
-.in -1c
-.SS Private Attributes
-
-.in +1c
-.ti -1c
-.RI "\fBListKey\fR \fBinternalListKey\fR"
-.br
-.ti -1c
-.RI "const struct abbrev* \fBabbrevs\fR"
-.br
-.ti -1c
-.RI "int \fBabbrevsCnt\fR"
-.br
-.ti -1c
-.RI "char \fBtestament\fR"
-.br
-.RI "\fIThe Testament: 0 - Old; 1 - New.\fR"
-.ti -1c
-.RI "char \fBbook\fR"
-.br
-.ti -1c
-.RI "int \fBchapter\fR"
-.br
-.ti -1c
-.RI "int \fBverse\fR"
-.br
-.ti -1c
-.RI "char \fBautonorm\fR"
-.br
-.RI "\fIflag for auto normalization.\fR"
-.ti -1c
-.RI "char \fBheadings\fR"
-.br
-.RI "\fIflag for headings on/off.\fR"
-.ti -1c
-.RI "VerseKey* \fBlowerBound\fR"
-.br
-.ti -1c
-.RI "VerseKey * \fBupperBound\fR"
-.br
-.in -1c
-.SS Static Private Attributes
-
-.in +1c
-.ti -1c
-.RI "\fBSWClass\fR \fBclassdef\fR"
-.br
-.ti -1c
-.RI "long* \fBoffsets\fR [2][2]"
-.br
-.ti -1c
-.RI "int \fBoffsize\fR [2][2]"
-.br
-.ti -1c
-.RI "int \fBinstance\fR"
-.br
-.RI "\fInumber of instantiated VerseKey objects or derivitives.\fR"
-.ti -1c
-.RI "struct sbook \fBotbooks\fR []"
-.br
-.ti -1c
-.RI "struct sbook \fBntbooks\fR []"
-.br
-.ti -1c
-.RI "long \fBotbks\fR []"
-.br
-.ti -1c
-.RI "long \fBotcps\fR []"
-.br
-.ti -1c
-.RI "long \fBntbks\fR []"
-.br
-.ti -1c
-.RI "long \fBntcps\fR []"
-.br
-.ti -1c
-.RI "int \fBvm\fR []"
-.br
-.ti -1c
-.RI "LocaleCache \fBlocaleCache\fR"
-.br
-.in -1c
-.SH DETAILED DESCRIPTION
-.PP 
-Class VerseKey The \fBSWKey\fR implementation used for verse based modules like Bibles or commentaries.
-.PP
-Definition at line 66 of file versekey.h.
-.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
-.PP 
-.SS VerseKey::VerseKey (const char * ikey = 0)
-.PP
-VerseKey Constructor - initializes Instance of VerseKey.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIikey\fR\fR
-text key (will take various forms of 'BOOK CH:VS'. See \fBparse\fR for more detailed information) 
-.SS VerseKey::VerseKey (const \fBSWKey\fR * ikey)
-.PP
-VerseKey Constructor - initializes instance of VerseKey.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIikey\fR\fR
-base key (will take various forms of 'BOOK CH:VS'. See \fBparse\fR for more detailed information) 
-.SS VerseKey::VerseKey (const char * min, const char * max)
-.PP
-VerseKey Constructor - initializes instance of VerseKey with boundariess - see also \fBLowerBound\fR and \fBUpperBound\fR.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fImin\fR\fR
-the lower boundary of the new VerseKey 
-.TP
-\fB\fImax\fR\fR
-the upper boundary of the new VerseKey 
-.SS VerseKey::VerseKey (VerseKey const & k)
-.PP
-VerseKey Copy Constructor - will create a new VerseKey based on an existing one.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIk\fR\fR
-the VerseKey to copy from 
-.SH MEMBER FUNCTION DOCUMENTATION
-.PP 
-.SS char VerseKey::AutoNormalize (char iautonorm = MAXPOS (char))\fC [virtual]\fR
-.PP
-Sets/gets flag that tells VerseKey to automatically normalize itself when modified.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIiautonorm\fR\fR
-value which to set autonorm [MAXPOS(char)] - only get 
-.PP
-\fBReturns: \fR
-.in +1c
-if unchanged -> value of autonorm, if changed -> previous value of autonorm 
-.SS char VerseKey::Book (char ibook)\fC [virtual]\fR
-.PP
-Sets/gets book.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIibook\fR\fR
-value which to set book [MAXPOS(char)] - only get 
-.PP
-\fBReturns: \fR
-.in +1c
-if unchanged -> value of book, if changed -> previous value of book 
-.SS char VerseKey::Book () const\fC [virtual]\fR
-.PP
-Gets book.
-.PP
-\fBReturns: \fR
-.in +1c
-value of book 
-.SS int VerseKey::Chapter (int ichapter)\fC [virtual]\fR
-.PP
-Sets/gets chapter.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIichapter\fR\fR
-value which to set chapter [MAXPOS(int)] - only get 
-.PP
-\fBReturns: \fR
-.in +1c
-if unchanged -> value of chapter, if changed -> previous value of chapter 
-.SS int VerseKey::Chapter () const\fC [virtual]\fR
-.PP
-Gets chapter.
-.PP
-\fBReturns: \fR
-.in +1c
-value of chapter 
-.SS char VerseKey::Headings (char iheadings = MAXPOS (char))\fC [virtual]\fR
-.PP
-Sets/gets flag that tells VerseKey to include chapter/book/testament/module headings.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIiheadings\fR\fR
-value which to set headings [MAXPOS(char)] - only get 
-.PP
-\fBReturns: \fR
-.in +1c
-if unchanged -> value of headings, if changed -> previous value of headings 
-.SS long VerseKey::Index (long index)\fC [virtual]\fR
-.PP
-Sets index based upon current verse.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIiindex\fR\fR
-value to set index to 
-.PP
-\fBReturns: \fR
-.in +1c
-offset 
-.PP
-Reimplemented from \fBSWKey\fR.
-.SS long VerseKey::Index () const\fC [virtual]\fR
-.PP
-Gets index based upon current verse.
-.PP
-\fBReturns: \fR
-.in +1c
-offset 
-.PP
-Reimplemented from \fBSWKey\fR.
-.SS VerseKey & VerseKey::LowerBound () const
-.PP
-gets the lower boundary of this VerseKey.
-.PP
-\fBReturns: \fR
-.in +1c
-the lower boundary of this VerseKey 
-.SS VerseKey & VerseKey::LowerBound (const char * lb)
-.PP
-sets the lower boundary for this VerseKey and returns the new boundary.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIlb\fR\fR
-the new lower boundary for this VerseKey 
-.PP
-\fBReturns: \fR
-.in +1c
-the lower boundary the key was set to 
-.SS void VerseKey::Normalize (char autocheck = 0)\fC [virtual]\fR
-.PP
-checks limits and normalizes if necessary (e.g.
-.PP
-Matthew 29:47 = Mark 2:2). If last verse is exceeded, key is set to last Book CH:VS
-.PP
-\fBReturns: \fR
-.in +1c
-*this 
-.SS char VerseKey::Testament (char itestament)\fC [virtual]\fR
-.PP
-Sets/gets testament.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIitestament\fR\fR
-value which to set testament [MAXPOS(char)] - only get 
-.PP
-\fBReturns: \fR
-.in +1c
-if unchanged -> value of testament, if changed -> previous value of testament 
-.SS char VerseKey::Testament () const\fC [virtual]\fR
-.PP
-Gets testament.
-.PP
-\fBReturns: \fR
-.in +1c
-value of testament 
-.SS VerseKey & VerseKey::UpperBound () const
-.PP
-gets the upper boundary of this VerseKey.
-.PP
-\fBReturns: \fR
-.in +1c
-the upper boundary of this VerseKey 
-.SS VerseKey & VerseKey::UpperBound (const char * ub)
-.PP
-sets the upper boundary for this VerseKey and returns the new boundary.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIlb\fR\fR
-the new upper boundary for this VerseKey 
-.PP
-\fBReturns: \fR
-.in +1c
-the upper boundary the key was set to 
-.SS int VerseKey::Verse (int iverse)\fC [virtual]\fR
-.PP
-Sets/gets verse.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIiverse\fR\fR
-value which to set verse [MAXPOS(int)] - only get 
-.PP
-\fBReturns: \fR
-.in +1c
-if unchanged -> value of verse, if changed -> previous value of verse 
-.SS int VerseKey::Verse () const\fC [virtual]\fR
-.PP
-Gets verse.
-.PP
-\fBReturns: \fR
-.in +1c
-value of verse 
-.SS int VerseKey::_compare (const VerseKey & ikey)\fC [virtual]\fR
-.PP
-Compares another VerseKey object.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIikey\fR\fR
-key to compare with this one 
-.PP
-\fBReturns: \fR
-.in +1c
->0 if this VerseKey is greater than compare VerseKey, <0 if this VerseKey is smaller than compare VerseKey, 0 if the keys are the same 
-.SS int VerseKey::compare (const \fBSWKey\fR & ikey)\fC [virtual]\fR
-.PP
-Compares another \fBSWKey\fR object.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIikey\fR\fR
-key to compare with this one 
-.PP
-\fBReturns: \fR
-.in +1c
->0 if this VerseKey is greater than compare \fBSWKey\fR, <0 if this VerseKey is smaller than compare \fBSWKey\fR, 0 if the keys are the same 
-.PP
-Reimplemented from \fBSWKey\fR.
-.SS virtual void VerseKey::copyFrom (const \fBSWKey\fR & ikey)\fC [virtual]\fR
-.PP
-Equates this \fBSWKey\fR to another \fBSWKey\fR object.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIikey\fR\fR
-other swkey object 
-.PP
-Reimplemented from \fBSWKey\fR.
-.SS void VerseKey::decrement (int step)\fC [virtual]\fR
-.PP
-Decrements key a number of verses.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIdecrement\fR\fR
-Number of verses to jump backward 
-.PP
-\fBReturns: \fR
-.in +1c
-*this 
-.PP
-Reimplemented from \fBSWKey\fR.
-.SS int VerseKey::findindex (long * array, int size, long value)\fC [private]\fR
-.PP
-Binary search to find the index closest, but less than the given value.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIarray\fR\fR
-long * to array to search 
-.TP
-\fB\fIsize\fR\fR
-number of elements in the array 
-.TP
-\fB\fIvalue\fR\fR
-value to find 
-.PP
-\fBReturns: \fR
-.in +1c
-the index into the array that is less than but closest to value 
-.SS void VerseKey::increment (int step)\fC [virtual]\fR
-.PP
-Increments key a number of verses.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIincrement\fR\fR
-Number of verses to jump forward 
-.PP
-\fBReturns: \fR
-.in +1c
-*this 
-.PP
-Reimplemented from \fBSWKey\fR.
-.SS void VerseKey::setPosition (SW_POSITION)\fC [virtual]\fR
-.PP
-Positions this key.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIp\fR\fR
-position 
-.PP
-\fBReturns: \fR
-.in +1c
-*this 
-.PP
-Reimplemented from \fBSWKey\fR.
-.SS void VerseKey::setText (const char * ikey)\fC [inline, virtual]\fR
-.PP
-Equates this \fBSWKey\fR to a character string.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIikey\fR\fR
-string to set this key to 
-.PP
-Reimplemented from \fBSWKey\fR.
-.PP
-Definition at line 228 of file versekey.h.
-
-.SH AUTHOR
-.PP 
-Generated automatically by Doxygen for The Sword Project from the source code.
-\ No newline at end of file