Add DocC documentation archive

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.3
+// swift-tools-version:5.5
 
 import PackageDescription
 

README.md

@@ -15,11 +15,12 @@
 
 ## About SwiftKit
 
-`SwiftKit` adds extra functionality to `Swift`, like extensions to already existing types as well as completely new utilites, services etc. 
+SwiftKit adds extra functionality to the Swift framework, like extensions to already existing types as well as completely new utilites, services etc. 
 
-`SwiftKit` is divided into these areas:
+SwiftKit is divided into the following sections:
 
 * Authentication
+* Bundle
 * Data
 * Date
 * Device
@@ -33,8 +34,9 @@
 * Messaging
 * Network
 * Services
+* Validation
 
-You can explore the various sections in the demo app. Let me know if some feature is missing.
+You can explore the various sections in the documentation or in the demo app.
 
 
 ## Demo App

Release Notes.md

@@ -1,6 +1,13 @@
 # Release notes
 
-Until 1.0, breaking changes can occur in minor versions.
+
+## 1.0
+
+After a lot of waiting and stabilizing, I think it's time to push the major release button.
+
+There are no drastic changes, but I use this in most of my projects and find it very helpful and stable.  
+
+This version drastically improves documentation and ships with a DocC documentation archive. 
 
 
 

Sources/SwiftKit/Extensions/String/String+Bool.swift

@@ -0,0 +1,20 @@
+//
+//  String+Bool.swift
+//  SwiftKit
+//
+//  Created by Daniel Saidi on 2021-11-03.
+//  Copyright © 2020 Daniel Saidi. All rights reserved.
+//
+
+import Foundation
+
+public extension String {
+    
+    /**
+     Parse the potential bool value in the string.
+     
+     This function handles 1/0, yes/no, YES/NO etc., so it's
+     a good alternative to use e.g. when parsing plist files.
+     */
+    var boolValue: Bool { (self as NSString).boolValue }
+}

Sources/SwiftKit/Extensions/Url+Global.swift

@@ -8,6 +8,10 @@
 
 import Foundation
 
+/**
+ `TODO` Update this extension with the urls from this page:
+ https://github.com/FifiTheBulldog/ios-settings-urls/blob/master/settings-urls.md
+ */
 public extension URL {
     
     /**

Sources/SwiftKit/SwiftKit.docc/SwiftKit.md

@@ -0,0 +1,136 @@
+# ``SwiftKit``
+
+SwiftKit adds extra functionality to the Swift framework, like extensions to native types, utilites, services etc.
+
+
+## Overview
+
+![SwiftKit logo](Logo.png)
+
+SwiftKit is divided into the sections found in the Topics section below.
+
+You can explore the sections in the documentation or in the demo app.
+
+
+## Topics
+
+### Authentication
+
+- ``Authentication``
+- ``AuthenticationService``
+- ``AuthenticationServiceError``
+- ``BiometricAuthenticationService``
+- ``CachedAuthenticationService``
+- ``CachedAuthenticationServiceProxy``
+
+### Bundle
+
+- ``BundleInformation``
+
+### Data
+
+- ``Base64StringCoder``
+- ``CsvParser``
+- ``CsvParserError``
+- ``Filter``
+- ``FilterOption``
+- ``MimeType``
+- ``StandardCsvParser``
+- ``StringCoder``
+- ``StringDecoder``
+- ``StringEncoder``
+
+### Date
+
+This namespace contains a lot of date- and calendar-specific extensions.
+
+### Device
+
+- ``DeviceIdentifier``
+- ``KeychainBasedDeviceIdentifier``
+- ``UserDefaultsBasedDeviceIdentifier``
+
+### Extensions
+
+This namespace contains a lot of extensions and protocols that are applied to native types.
+
+- ``PreferredClosestValue``
+- ``NumericStringRepresentable``
+
+### Files
+
+- ``BundleFileFinder``
+- ``DirectoryService``
+- ``FileExporter``
+- ``FileFinder``
+- ``StandardDirectoryService``
+- ``StandardFileExporter``
+
+### Geo
+
+This namespace contains geo-specific extensions as well as utils:
+
+- ``AppleMapsService``
+- ``ExternalMapService``
+- ``GoogleMapsService``
+- ``WorldCoordinate``
+
+### iCloud
+
+This namespace contains iCloud-specific extensions as well as utils:
+
+- ``iCloudDocumentSync``
+- ``StandardiCloudDocumentSync``
+
+### IoC
+
+This namespace contains disabled `Dip` and `Swinject` containers.
+
+- ``IoC``
+- ``IoCContainer``
+
+### Keychain
+
+- ``KeychainReader``
+- ``KeychainService``
+- ``KeychainWrapper``
+- ``KeychainWriter``
+- ``StandardKeychainService``
+
+- ``KeychainAttrRepresentable``
+- ``KeychainItemAccessibility``
+
+### Localization
+
+- ``BundleTranslator``
+- ``LocalizationNotification``
+- ``LocalizationService``
+- ``StandardLocalizationService``
+- ``StandardTranslator``
+- ``Translator``
+
+### Messaging
+
+This namespace contains composer extensions.
+
+### Network
+
+- ``ApiCompletion``
+- ``ApiEnvironment``
+- ``ApiError``
+- ``ApiModel``
+- ``ApiResult``
+- ``ApiRoute``
+- ``ApiService``
+- ``HttpMethod``
+
+### Services
+
+- ``Decorator``
+- ``MultiProxy``
+- ``Proxy``
+
+### Validation
+
+- ``EmailValidator``
+- ``Validator``