From 34fcce80190ee51525a53183b59a4d92ef6d5c96 Mon Sep 17 00:00:00 2001 From: Rob Jonson Date: Fri, 30 Jul 2021 14:42:32 +0100 Subject: [PATCH] More docs --- Sources/HSUIKit/UIViewController+Alert.swift | 1 + Sources/HSUIKit/UIViewController+Email.swift | 1 + Sources/HSUIKit/UIViewController+HS.swift | 7 ++++++- .../HSUIKit/UIViewController+Preview.swift | 2 +- Sources/HSUIKit/UIViewController+Safari.swift | 1 + Sources/HSUIKit/UIViewController+Share.swift | 2 ++ docs/Classes.html | 3 ++- docs/Classes/ShareItem.html | 3 ++- docs/Extensions.html | 3 ++- docs/Extensions/UIViewController.html | 3 ++- docs/Protocols.html | 6 ++++-- docs/Protocols/CanShowPreview.html | 3 ++- docs/Protocols/CanShowSafari.html | 3 ++- .../Contents/Resources/Documents/Classes.html | 3 ++- .../Documents/Classes/ShareItem.html | 3 ++- .../Resources/Documents/Extensions.html | 3 ++- .../Extensions/UIViewController.html | 3 ++- .../Resources/Documents/Protocols.html | 6 ++++-- .../Documents/Protocols/CanShowPreview.html | 3 ++- .../Documents/Protocols/CanShowSafari.html | 3 ++- .../Contents/Resources/Documents/index.html | 4 ++++ docs/docsets/.tgz | Bin 171173 -> 171463 bytes docs/index.html | 4 ++++ document.sh | 2 +- 24 files changed, 53 insertions(+), 19 deletions(-) diff --git a/Sources/HSUIKit/UIViewController+Alert.swift b/Sources/HSUIKit/UIViewController+Alert.swift index d153bd4..538f94e 100644 --- a/Sources/HSUIKit/UIViewController+Alert.swift +++ b/Sources/HSUIKit/UIViewController+Alert.swift @@ -12,6 +12,7 @@ import Foundation import UIKit +/// Add this to any UIViewController to let it easily present an Alert public extension UIViewController { func showAlert(title:String?,message:String?,cancelButton:String = "Cancel") { diff --git a/Sources/HSUIKit/UIViewController+Email.swift b/Sources/HSUIKit/UIViewController+Email.swift index cde9b5c..c8ee44f 100644 --- a/Sources/HSUIKit/UIViewController+Email.swift +++ b/Sources/HSUIKit/UIViewController+Email.swift @@ -29,6 +29,7 @@ public protocol CanSendEmail:MFMailComposeViewControllerDelegate { func sendEmail(to:[String],subject:String,body:String, isHtml:Bool,attachments:[EmailAttachment]); } +/// Add this to any UIViewController to let it easily send an email public extension CanSendEmail where Self: UIViewController { /// Send using mailto diff --git a/Sources/HSUIKit/UIViewController+HS.swift b/Sources/HSUIKit/UIViewController+HS.swift index 44a47b7..5b3531f 100644 --- a/Sources/HSUIKit/UIViewController+HS.swift +++ b/Sources/HSUIKit/UIViewController+HS.swift @@ -18,9 +18,14 @@ public protocol FromStoryboard: class { static func fromStoryboard() -> Self } +/// Provide easy way to load UIController from storyboard using convention over configuration +/// MyViewController.fromStoryboard() +/// Default (overridable) assumptions are: +/// storyboard filename is MyViewController.storyboard +/// storyboardID should be set in the file as MyViewController +/// file should contain a single view controller whichis set as the initial controller public extension FromStoryboard where Self: UIViewController { - /// Load VC from storyboard /// Storyboard ID is by default assumed to be the class name /// - Returns: the VC diff --git a/Sources/HSUIKit/UIViewController+Preview.swift b/Sources/HSUIKit/UIViewController+Preview.swift index 7d28407..3150297 100644 --- a/Sources/HSUIKit/UIViewController+Preview.swift +++ b/Sources/HSUIKit/UIViewController+Preview.swift @@ -11,7 +11,7 @@ import Foundation import UIKit - +/// Add this to any UIViewController to let it easily present a UIDocumentInteractionController controller using openPreview(...) public protocol CanShowPreview { func openPreview(url:URL,animated:Bool) } diff --git a/Sources/HSUIKit/UIViewController+Safari.swift b/Sources/HSUIKit/UIViewController+Safari.swift index 641d8a3..b023939 100644 --- a/Sources/HSUIKit/UIViewController+Safari.swift +++ b/Sources/HSUIKit/UIViewController+Safari.swift @@ -10,6 +10,7 @@ import Foundation import SafariServices +/// Add this to any UIViewController to let it easily present a SFSafariView controller using openSafari(url:) public protocol CanShowSafari { func openSafari(url:URL,tint:UIColor?) } diff --git a/Sources/HSUIKit/UIViewController+Share.swift b/Sources/HSUIKit/UIViewController+Share.swift index 1f81e42..12b08c6 100644 --- a/Sources/HSUIKit/UIViewController+Share.swift +++ b/Sources/HSUIKit/UIViewController+Share.swift @@ -10,6 +10,7 @@ import Foundation import UIKit +//Easily share an item using UIActivityViewController public extension UIViewController { @objc @@ -33,6 +34,7 @@ public extension UIViewController { } @objc +/// Item to share Url, UIImage, etc public class ShareItem: NSObject, UIActivityItemSource { private let subject:String diff --git a/docs/Classes.html b/docs/Classes.html index 3c345df..ea2ce86 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -531,7 +531,8 @@

Declaration

- +

Item to share Url, UIImage, etc

+ See more
diff --git a/docs/Classes/ShareItem.html b/docs/Classes/ShareItem.html index a4661a4..35500ba 100644 --- a/docs/Classes/ShareItem.html +++ b/docs/Classes/ShareItem.html @@ -345,7 +345,8 @@

ShareItem

- +

Item to share Url, UIImage, etc

+
diff --git a/docs/Extensions.html b/docs/Extensions.html index 1451c61..5155aad 100644 --- a/docs/Extensions.html +++ b/docs/Extensions.html @@ -1810,7 +1810,8 @@

Declaration

- +

Add this to any UIViewController to let it easily present an Alert

+ See more
diff --git a/docs/Extensions/UIViewController.html b/docs/Extensions/UIViewController.html index eb00b63..482d20c 100644 --- a/docs/Extensions/UIViewController.html +++ b/docs/Extensions/UIViewController.html @@ -345,7 +345,8 @@

UIViewController

- +

Add this to any UIViewController to let it easily present an Alert

+
diff --git a/docs/Protocols.html b/docs/Protocols.html index b8581e0..2bd8bbc 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -519,7 +519,8 @@

Declaration

- +

Add this to any UIViewController to let it easily present a UIDocumentInteractionController controller using openPreview(…)

+ See more
@@ -538,7 +539,8 @@

Declaration

- +

Add this to any UIViewController to let it easily present a SFSafariView controller using openSafari(url:)

+ See more
diff --git a/docs/Protocols/CanShowPreview.html b/docs/Protocols/CanShowPreview.html index a9bcbea..75e843e 100644 --- a/docs/Protocols/CanShowPreview.html +++ b/docs/Protocols/CanShowPreview.html @@ -345,7 +345,8 @@

CanShowPreview

- +

Add this to any UIViewController to let it easily present a UIDocumentInteractionController controller using openPreview(…)

+
diff --git a/docs/Protocols/CanShowSafari.html b/docs/Protocols/CanShowSafari.html index 3f60f84..db0873d 100644 --- a/docs/Protocols/CanShowSafari.html +++ b/docs/Protocols/CanShowSafari.html @@ -345,7 +345,8 @@

CanShowSafari

- +

Add this to any UIViewController to let it easily present a SFSafariView controller using openSafari(url:)

+
diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/.docset/Contents/Resources/Documents/Classes.html index 3c345df..ea2ce86 100644 --- a/docs/docsets/.docset/Contents/Resources/Documents/Classes.html +++ b/docs/docsets/.docset/Contents/Resources/Documents/Classes.html @@ -531,7 +531,8 @@

Declaration

- +

Item to share Url, UIImage, etc

+ See more
diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Classes/ShareItem.html b/docs/docsets/.docset/Contents/Resources/Documents/Classes/ShareItem.html index a4661a4..35500ba 100644 --- a/docs/docsets/.docset/Contents/Resources/Documents/Classes/ShareItem.html +++ b/docs/docsets/.docset/Contents/Resources/Documents/Classes/ShareItem.html @@ -345,7 +345,8 @@

ShareItem

- +

Item to share Url, UIImage, etc

+
diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Extensions.html b/docs/docsets/.docset/Contents/Resources/Documents/Extensions.html index 1451c61..5155aad 100644 --- a/docs/docsets/.docset/Contents/Resources/Documents/Extensions.html +++ b/docs/docsets/.docset/Contents/Resources/Documents/Extensions.html @@ -1810,7 +1810,8 @@

Declaration

- +

Add this to any UIViewController to let it easily present an Alert

+ See more
diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UIViewController.html b/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UIViewController.html index eb00b63..482d20c 100644 --- a/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UIViewController.html +++ b/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UIViewController.html @@ -345,7 +345,8 @@

UIViewController

- +

Add this to any UIViewController to let it easily present an Alert

+
diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Protocols.html b/docs/docsets/.docset/Contents/Resources/Documents/Protocols.html index b8581e0..2bd8bbc 100644 --- a/docs/docsets/.docset/Contents/Resources/Documents/Protocols.html +++ b/docs/docsets/.docset/Contents/Resources/Documents/Protocols.html @@ -519,7 +519,8 @@

Declaration

- +

Add this to any UIViewController to let it easily present a UIDocumentInteractionController controller using openPreview(…)

+ See more
@@ -538,7 +539,8 @@

Declaration

- +

Add this to any UIViewController to let it easily present a SFSafariView controller using openSafari(url:)

+ See more
diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Protocols/CanShowPreview.html b/docs/docsets/.docset/Contents/Resources/Documents/Protocols/CanShowPreview.html index a9bcbea..75e843e 100644 --- a/docs/docsets/.docset/Contents/Resources/Documents/Protocols/CanShowPreview.html +++ b/docs/docsets/.docset/Contents/Resources/Documents/Protocols/CanShowPreview.html @@ -345,7 +345,8 @@

CanShowPreview

- +

Add this to any UIViewController to let it easily present a UIDocumentInteractionController controller using openPreview(…)

+
diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Protocols/CanShowSafari.html b/docs/docsets/.docset/Contents/Resources/Documents/Protocols/CanShowSafari.html index 3f60f84..db0873d 100644 --- a/docs/docsets/.docset/Contents/Resources/Documents/Protocols/CanShowSafari.html +++ b/docs/docsets/.docset/Contents/Resources/Documents/Protocols/CanShowSafari.html @@ -345,7 +345,8 @@

CanShowSafari

- +

Add this to any UIViewController to let it easily present a SFSafariView controller using openSafari(url:)

+
diff --git a/docs/docsets/.docset/Contents/Resources/Documents/index.html b/docs/docsets/.docset/Contents/Resources/Documents/index.html index 385c6bf..b3ec822 100644 --- a/docs/docsets/.docset/Contents/Resources/Documents/index.html +++ b/docs/docsets/.docset/Contents/Resources/Documents/index.html @@ -360,6 +360,10 @@

HSHelpers

  • HSTime - Extension on https://github.com/dreymonde/Time
    • +

    Browse Documentation

    + +

    Note - all the modules are mixed up in the docs, because that’s what jazzy seems to do!

    +