Merge pull request #25 from ZekeSnider/zeke.documentation

Improve Documentation
ZekeSnider · Feb 9, 2019 · 9a58c72 · 9a58c72
2 parents 4f51554 + 7e7936a
commit 9a58c72
Show file tree

Hide file tree

Showing 21 changed files with 229 additions and 354 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1 +1,2 @@
-Pods/* linguist-vendored
+Pods/* linguist-vendored
+SampleModule/JaredFramework.framework/* linguist-vendored
diff --git a/GetRecentMessages.sql b/GetRecentMessages.sql
diff --git a/JaredTests/MessageTests.swift b/JaredTests/MessageTests.swift
@@ -9,9 +9,6 @@
 import XCTest
 import JaredFramework
 
-
-
-
 class MessageTests: XCTestCase {
     let textBody = TextBody("Hey Jared")
 

diff --git a/JaredUI/Assets.xcassets/Jared.dataset/Contents.json b/JaredUI/Assets.xcassets/Jared.dataset/Contents.json
diff --git a/JaredUI/Assets.xcassets/Jared.dataset/Jared.applescript b/JaredUI/Assets.xcassets/Jared.dataset/Jared.applescript
diff --git a/JaredUI/Info.plist b/JaredUI/Info.plist
@@ -21,7 +21,7 @@
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>
-	<string>315</string>
+	<string>317</string>
 	<key>LSApplicationCategoryType</key>
 	<string>public.app-category.utilities</string>
 	<key>LSMinimumSystemVersion</key>

diff --git a/SampleModule/EmoteModule.xcodeproj/project.pbxproj b/SampleModule/EmoteModule.xcodeproj/project.pbxproj
@@ -82,7 +82,7 @@
 		B39A65F61CC20181003E26B0 /* Project object */ = {
 			isa = PBXProject;
 			attributes = {
-				LastUpgradeCheck = 0730;
+				LastUpgradeCheck = 1010;
 				ORGANIZATIONNAME = "Zeke Snider";
 				TargetAttributes = {
 					B39A65FD1CC20181003E26B0 = {
@@ -138,13 +138,23 @@
 				CLANG_CXX_LIBRARY = "libc++";
 				CLANG_ENABLE_MODULES = YES;
 				CLANG_ENABLE_OBJC_ARC = YES;
+				CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES;
 				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_EMPTY_BODY = YES;
 				CLANG_WARN_ENUM_CONVERSION = YES;
+				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;
+				CLANG_WARN_STRICT_PROTOTYPES = YES;
+				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				CODE_SIGN_IDENTITY = "-";
@@ -166,7 +176,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				MACOSX_DEPLOYMENT_TARGET = 10.11;
+				MACOSX_DEPLOYMENT_TARGET = 10.13;
 				MTL_ENABLE_DEBUG_INFO = YES;
 				ONLY_ACTIVE_ARCH = YES;
 				SDKROOT = macosx;
@@ -182,13 +192,23 @@
 				CLANG_CXX_LIBRARY = "libc++";
 				CLANG_ENABLE_MODULES = YES;
 				CLANG_ENABLE_OBJC_ARC = YES;
+				CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES;
 				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_EMPTY_BODY = YES;
 				CLANG_WARN_ENUM_CONVERSION = YES;
+				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;
+				CLANG_WARN_STRICT_PROTOTYPES = YES;
+				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				CODE_SIGN_IDENTITY = "-";
@@ -204,18 +224,19 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				MACOSX_DEPLOYMENT_TARGET = 10.11;
+				MACOSX_DEPLOYMENT_TARGET = 10.13;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				SDKROOT = macosx;
+				SWIFT_COMPILATION_MODE = wholemodule;
 			};
 			name = Release;
 		};
 		B39A66051CC20181003E26B0 /* Debug */ = {
 			isa = XCBuildConfiguration;
 			buildSettings = {
+				ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;
 				CLANG_ENABLE_MODULES = YES;
 				COMBINE_HIDPI_IMAGES = YES;
-				EMBEDDED_CONTENT_CONTAINS_SWIFT = YES;
 				FRAMEWORK_SEARCH_PATHS = (
 					"$(inherited)",
 					"$(PROJECT_DIR)/EmoteModule",
@@ -229,16 +250,17 @@
 				SKIP_INSTALL = YES;
 				SWIFT_OBJC_BRIDGING_HEADER = "";
 				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
+				SWIFT_VERSION = 4.2;
 				WRAPPER_EXTENSION = bundle;
 			};
 			name = Debug;
 		};
 		B39A66061CC20181003E26B0 /* Release */ = {
 			isa = XCBuildConfiguration;
 			buildSettings = {
+				ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;
 				CLANG_ENABLE_MODULES = YES;
 				COMBINE_HIDPI_IMAGES = YES;
-				EMBEDDED_CONTENT_CONTAINS_SWIFT = YES;
 				FRAMEWORK_SEARCH_PATHS = (
 					"$(inherited)",
 					"$(PROJECT_DIR)/EmoteModule",
@@ -251,6 +273,7 @@
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SKIP_INSTALL = YES;
 				SWIFT_OBJC_BRIDGING_HEADER = "";
+				SWIFT_VERSION = 4.2;
 				WRAPPER_EXTENSION = bundle;
 			};
 			name = Release;

diff --git a/SampleModule/EmoteModule.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/SampleModule/EmoteModule.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IDEDidComputeMac32BitWarning</key>
+	<true/>
+</dict>
+</plist>
diff --git a/...leModule/EmoteModule.xcodeproj/xcuserdata/Zeke.xcuserdatad/xcschemes/EmoteModule.xcscheme b/...leModule/EmoteModule.xcodeproj/xcuserdata/Zeke.xcuserdatad/xcschemes/EmoteModule.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0730"
+   LastUpgradeVersion = "1010"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/SampleModule/EmoteModule/main.swift b/SampleModule/EmoteModule/main.swift
@@ -14,12 +14,12 @@ public class EmoteModule: RoutingModule {
     public var description = "A Description"
 
     required public init() {
-        let aRoute = Route(name: "test function", comparisons: [.StartsWith: ["/moduletest"]], call: self.test, description: "TEST")
+        let aRoute = Route(name: "test function", comparisons: [.startsWith: ["/moduletest"]], call: self.test, description: "TEST")
         routes = [aRoute]
     }
 
-    public func test(message:String, myRoom: Room) -> Void {
-        SendText("This command was loaded from a modularized bundle.", toRoom: myRoom)
+    public func test(message: Message) -> Void {
+        Jared.Send("This command was loaded from a modularized bundle.", to: message.RespondTo())
     }
 }