[sword-svn] r3541 - in branches/sword-1-8-x: . include src/mgr
scribe at crosswire.org
scribe at crosswire.org
Sun Dec 3 11:40:33 MST 2017
Author: scribe
Date: 2017-12-03 11:40:33 -0700 (Sun, 03 Dec 2017)
New Revision: 3541
Modified:
branches/sword-1-8-x/
branches/sword-1-8-x/include/listkey.h
branches/sword-1-8-x/include/swbuf.h
branches/sword-1-8-x/include/swmgr.h
branches/sword-1-8-x/include/swmodule.h
branches/sword-1-8-x/include/versekey.h
branches/sword-1-8-x/src/mgr/rtranspgdrive.cpp
Log:
merged in some header dox cleanup and a compile error for new gdrive transport shell
Property changes on: branches/sword-1-8-x
___________________________________________________________________
Modified: svn:mergeinfo
- /trunk:3459-3471,3473,3475,3477-3482,3485-3514,3516,3518-3523,3525-3536,3538
+ /trunk:3459-3471,3473,3475,3477-3482,3485-3514,3516,3518-3523,3525-3536,3538,3540
Modified: branches/sword-1-8-x/include/listkey.h
===================================================================
--- branches/sword-1-8-x/include/listkey.h 2017-12-03 18:37:05 UTC (rev 3540)
+++ branches/sword-1-8-x/include/listkey.h 2017-12-03 18:40:33 UTC (rev 3541)
@@ -89,7 +89,7 @@
* @return error status
* deprecated use setToElement
*/
- virtual char setToElement(int ielement, SW_POSITION = TOP);
+ virtual char setToElement(int ielement, SW_POSITION pos = TOP);
// deprecated use setToElement
SWDEPRECATED virtual char SetToElement(int ielement, SW_POSITION pos = TOP) { return setToElement(ielement, pos); }
@@ -122,7 +122,6 @@
/** Positions this key
*
* @param pos position
- * @return *this
*/
virtual void setPosition(SW_POSITION pos);
Modified: branches/sword-1-8-x/include/swbuf.h
===================================================================
--- branches/sword-1-8-x/include/swbuf.h 2017-12-03 18:37:05 UTC (rev 3540)
+++ branches/sword-1-8-x/include/swbuf.h 2017-12-03 18:40:33 UTC (rev 3541)
@@ -295,7 +295,7 @@
* If the allocated memory is not enough, it will be resized accordingly.
* NOTE: This is dangerous, as wchar_t is currently different sizes on different
* platforms (stupid windoze; stupid c++ spec for not mandating 4byte).
- * @param ch Append this.
+ * @param wch Append this.
*/
inline SWBuf &append(wchar_t wch) {
assureMore(sizeof(wchar_t)*2);
Modified: branches/sword-1-8-x/include/swmgr.h
===================================================================
--- branches/sword-1-8-x/include/swmgr.h 2017-12-03 18:37:05 UTC (rev 3540)
+++ branches/sword-1-8-x/include/swmgr.h 2017-12-03 18:40:33 UTC (rev 3541)
@@ -354,7 +354,7 @@
*
* @param iconfig manually supply a configuration. If not supplied, SWMgr will look on the system
* using a complex hierarchical search. See README for detailed specifics.
- * @param isysconfig
+ * @param isysconfig manually supply a an isysconfig (e.g. /etc/sword.conf)
* @param autoload whether or not to immediately load modules on construction of this SWMgr.
* If you reimplemented SWMgr you can set this to false and call SWMgr::load() after you have
* completed the contruction and setup of your SWMgr subclass.
Modified: branches/sword-1-8-x/include/swmodule.h
===================================================================
--- branches/sword-1-8-x/include/swmodule.h 2017-12-03 18:37:05 UTC (rev 3540)
+++ branches/sword-1-8-x/include/swmodule.h 2017-12-03 18:40:33 UTC (rev 3541)
@@ -349,31 +349,27 @@
/** Sets/gets module direction
*
- * @param newdir Value which to set direction; [-1]-only get
* @return new direction
*/
virtual char getDirection() const;
SWDEPRECATED char Direction(signed char newdir = -1) { char retVal = getDirection(); if (newdir != -1) return direction = newdir; return retVal; }
- /** Sets/gets module encoding
+ /** Gets module encoding
*
- * @param enc Value which to set encoding; [-1]-only get
* @return Encoding
*/
char getEncoding() const { return encoding; }
SWDEPRECATED char Encoding(signed char enc = -1) { char retVal = getEncoding(); if (enc != -1) encoding = enc; return retVal; }
- /** Sets/gets module markup
+ /** Gets module markup
*
- * @param markup Value which to set markup; [-1]-only get
* @return Markup
*/
char getMarkup() const { return markup; }
SWDEPRECATED char Markup(signed char imarkup = -1) { char retVal = getMarkup(); if (imarkup != -1) markup = imarkup; return retVal; }
- /** Sets/gets module language
+ /** Gets module language
*
- * @param imodlang Value which to set modlang; [0]-only get
* @return pointer to modlang
*/
const char *getLanguage() const { return modlang; }
@@ -487,7 +483,7 @@
/** Adds a RenderFilter to this module's renderFilters queue.
* Render Filters are called when the module is asked to produce
* renderable text.
- * @param newfilter the filter to add
+ * @param newFilter the filter to add
* @return *this
*/
virtual SWModule &addRenderFilter(SWFilter *newFilter) {
@@ -505,7 +501,7 @@
}
/** Removes a RenderFilter from this module's renderFilters queue
- * @param oldfilter the filter to remove
+ * @param oldFilter the filter to remove
* @return *this
*/
virtual SWModule &removeRenderFilter(SWFilter *oldFilter) {
@@ -515,8 +511,8 @@
SWDEPRECATED SWModule &RemoveRenderFilter(SWFilter *oldFilter) { return removeRenderFilter(oldFilter); }
/** Replaces a RenderFilter in this module's renderfilters queue
- * @param oldfilter the filter to remove
- * @param newfilter the filter to add in its place
+ * @param oldFilter the filter to remove
+ * @param newFilter the filter to add in its place
* @return *this
*/
virtual SWModule &replaceRenderFilter(SWFilter *oldFilter, SWFilter *newFilter) {
@@ -541,7 +537,7 @@
* Encoding Filters are called immediately when the module is read
* from data source, to assure we have desired internal data stream
* (e.g. UTF-8 for text modules)
- * @param newfilter the filter to add
+ * @param newFilter the filter to add
* @return *this
*/
virtual SWModule &addEncodingFilter(SWFilter *newFilter) {
@@ -551,7 +547,7 @@
SWDEPRECATED SWModule &AddEncodingFilter(SWFilter *newFilter) { return addEncodingFilter(newFilter); }
/** Removes an EncodingFilter from this module's encodingFilters queue
- * @param oldfilter the filter to remove
+ * @param oldFilter the filter to remove
* @return *this
*/
virtual SWModule &removeEncodingFilter(SWFilter *oldFilter) {
@@ -561,8 +557,8 @@
SWDEPRECATED SWModule &RemoveEncodingFilter(SWFilter *oldFilter) { return removeEncodingFilter(oldFilter); }
/** Replaces an EncodingFilter in this module's encodingfilters queue
- * @param oldfilter the filter to remove
- * @param newfilter the filter to add in its place
+ * @param oldFilter the filter to remove
+ * @param newFilter the filter to add in its place
* @return *this
*/
virtual SWModule &replaceEncodingFilter(SWFilter *oldFilter, SWFilter *newFilter) {
@@ -586,7 +582,7 @@
/** Adds a StripFilter to this module's stripFilters queue.
* Strip filters are called when a module is asked to render
* an entry without any markup (like when searching).
- * @param newfilter the filter to add
+ * @param newFilter the filter to add
* @return *this
*/
virtual SWModule &addStripFilter(SWFilter *newFilter) {
@@ -599,8 +595,8 @@
* @param newFilter the filter to add
* @return *this
*/
- virtual SWModule &addRawFilter(SWFilter *newfilter) {
- rawFilters->push_back(newfilter);
+ virtual SWModule &addRawFilter(SWFilter *newFilter) {
+ rawFilters->push_back(newFilter);
return *this;
}
SWDEPRECATED SWModule &AddRawFilter(SWFilter *newFilter) { return addRawFilter(newFilter); }
@@ -626,7 +622,7 @@
* Option Filters are used to turn options in the text on
* or off, or so some other state (e.g. Strong's Number,
* Footnotes, Cross References, etc.)
- * @param newfilter the filter to add
+ * @param newFilter the filter to add
* @return *this
*/
virtual SWModule &addOptionFilter(SWOptionFilter *newFilter) {
@@ -662,8 +658,8 @@
* @param render for internal use
* @return result buffer
*/
- SWBuf renderText();
SWBuf renderText(const char *buf, int len = -1, bool render = true) const;
+ SWBuf 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
Modified: branches/sword-1-8-x/include/versekey.h
===================================================================
--- branches/sword-1-8-x/include/versekey.h 2017-12-03 18:37:05 UTC (rev 3540)
+++ branches/sword-1-8-x/include/versekey.h 2017-12-03 18:40:33 UTC (rev 3541)
@@ -176,7 +176,6 @@
/** 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 @@
/** 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 @@
* 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 @@
* 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 @@
/** Sets index based upon current verse
*
* @param iindex value to set index to
- * @return offset
*/
virtual void setIndex(long iindex);
@@ -423,7 +414,7 @@
/** 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);
Modified: branches/sword-1-8-x/src/mgr/rtranspgdrive.cpp
===================================================================
--- branches/sword-1-8-x/src/mgr/rtranspgdrive.cpp 2017-12-03 18:37:05 UTC (rev 3540)
+++ branches/sword-1-8-x/src/mgr/rtranspgdrive.cpp 2017-12-03 18:40:33 UTC (rev 3541)
@@ -101,7 +101,7 @@
char RTransportGDrive::putURL(const char *destURL, const char *sourcePath, SWBuf *sourceBuf) {
- return RemoteTransport::putURL();
+ return RemoteTransport::putURL(destURL, sourcePath, sourceBuf);
}
char RTransportGDrive::getURL(const char *destPath, const char *sourceURL, SWBuf *destBuf) {
signed char retVal = 0;
More information about the sword-cvs
mailing list