summaryrefslogtreecommitdiff
path: root/include/versekey.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/versekey.h')
-rw-r--r--include/versekey.h13
1 files changed, 2 insertions, 11 deletions
diff --git a/include/versekey.h b/include/versekey.h
index acddc9d..b32b0f9 100644
--- a/include/versekey.h
+++ b/include/versekey.h
@@ -3,7 +3,7 @@
* versekey.h - code for class 'VerseKey'- a standard Biblical verse
* key
*
- * $Id: versekey.h 2833 2013-06-29 06:40:28Z chrislit $
+ * $Id: versekey.h 3541 2017-12-03 18:40:33Z scribe $
*
* Copyright 1997-2013 CrossWire Bible Society (http://www.crosswire.org)
* CrossWire Bible Society
@@ -176,7 +176,6 @@ public:
/** sets the upper boundary for this VerseKey
* @param ub the new upper boundary for this VerseKey
- * @return the upper boundary the key was set to
*/
void setUpperBound(const VerseKey &ub);
SWDEPRECATED VerseKey &UpperBound(const VerseKey &ub) { setUpperBound(ub); return getUpperBound(); }
@@ -223,21 +222,18 @@ public:
/** 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 = 1);
/** Increments key a number of verses
*
* @param steps Number of verses to jump forward
- * @return *this
*/
virtual void increment(int steps = 1);
virtual bool isTraversable() const { return true; }
@@ -348,7 +344,6 @@ public:
* Matthew 29:47 = Mark 2:2). If last verse is
* exceeded, key is set to last Book CH:VS
*
- * @return *this
*/
virtual void normalize(bool autocheck = false);
SWDEPRECATED void Normalize(char autocheck = 0) { normalize(autocheck!=0); }
@@ -357,9 +352,6 @@ public:
* automatically normalize itself when modified
*
* @param iautonorm value which to set autonorm
- * [MAXPOS(char)] - only get
- * @return if unchanged -> value of autonorm,
- * if changed -> previous value of autonorm
*/
virtual void setAutoNormalize(bool iautonorm);
virtual bool isAutoNormalize() const;
@@ -402,7 +394,6 @@ public:
/** Sets index based upon current verse
*
* @param iindex value to set index to
- * @return offset
*/
virtual void setIndex(long iindex);
@@ -423,7 +414,7 @@ public:
/** Tries to parse a string and convert it into an OSIS reference
* @param inRef reference string to try to parse
- * @param defaultKey @see ParseVerseList(..., defaultKey, ...)
+ * @param defaultKey for details @see ParseVerseList(..., defaultKey, ...)
*/
static const char *convertToOSIS(const char *inRef, const SWKey *defaultKey);