[sword-svn] r3805 - in trunk: bindings/objc/SWORD/SWORD.xcodeproj bindings/objc/SWORD/SWORD.xcodeproj/project.xcworkspace/xcuserdata/scribe.xcuserdatad bindings/objc/SWORD/SWORD.xcodeproj/xcuserdata/scribe.xcuserdatad/xcschemes include src/mgr src/utilfuns

scribe at crosswire.org scribe at crosswire.org
Sat Sep 19 08:19:28 EDT 2020


Author: scribe
Date: 2020-09-19 08:19:28 -0400 (Sat, 19 Sep 2020)
New Revision: 3805

Modified:
   trunk/bindings/objc/SWORD/SWORD.xcodeproj/project.pbxproj
   trunk/bindings/objc/SWORD/SWORD.xcodeproj/project.xcworkspace/xcuserdata/scribe.xcuserdatad/UserInterfaceState.xcuserstate
   trunk/bindings/objc/SWORD/SWORD.xcodeproj/xcuserdata/scribe.xcuserdatad/xcschemes/SWORD.xcscheme
   trunk/bindings/objc/SWORD/SWORD.xcodeproj/xcuserdata/scribe.xcuserdatad/xcschemes/SWORDUniversal.xcscheme
   trunk/include/filemgr.h
   trunk/include/installmgr.h
   trunk/include/rawfiles.h
   trunk/include/swld.h
   trunk/include/swmgr.h
   trunk/include/swmodule.h
   trunk/src/mgr/filemgr.cpp
   trunk/src/utilfuns/ftplib.c
Log:
Updated doxy comments. initialized variables at declariation for best practice.


Modified: trunk/bindings/objc/SWORD/SWORD.xcodeproj/project.pbxproj
===================================================================
--- trunk/bindings/objc/SWORD/SWORD.xcodeproj/project.pbxproj	2020-09-18 20:39:01 UTC (rev 3804)
+++ trunk/bindings/objc/SWORD/SWORD.xcodeproj/project.pbxproj	2020-09-19 12:19:28 UTC (rev 3805)
@@ -638,7 +638,7 @@
 		0A22C5031FCF26D700C02113 /* Project object */ = {
 			isa = PBXProject;
 			attributes = {
-				LastUpgradeCheck = 0910;
+				LastUpgradeCheck = 1140;
 				ORGANIZATIONNAME = "CrossWire Bible Society";
 				TargetAttributes = {
 					0A22C50A1FCF26D700C02113 = {
@@ -657,6 +657,7 @@
 			hasScannedForEncodings = 0;
 			knownRegions = (
 				en,
+				Base,
 			);
 			mainGroup = 0A22C5021FCF26D700C02113;
 			productRefGroup = 0A22C50C1FCF26D700C02113 /* Products */;
@@ -878,6 +879,7 @@
 				CLANG_WARN_BOOL_CONVERSION = YES;
 				CLANG_WARN_COMMA = YES;
 				CLANG_WARN_CONSTANT_CONVERSION = YES;
+				CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES;
 				CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
 				CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
 				CLANG_WARN_EMPTY_BODY = YES;
@@ -885,6 +887,7 @@
 				CLANG_WARN_INFINITE_RECURSION = YES;
 				CLANG_WARN_INT_CONVERSION = YES;
 				CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES;
+				CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
 				CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
 				CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
 				CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
@@ -919,6 +922,7 @@
 				);
 				IPHONEOS_DEPLOYMENT_TARGET = 9.0;
 				MTL_ENABLE_DEBUG_INFO = YES;
+				ONLY_ACTIVE_ARCH = YES;
 				OTHER_CFLAGS = (
 					"-DUNIX",
 					"-Dunix",
@@ -951,6 +955,7 @@
 				CLANG_WARN_BOOL_CONVERSION = YES;
 				CLANG_WARN_COMMA = YES;
 				CLANG_WARN_CONSTANT_CONVERSION = YES;
+				CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES;
 				CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
 				CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
 				CLANG_WARN_EMPTY_BODY = YES;
@@ -958,6 +963,7 @@
 				CLANG_WARN_INFINITE_RECURSION = YES;
 				CLANG_WARN_INT_CONVERSION = YES;
 				CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES;
+				CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
 				CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
 				CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
 				CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;

Modified: trunk/bindings/objc/SWORD/SWORD.xcodeproj/project.xcworkspace/xcuserdata/scribe.xcuserdatad/UserInterfaceState.xcuserstate
===================================================================
(Binary files differ)

Modified: trunk/bindings/objc/SWORD/SWORD.xcodeproj/xcuserdata/scribe.xcuserdatad/xcschemes/SWORD.xcscheme
===================================================================
--- trunk/bindings/objc/SWORD/SWORD.xcodeproj/xcuserdata/scribe.xcuserdatad/xcschemes/SWORD.xcscheme	2020-09-18 20:39:01 UTC (rev 3804)
+++ trunk/bindings/objc/SWORD/SWORD.xcodeproj/xcuserdata/scribe.xcuserdatad/xcschemes/SWORD.xcscheme	2020-09-19 12:19:28 UTC (rev 3805)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0910"
+   LastUpgradeVersion = "1140"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
@@ -26,18 +26,14 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      language = ""
       shouldUseLaunchSchemeArgsEnv = "YES">
       <Testables>
       </Testables>
-      <AdditionalOptions>
-      </AdditionalOptions>
    </TestAction>
    <LaunchAction
       buildConfiguration = "Release"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      language = ""
       launchStyle = "0"
       useCustomWorkingDirectory = "NO"
       ignoresPersistentStateOnLaunch = "NO"
@@ -53,8 +49,6 @@
             ReferencedContainer = "container:SWORD.xcodeproj">
          </BuildableReference>
       </MacroExpansion>
-      <AdditionalOptions>
-      </AdditionalOptions>
    </LaunchAction>
    <ProfileAction
       buildConfiguration = "Release"

Modified: trunk/bindings/objc/SWORD/SWORD.xcodeproj/xcuserdata/scribe.xcuserdatad/xcschemes/SWORDUniversal.xcscheme
===================================================================
--- trunk/bindings/objc/SWORD/SWORD.xcodeproj/xcuserdata/scribe.xcuserdatad/xcschemes/SWORDUniversal.xcscheme	2020-09-18 20:39:01 UTC (rev 3804)
+++ trunk/bindings/objc/SWORD/SWORD.xcodeproj/xcuserdata/scribe.xcuserdatad/xcschemes/SWORDUniversal.xcscheme	2020-09-19 12:19:28 UTC (rev 3805)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0910"
+   LastUpgradeVersion = "1140"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
@@ -26,18 +26,14 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      language = ""
       shouldUseLaunchSchemeArgsEnv = "YES">
       <Testables>
       </Testables>
-      <AdditionalOptions>
-      </AdditionalOptions>
    </TestAction>
    <LaunchAction
       buildConfiguration = "Release"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      language = ""
       launchStyle = "0"
       useCustomWorkingDirectory = "NO"
       ignoresPersistentStateOnLaunch = "NO"
@@ -53,8 +49,6 @@
             ReferencedContainer = "container:SWORD.xcodeproj">
          </BuildableReference>
       </MacroExpansion>
-      <AdditionalOptions>
-      </AdditionalOptions>
    </LaunchAction>
    <ProfileAction
       buildConfiguration = "Release"

Modified: trunk/include/filemgr.h
===================================================================
--- trunk/include/filemgr.h	2020-09-18 20:39:01 UTC (rev 3804)
+++ trunk/include/filemgr.h	2020-09-19 12:19:28 UTC (rev 3805)
@@ -101,7 +101,7 @@
 	* The file itself will only be opened when FileDesc::getFd() is called.
 	* @param path Filename.
 	* @param mode File access mode.
-	* @param tryDowngrade
+	* @param tryDowngrade if we can't open the file for permissions requested, try to open the file with less permissions
 	* @return FileDesc object for the requested file.
 	*/
 	FileDesc *open(const char *path, int mode, bool tryDowngrade);
@@ -130,7 +130,7 @@
 	virtual long resourceConsumption();
 
 	/** Get an environment variable from the OS
-	* @param variableName
+	* @param variableName the name of the env variable to retrieve
 	*
 	* @return variable value from the OS
 	*/

Modified: trunk/include/installmgr.h
===================================================================
--- trunk/include/installmgr.h	2020-09-18 20:39:01 UTC (rev 3804)
+++ trunk/include/installmgr.h	2020-09-19 12:19:28 UTC (rev 3805)
@@ -283,7 +283,7 @@
 	 * 	vector describing the status of each.  See MODSTAT_*
 	 * @param base The base SWMgr to compare-- usually represents what is currently installed
 	 * @param other The other SWMgr to compare to base-- usually represents an install source's SWMgr
-	 * @param utilModule whether to show user modules or utility modules; user modules is the default
+	 * @param utilModules whether to show user modules or utility modules; user modules is the default
 	 */
 	static std::map<SWModule *, int> getModuleStatus(const SWMgr &base, const SWMgr &other, bool utilModules = false);
 

Modified: trunk/include/rawfiles.h
===================================================================
--- trunk/include/rawfiles.h	2020-09-18 20:39:01 UTC (rev 3804)
+++ trunk/include/rawfiles.h	2020-09-19 12:19:28 UTC (rev 3805)
@@ -54,17 +54,18 @@
 	* @param path The first parameter is path of the new module
 	* @return error
 	*/
-	static char createModule(const char *);
+	static char createModule(const char *path);
 
 	/** Modify the current module entry text
 	* - only if module @ref isWritable
-	* @return *this
+	* @param inbuf the text of the entry to set
+	* @param len optional len to set the modules entry.  If not passed, strlen will be performed on @ref inbuf
 	*/
 	virtual void setEntry(const char *inbuf, long len = -1);	// Modify current module entry
 
 	/** Link the current module entry to another module entry
 	* - only if module @ref isWritable
-	* @return *this
+	* @param linkKey the entry key to which this current entry should be linked.
 	*/
 	virtual void linkEntry(const SWKey *linkKey);	// Link current module entry to other module entry
 

Modified: trunk/include/swld.h
===================================================================
--- trunk/include/swld.h	2020-09-18 20:39:01 UTC (rev 3804)
+++ trunk/include/swld.h	2020-09-19 12:19:28 UTC (rev 3805)
@@ -49,10 +49,8 @@
 	virtual ~SWLD();
 	virtual SWKey *createKey() const;
 
-	/** Sets/gets module KeyText, getting from saved text if key is persistent
+	/** gets module KeyText, getting from saved key if key is persistent
 	*
-	* @param ikeytext value which to set keytext;
-	*  [0] - only get
 	* @return pointer to keytext
 	*/
 	virtual const char *getKeyText() const;

Modified: trunk/include/swmgr.h
===================================================================
--- trunk/include/swmgr.h	2020-09-18 20:39:01 UTC (rev 3804)
+++ trunk/include/swmgr.h	2020-09-19 12:19:28 UTC (rev 3805)
@@ -464,7 +464,7 @@
 	virtual StringList getGlobalOptionValues(const char *option);
 
 	/** Filters a buffer thru a named filter
-	 * @param filterName
+	 * @param filterName name of filter which the buffer should be filtered through
 	 * @param text buffer to filter
 	 * @param key context key if filter needs this for processing
 	 * @param module context module if filter needs this for processing

Modified: trunk/include/swmodule.h
===================================================================
--- trunk/include/swmodule.h	2020-09-18 20:39:01 UTC (rev 3804)
+++ trunk/include/swmodule.h	2020-09-19 12:19:28 UTC (rev 3805)
@@ -235,7 +235,7 @@
 	 * Sets this module's key to provided keyText without disturbing any settings on the a key itself
 	 * This is simply a shortcut for the common module->getKey()->setText(keyText);
 	 *
-	 * @param ikey key with which to set this module
+	 * @param keyText key with which to set this module
 	 * @return error status
 	 */
 	inline char setKeyText(const char *keyText) { getKey()->setText(keyText); return key->getError(); }

Modified: trunk/src/mgr/filemgr.cpp
===================================================================
--- trunk/src/mgr/filemgr.cpp	2020-09-18 20:39:01 UTC (rev 3804)
+++ trunk/src/mgr/filemgr.cpp	2020-09-19 12:19:28 UTC (rev 3805)
@@ -516,7 +516,7 @@
 
 
 char FileMgr::getLine(FileDesc *fDesc, SWBuf &line) {
-	int len;
+	int len = 0;
 	bool more = true;
 	char chunk[255];
 

Modified: trunk/src/utilfuns/ftplib.c
===================================================================
--- trunk/src/utilfuns/ftplib.c	2020-09-18 20:39:01 UTC (rev 3804)
+++ trunk/src/utilfuns/ftplib.c	2020-09-19 12:19:28 UTC (rev 3805)
@@ -847,7 +847,7 @@
     int i;
     struct timeval tv;
     fd_set mask;
-    int rv;
+    int rv = 0;
 
     FD_ZERO(&mask);
     FD_SET(nControl->handle, &mask);



More information about the sword-cvs mailing list