[sword-svn] r3820 - in trunk: doc examples/cmdline include
scribe at crosswire.org
scribe at crosswire.org
Sat Oct 24 16:27:30 EDT 2020
Author: scribe
Date: 2020-10-24 16:27:30 -0400 (Sat, 24 Oct 2020)
New Revision: 3820
Added:
trunk/doc/Makefile
Modified:
trunk/doc/Doxyfile
trunk/examples/cmdline/lookup.cpp
trunk/include/listkey.h
trunk/include/markupfiltmgr.h
trunk/include/remotetrans.h
trunk/include/swdisp.h
trunk/include/swkey.h
trunk/include/swmgr.h
trunk/include/swmodule.h
trunk/include/swversion.h
trunk/include/versekey.h
Log:
Doxygen improvements.
Updated lookup example to include JS when appropriate
Modified: trunk/doc/Doxyfile
===================================================================
--- trunk/doc/Doxyfile 2020-10-24 20:23:11 UTC (rev 3819)
+++ trunk/doc/Doxyfile 2020-10-24 20:27:30 UTC (rev 3820)
@@ -55,7 +55,7 @@
# This could be handy for archiving the generated documentation or
# if some version control system is used.
-PROJECT_NUMBER = "1.7.0"
+PROJECT_NUMBER = "1.9.0"
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
Added: trunk/doc/Makefile
===================================================================
--- trunk/doc/Makefile (rev 0)
+++ trunk/doc/Makefile 2020-10-24 20:27:30 UTC (rev 3820)
@@ -0,0 +1,11 @@
+all: doxygen
+
+doxygen: Doxyfile
+ cd .. && doxygen doc/Doxyfile
+
+clean:
+ rm -rf doxygen
+
+deploy:doxygen
+ rm -rf /home/sword/html/apiref
+ cp -a doxygen/html /home/sword/html/apiref
Modified: trunk/examples/cmdline/lookup.cpp
===================================================================
--- trunk/examples/cmdline/lookup.cpp 2020-10-24 20:23:11 UTC (rev 3819)
+++ trunk/examples/cmdline/lookup.cpp 2020-10-24 20:27:30 UTC (rev 3820)
@@ -28,6 +28,7 @@
#include <swmodule.h>
#include <swfilter.h>
#include <markupfiltmgr.h>
+#include <osiswordjs.h>
#include <versekey.h>
//#include "../../bindings/corba/orbitcpp/webmgr.hpp"
@@ -38,6 +39,7 @@
using sword::FMT_WEBIF;
using sword::FMT_HTMLHREF;
using sword::FMT_XHTML;
+using sword::FMT_OSIS;
using sword::FMT_RTF;
using sword::FMT_LATEX;
using sword::ModMap;
@@ -46,6 +48,7 @@
using sword::AttributeValue;
using sword::VerseKey;
using sword::FilterList;
+using sword::OSISWordJS;
int main(int argc, char **argv)
@@ -77,6 +80,12 @@
exit(-1);
}
+ if (target->getMarkup() == FMT_OSIS) {
+ OSISWordJS *osisWordJS = new OSISWordJS();
+ osisWordJS->setMgr(&manager);
+ target->addOptionFilter(osisWordJS);
+ osisWordJS->setOptionValue("On");
+ }
// turn all filters to default values
manager.setGlobalOption("Headings", "On");
manager.setGlobalOption("Strong's Numbers", "Off");
Modified: trunk/include/listkey.h
===================================================================
--- trunk/include/listkey.h 2020-10-24 20:23:11 UTC (rev 3819)
+++ trunk/include/listkey.h 2020-10-24 20:27:30 UTC (rev 3820)
@@ -63,7 +63,10 @@
/** Clears out elements of list
*/
virtual void clear();
- // deprecated, use clear(), instead
+
+ /**
+ * @deprecated, use clear(), instead
+* */
SWDEPRECATED virtual void ClearList() { clear(); }
@@ -71,13 +74,17 @@
* @return number of key elements in list
*/
virtual int getCount() const;
- //deprecated, use getCount
+ /**
+ * @deprecated Use getCount
+ */
SWDEPRECATED virtual int Count() { return getCount(); }
/** Removes current element from list
*/
virtual void remove();
- // deprecated use remove
+ /**
+ * @deprecated Use remove
+ */
SWDEPRECATED virtual void Remove() { remove(); }
@@ -89,7 +96,9 @@
* deprecated use setToElement
*/
virtual char setToElement(int ielement, SW_POSITION pos = TOP);
- // deprecated use setToElement
+ /**
+ * @deprecated Use setToElement
+ */
SWDEPRECATED virtual char SetToElement(int ielement, SW_POSITION pos = TOP) { return setToElement(ielement, pos); }
@@ -102,7 +111,9 @@
virtual SWKey *getElement(int pos = -1);
virtual const SWKey *getElement(int pos = -1) const;
- // deprecated, use above function
+ /**
+ * @deprecated Use getElement
+ */
SWDEPRECATED virtual SWKey *GetElement(int pos = -1) { return getElement(pos); }
/** Adds an element to the list
Modified: trunk/include/markupfiltmgr.h
===================================================================
--- trunk/include/markupfiltmgr.h 2020-10-24 20:23:11 UTC (rev 3819)
+++ trunk/include/markupfiltmgr.h 2020-10-24 20:27:30 UTC (rev 3820)
@@ -62,7 +62,7 @@
/** Markup sets/gets the markup after initialization
*
- * DEPRECATED: use setMarkup / getMarkup
+ * @deprecated Use setMarkup / getMarkup
*
* @param m The new markup
* @return The current (possibly changed) markup format.
Modified: trunk/include/remotetrans.h
===================================================================
--- trunk/include/remotetrans.h 2020-10-24 20:23:11 UTC (rev 3819)
+++ trunk/include/remotetrans.h 2020-10-24 20:27:30 UTC (rev 3820)
@@ -39,8 +39,13 @@
/** Messages before stages of a batch download */
virtual void preStatus(long totalBytes, long completedBytes, const char *message);
- /** frequently called throughout a download, to report status */
+ /**
+ * @deprecated Use override update instead, receive sttaus updates
+ */
SWDEPRECATED virtual void statusUpdate(double dtTotal, double dlNow);
+ /** frequently called throughout a download, to report status
+ * override to receive status information
+ */
virtual void update(unsigned long totalBytes, unsigned long completedBytes);
};
Modified: trunk/include/swdisp.h
===================================================================
--- trunk/include/swdisp.h 2020-10-24 20:23:11 UTC (rev 3819)
+++ trunk/include/swdisp.h 2020-10-24 20:27:30 UTC (rev 3820)
@@ -48,6 +48,9 @@
* @return error status
*/
virtual char display(SWModule &imodule) = 0;
+ /**
+ * @deprecated Use display
+ */
SWDEPRECATED char Display(SWModule &imodule) { return display(imodule); }
};
Modified: trunk/include/swkey.h
===================================================================
--- trunk/include/swkey.h 2020-10-24 20:23:11 UTC (rev 3819)
+++ trunk/include/swkey.h 2020-10-24 20:27:30 UTC (rev 3820)
@@ -142,6 +142,9 @@
* @return 1 - persists in module; 0 - a copy is attempted
*/
bool isPersist() const;
+ /**
+ * @deprecated Use isPersist
+ */
SWDEPRECATED char Persist() const { return isPersist(); }
/** Sets whether this key should persist in any module to which it is set
@@ -149,16 +152,22 @@
* @param ipersist value which to set persist;
* @return 1 - persists in module; 0 - a copy is attempted
*/
+ void setPersist(bool ipersist);
+ /**
+ * @deprecated Use setPersist and isPersist instead.
+ */
SWDEPRECATED char Persist(signed char ipersist) { setPersist(ipersist!=0); return isPersist(); }
- void setPersist(bool ipersist);
/** Gets and clears error status
* @return error status
*/
- SWDEPRECATED char Error() { return popError(); }
virtual char popError();
virtual char getError() const { return error; }
virtual void setError(char err) { error = err; }
+ /**
+ * @deprecated Use popError and getError instead
+ */
+ SWDEPRECATED char Error() { return popError(); }
/** Sets this SWKey with a character string
* @param ikey string used to set this key
Modified: trunk/include/swmgr.h
===================================================================
--- trunk/include/swmgr.h 2020-10-24 20:23:11 UTC (rev 3819)
+++ trunk/include/swmgr.h 2020-10-24 20:27:30 UTC (rev 3820)
@@ -103,9 +103,12 @@
SWConfig *mysysconfig;
SWConfig *homeConfig;
/**
- * Deprecated. Use createAllModules instead
+ * @deprecated. Use createAllModules instead
*/
SWDEPRECATED void CreateMods(bool multiMod = false) { createAllModules(multiMod); };
+ /**
+ * @deprecated. Use deleteAllModules instead
+ */
SWDEPRECATED void DeleteMods() { deleteAllModules(); }
char configType; // 0 = file; 1 = directory
OptionFilterMap optionFilters;
@@ -152,7 +155,7 @@
/**
- * Deprecated. Use addGlobalOptionFilters instead.
+ * @deprecated Use addGlobalOptionFilters instead.
*/
SWDEPRECATED virtual void AddGlobalOptions(SWModule *module, ConfigEntMap §ion, ConfigEntMap::iterator start, ConfigEntMap::iterator end) { addGlobalOptionFilters(module, section); }
/**
@@ -173,7 +176,7 @@
virtual void addGlobalOptionFilters(SWModule *module, ConfigEntMap §ion);
/**
- * Deprecated. Use addLocalOptionFilters instead.
+ * @deprecated Use addLocalOptionFilters instead.
*/
SWDEPRECATED virtual void AddLocalOptions(SWModule *module, ConfigEntMap §ion, ConfigEntMap::iterator start, ConfigEntMap::iterator end) { addLocalOptionFilters(module, section); }
/**
@@ -188,7 +191,7 @@
virtual void addLocalOptionFilters(SWModule *module, ConfigEntMap §ion);
/**
- * Deprecated. Use addEncodingFilters instead
+ * @deprecated Use addEncodingFilters instead
*/
SWDEPRECATED virtual void AddEncodingFilters(SWModule *module, ConfigEntMap §ion) { addEncodingFilters(module, section); }
/**
@@ -201,7 +204,7 @@
virtual void addEncodingFilters(SWModule *module, ConfigEntMap §ion);
/**
- * Deprecated. Use addRenderFilters instead.
+ * @deprecated Use addRenderFilters instead.
*/
SWDEPRECATED virtual void AddRenderFilters(SWModule *module, ConfigEntMap §ion) { addRenderFilters(module, section); }
/**
@@ -216,7 +219,7 @@
virtual void addRenderFilters(SWModule *module, ConfigEntMap §ion);
/**
- * Deprecated. Use addStripFilters instead.
+ * @deprecated Use addStripFilters instead.
*/
SWDEPRECATED virtual void AddStripFilters(SWModule *module, ConfigEntMap §ion) { addStripFilters(module, section); }
/**
@@ -230,7 +233,7 @@
virtual void addStripFilters(SWModule *module, ConfigEntMap §ion);
/**
- * Deprecated. Use addLocalStripFilters instead.
+ * @deprecated Use addLocalStripFilters instead.
*/
SWDEPRECATED virtual void AddStripFilters(SWModule *module, ConfigEntMap §ion, ConfigEntMap::iterator start, ConfigEntMap::iterator end) { addLocalStripFilters(module, section); }
/**
@@ -243,7 +246,7 @@
virtual void addLocalStripFilters(SWModule *module, ConfigEntMap §ion);
/**
- * Deprecated. Use addRawFilters instead.
+ * @deprecated Use addRawFilters instead.
*/
SWDEPRECATED virtual void AddRawFilters(SWModule *module, ConfigEntMap §ion) { addRawFilters(module, section); }
/**
@@ -278,7 +281,7 @@
static const char *globalConfPath;
/**
- * Deprecated. Used FileMgr::getSystemFileMgr()->getHomeDir() instead.
+ * @deprecated Used FileMgr::getSystemFileMgr()->getHomeDir() instead.
*/
SWDEPRECATED static SWBuf getHomeDir();
@@ -317,6 +320,7 @@
* Deprecated. Use getModules instead.
*/
ModMap Modules;
+
/** The map of available modules.
* This map exposes the installed modules.
*
@@ -417,7 +421,7 @@
virtual void InstallScan(const char *dir);
/**
- * Deprecated. Use load
+ * @deprecated Use load
*/
SWDEPRECATED virtual signed char Load() { return load(); }
/** Loads installed library of SWORD modules.
Modified: trunk/include/swmodule.h
===================================================================
--- trunk/include/swmodule.h 2020-10-24 20:23:11 UTC (rev 3819)
+++ trunk/include/swmodule.h 2020-10-24 20:27:30 UTC (rev 3820)
@@ -68,6 +68,9 @@
SWModule &operator ++(int) { return *this += 1; } \
SWModule &operator --(int) { return *this -= 1; } \
SWModule &operator =(SW_POSITION p) { setPosition(p); return *this; } \
+ /** \
+ * @deprecated Use renderText instead \
+ */ \
SWDEPRECATED operator const char *() { static SWBuf unsafeTmp = renderText(); return unsafeTmp.c_str(); }
@@ -193,6 +196,9 @@
* @return error status
*/
virtual char popError();
+ /**
+ * @deprecated Use popError instead.
+ */
SWDEPRECATED virtual char Error() { return popError(); }
/**
@@ -296,9 +302,13 @@
virtual long getIndex() const { return entryIndex; }
virtual void setIndex(long iindex) { entryIndex = iindex; }
- // deprecated, use getIndex()
+ /**
+ * @deprecated Use getIndex()
+ */
SWDEPRECATED long Index() const { return getIndex(); }
- // deprecated, use setIndex(...)
+ /**
+ * @deprecated Use setIndex(...)
+ */
SWDEPRECATED long Index(long iindex) { setIndex(iindex); return getIndex(); }
/** Calls this module's display object and passes itself
@@ -306,6 +316,9 @@
* @return error status
*/
virtual char display();
+ /**
+ * @deprecated Use display
+ */
SWDEPRECATED char Display() { return display(); }
/** Gets display driver
@@ -330,10 +343,14 @@
* @return pointer to modname
*/
const char *getName() const;
+ /**
+ * @deprecated Use getName
+ */
SWDEPRECATED const char *Name() const { return getName(); }
/** Sets module name
*
+ * @deprecated Use getName
* @param imodname Value which to set modname; [0]-only get
* @return pointer to modname
*/
@@ -344,10 +361,14 @@
* @return pointer to moddesc
*/
const char *getDescription() const;
+ /**
+ * @deprecated Use getDescription
+ */
SWDEPRECATED const char *Description() const { return getDescription(); }
/** Sets module description
*
+ * @deprecated Use getDescription
* @param imoddesc Value which to set moddesc; [0]-only get
* @return pointer to moddesc
*/
@@ -358,6 +379,9 @@
* @return pointer to modtype
*/
const char *getType() const;
+ /**
+ * @deprecated Use getType
+ */
SWDEPRECATED const char *Type() const { return getType(); }
/** Sets module type
@@ -365,14 +389,20 @@
* @param imodtype Value which to set modtype; [0]-only get
* @return pointer to modtype
*/
+ void setType(const char *imodtype) { stdstr(&modtype, imodtype); }
+ /**
+ * @deprecated Use setType / getType
+ */
SWDEPRECATED const char *Type(const char *imodtype) { setType(imodtype); return getType(); }
- void setType(const char *imodtype) { stdstr(&modtype, imodtype); }
/** Sets/gets module direction
*
* @return new direction
*/
virtual char getDirection() const;
+ /**
+ * @deprecated Use getDirection
+ */
SWDEPRECATED char Direction(signed char newdir = -1) { char retVal = getDirection(); if (newdir != -1) return direction = newdir; return retVal; }
/** Gets module encoding
@@ -380,6 +410,9 @@
* @return Encoding
*/
char getEncoding() const { return encoding; }
+ /**
+ * @deprecated Use getEncoding
+ */
SWDEPRECATED char Encoding(signed char enc = -1) { char retVal = getEncoding(); if (enc != -1) encoding = enc; return retVal; }
/** Gets module markup
@@ -387,6 +420,9 @@
* @return Markup
*/
char getMarkup() const { return markup; }
+ /**
+ * @deprecated Use getMarkup
+ */
SWDEPRECATED char Markup(signed char imarkup = -1) { char retVal = getMarkup(); if (imarkup != -1) markup = imarkup; return retVal; }
/** Gets module language
@@ -394,6 +430,9 @@
* @return pointer to modlang
*/
const char *getLanguage() const { return modlang; }
+ /**
+ * @deprecated Use getLanguage
+ */
SWDEPRECATED const char *Lang(char *imodlang = 0) { if (imodlang != 0) stdstr(&modlang, imodlang); return getLanguage(); }
@@ -427,6 +466,10 @@
void *percentUserData = 0);
// for backward compat-- deprecated
+
+ /**
+ * @deprecated Use search
+ */
SWDEPRECATED ListKey &Search(const char *istr, int searchType = 0, int flags = 0, SWKey * scope = 0, bool * justCheckIfSupported = 0, void (*percent) (char, void *) = &nullPercent, void *percentUserData = 0) { return search(istr, searchType, flags, scope, justCheckIfSupported, percent, percentUserData); }
@@ -438,6 +481,9 @@
* @return pointer to allocated key. Caller is responsible for deleting the object
*/
virtual SWKey *createKey() const;
+ /**
+ * @deprecated Use createKey
+ */
SWDEPRECATED SWKey *CreateKey() const { return createKey(); }
/** This function is reimplemented by the different kinds
@@ -514,6 +560,9 @@
renderFilters->push_back(newFilter);
return *this;
}
+ /**
+ * @deprecated Use addRenderFilter
+ */
SWDEPRECATED SWModule &AddRenderFilter(SWFilter *newFilter) { return addRenderFilter(newFilter); }
/** Retrieves a container of render filters associated with this
@@ -532,6 +581,9 @@
renderFilters->remove(oldFilter);
return *this;
}
+ /**
+ * @deprecated Use removeRenderFilter
+ */
SWDEPRECATED SWModule &RemoveRenderFilter(SWFilter *oldFilter) { return removeRenderFilter(oldFilter); }
/** Replaces a RenderFilter in this module's renderfilters queue
@@ -547,6 +599,9 @@
}
return *this;
}
+ /**
+ * @deprecated Use replaceRenderFilter
+ */
SWDEPRECATED SWModule &ReplaceRenderFilter(SWFilter *oldFilter, SWFilter *newFilter) { return replaceRenderFilter(oldFilter, newFilter); }
/** RenderFilter run a buf through this module's Render Filters
@@ -568,6 +623,9 @@
encodingFilters->push_back(newFilter);
return *this;
}
+ /**
+ * @deprecated Use addEncodingFilter
+ */
SWDEPRECATED SWModule &AddEncodingFilter(SWFilter *newFilter) { return addEncodingFilter(newFilter); }
/** Removes an EncodingFilter from this module's encodingFilters queue
@@ -578,6 +636,9 @@
encodingFilters->remove(oldFilter);
return *this;
}
+ /**
+ * @deprecated Use removeEncodingFilter
+ */
SWDEPRECATED SWModule &RemoveEncodingFilter(SWFilter *oldFilter) { return removeEncodingFilter(oldFilter); }
/** Replaces an EncodingFilter in this module's encodingfilters queue
@@ -593,6 +654,9 @@
}
return *this;
}
+ /**
+ * @deprecated Use replaceEncodingFilter
+ */
SWDEPRECATED SWModule &ReplaceEncodingFilter(SWFilter *oldFilter, SWFilter *newFilter) { return replaceEncodingFilter(oldFilter, newFilter); }
/** encodingFilter run a buf through this module's Encoding Filters
@@ -613,6 +677,9 @@
stripFilters->push_back(newFilter);
return *this;
}
+ /**
+ * @deprecated Use addStripFilter
+ */
SWDEPRECATED SWModule &AddStripFilter(SWFilter *newFilter) { return addStripFilter(newFilter); }
/** Adds a RawFilter to this module's rawFilters queue
@@ -623,6 +690,9 @@
rawFilters->push_back(newFilter);
return *this;
}
+ /**
+ * @deprecated Use addRawFilter
+ */
SWDEPRECATED SWModule &AddRawFilter(SWFilter *newFilter) { return addRawFilter(newFilter); }
/** StripFilter run a buf through this module's Strip Filters
@@ -653,6 +723,9 @@
optionFilters->push_back(newFilter);
return *this;
}
+ /**
+ * @deprecated Use addOptionFilter
+ */
SWDEPRECATED SWModule &AddOptionFilter(SWOptionFilter *newFilter) { return addOptionFilter(newFilter); }
virtual const OptionFilterList &getOptionFilters() const { return *optionFilters; }
@@ -674,6 +747,9 @@
* @return result buffer
*/
virtual const char *stripText(const char *buf = 0, int len = -1);
+ /**
+ * @deprecated Use stripText
+ */
SWDEPRECATED const char *StripText(const char *buf = 0, int len = -1) { return stripText(buf, len); }
/** Produces renderable text of the current module entry or supplied text
@@ -686,6 +762,9 @@
*/
SWBuf renderText(const char *buf, int len = -1, bool render = true) const;
SWBuf renderText();
+ /**
+ * @deprecated Use renderText
+ */
SWDEPRECATED const char *RenderText(const char *buf = 0, int len = -1, bool render = true) { return renderText(buf, len, render); }
/** Produces any header data which might be useful which is associated with the
@@ -716,6 +795,9 @@
* consecutive links when iterating
*/
virtual bool isSkipConsecutiveLinks() { return skipConsecutiveLinks; }
+ /**
+ * @deprecated Use isSkipConsecutiveLinks
+ */
SWDEPRECATED bool getSkipConsecutiveLinks() { return isSkipConsecutiveLinks(); }
virtual bool isLinked(const SWKey *, const SWKey *) const { return false; }
@@ -735,6 +817,9 @@
* optimization.
*/
virtual void setProcessEntryAttributes(bool val) const { procEntAttr = val; }
+ /**
+ * @deprecated Use setProcessEntryAttributes
+ */
SWDEPRECATED void processEntryAttributes(bool val) const { setProcessEntryAttributes(val); }
/** Whether or not we're processing Entry Attributes
Modified: trunk/include/swversion.h
===================================================================
--- trunk/include/swversion.h 2020-10-24 20:23:11 UTC (rev 3819)
+++ trunk/include/swversion.h 2020-10-24 20:27:30 UTC (rev 3820)
@@ -24,12 +24,12 @@
#ifndef SWVERSION_H
#define SWVERSION_H
-#define SWORD_VERSION_NUM 1089033808
-#define SWORD_VERSION_STR "1.8.903.3808"
+#define SWORD_VERSION_NUM 1089033818
+#define SWORD_VERSION_STR "1.8.903.3818M"
#define SWORD_VERSION_MAJOR 1
#define SWORD_VERSION_MINOR 8
#define SWORD_VERSION_MICRO 903
-#define SWORD_VERSION_NANO 3808
+#define SWORD_VERSION_NANO 3818
#include <defs.h>
SWORD_NAMESPACE_START
Modified: trunk/include/versekey.h
===================================================================
--- trunk/include/versekey.h 2020-10-24 20:23:11 UTC (rev 3819)
+++ trunk/include/versekey.h 2020-10-24 20:27:30 UTC (rev 3820)
@@ -167,29 +167,44 @@
* @param lb the new lower boundary for this VerseKey
*/
void setLowerBound(const VerseKey &lb);
+ /**
+ * @deprecated Use setLowerBound / getLowerBound
+ */
SWDEPRECATED VerseKey &LowerBound(const VerseKey &lb) { setLowerBound(lb); return getLowerBound(); }
/** sets the upper boundary for this VerseKey
* @param ub the new upper boundary for this VerseKey
*/
void setUpperBound(const VerseKey &ub);
+ /**
+ * @deprecated Use setUpperBound / getUpperBound
+ */
SWDEPRECATED VerseKey &UpperBound(const VerseKey &ub) { setUpperBound(ub); return getUpperBound(); }
/** gets the lower boundary of this VerseKey
* @return the lower boundary of this VerseKey
*/
VerseKey &getLowerBound() const;
+ /**
+ * @deprecated Use getLowerBound
+ */
SWDEPRECATED VerseKey &LowerBound() const { return getLowerBound(); }
/** gets the upper boundary of this VerseKey
* @return the upper boundary of this VerseKey
*/
VerseKey &getUpperBound() const;
+ /**
+ * @deprecated Use getUpperBound
+ */
SWDEPRECATED VerseKey &UpperBound() const { return getUpperBound(); }
/** clears the boundaries of this VerseKey
*/
void clearBounds() const;
+ /**
+ * @deprecated Use clearBounds
+ */
SWDEPRECATED void ClearBounds() { clearBounds(); }
/** Creates a new SWKey based on the current VerseKey
@@ -341,6 +356,9 @@
*
*/
virtual void normalize(bool autocheck = false);
+ /**
+ * @deprecated Use normalize
+ */
SWDEPRECATED void Normalize(char autocheck = 0) { normalize(autocheck!=0); }
/** Sets flag that tells VerseKey to
@@ -429,6 +447,9 @@
* COMMENT: This code works but wreaks. Rewrite to make more maintainable.
*/
virtual ListKey parseVerseList(const char *buf, const char *defaultKey = 0, bool expandRange = false, bool useChapterAsVerse = false);
+ /**
+ * @deprecated Use parseVerseList
+ */
SWDEPRECATED ListKey ParseVerseList(const char *buf, const char *defaultKey = 0, bool expandRange = false, bool useChapterAsVerse = false) { return parseVerseList(buf, defaultKey, expandRange, useChapterAsVerse); }
virtual const char *getRangeText() const;
virtual const char *getShortRangeText() const;
More information about the sword-cvs
mailing list