More docs

ConfusedVorlon · Jul 30, 2021 · 34fcce8 · 34fcce8
1 parent 26dd898
commit 34fcce8
Show file tree

Hide file tree

Showing 24 changed files with 53 additions and 19 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -531,7 +531,8 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-
+                        <p>Item to share Url, UIImage, etc</p>
+
                         <a href="Classes/ShareItem.html" class="slightly-smaller">See more</a>
                       </div>
                     </section>

diff --git a/docs/Classes/ShareItem.html b/docs/Classes/ShareItem.html
@@ -345,7 +345,8 @@
         <section>
           <section class="section">
             <h1>ShareItem</h1>
-
+            <p>Item to share Url, UIImage, etc</p>
+
           </section>
           <section class="section task-group-section">
             <div class="task-group">

diff --git a/docs/Extensions.html b/docs/Extensions.html
@@ -1810,7 +1810,8 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-
+                        <p>Add this to any UIViewController to let it easily present an Alert</p>
+
                         <a href="Extensions/UIViewController.html" class="slightly-smaller">See more</a>
                       </div>
                     </section>

diff --git a/docs/Extensions/UIViewController.html b/docs/Extensions/UIViewController.html
@@ -345,7 +345,8 @@
         <section>
           <section class="section">
             <h1>UIViewController</h1>
-
+            <p>Add this to any UIViewController to let it easily present an Alert</p>
+
           </section>
           <section class="section task-group-section">
             <div class="task-group">

diff --git a/docs/Protocols.html b/docs/Protocols.html
@@ -519,7 +519,8 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-
+                        <p>Add this to any UIViewController to let it easily present a UIDocumentInteractionController controller using openPreview(&hellip;)</p>
+
                         <a href="Protocols/CanShowPreview.html" class="slightly-smaller">See more</a>
                       </div>
                     </section>
@@ -538,7 +539,8 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-
+                        <p>Add this to any UIViewController to let it easily present a SFSafariView controller using openSafari(url:)</p>
+
                         <a href="Protocols/CanShowSafari.html" class="slightly-smaller">See more</a>
                       </div>
                     </section>

diff --git a/docs/Protocols/CanShowPreview.html b/docs/Protocols/CanShowPreview.html
@@ -345,7 +345,8 @@
         <section>
           <section class="section">
             <h1>CanShowPreview</h1>
-
+            <p>Add this to any UIViewController to let it easily present a UIDocumentInteractionController controller using openPreview(&hellip;)</p>
+
           </section>
           <section class="section task-group-section">
             <div class="task-group">

diff --git a/docs/Protocols/CanShowSafari.html b/docs/Protocols/CanShowSafari.html
@@ -345,7 +345,8 @@
         <section>
           <section class="section">
             <h1>CanShowSafari</h1>
-
+            <p>Add this to any UIViewController to let it easily present a SFSafariView controller using openSafari(url:)</p>
+
           </section>
           <section class="section task-group-section">
             <div class="task-group">

diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/.docset/Contents/Resources/Documents/Classes.html
@@ -531,7 +531,8 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-
+                        <p>Item to share Url, UIImage, etc</p>
+
                         <a href="Classes/ShareItem.html" class="slightly-smaller">See more</a>
                       </div>
                     </section>

diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Classes/ShareItem.html b/docs/docsets/.docset/Contents/Resources/Documents/Classes/ShareItem.html
@@ -345,7 +345,8 @@
         <section>
           <section class="section">
             <h1>ShareItem</h1>
-
+            <p>Item to share Url, UIImage, etc</p>
+
           </section>
           <section class="section task-group-section">
             <div class="task-group">

diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Extensions.html b/docs/docsets/.docset/Contents/Resources/Documents/Extensions.html
@@ -1810,7 +1810,8 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-
+                        <p>Add this to any UIViewController to let it easily present an Alert</p>
+
                         <a href="Extensions/UIViewController.html" class="slightly-smaller">See more</a>
                       </div>
                     </section>

diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UIViewController.html b/docs/docsets/.docset/Contents/Resources/Documents/Extensions/UIViewController.html
@@ -345,7 +345,8 @@
         <section>
           <section class="section">
             <h1>UIViewController</h1>
-
+            <p>Add this to any UIViewController to let it easily present an Alert</p>
+
           </section>
           <section class="section task-group-section">
             <div class="task-group">

diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Protocols.html b/docs/docsets/.docset/Contents/Resources/Documents/Protocols.html
@@ -519,7 +519,8 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-
+                        <p>Add this to any UIViewController to let it easily present a UIDocumentInteractionController controller using openPreview(&hellip;)</p>
+
                         <a href="Protocols/CanShowPreview.html" class="slightly-smaller">See more</a>
                       </div>
                     </section>
@@ -538,7 +539,8 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-
+                        <p>Add this to any UIViewController to let it easily present a SFSafariView controller using openSafari(url:)</p>
+
                         <a href="Protocols/CanShowSafari.html" class="slightly-smaller">See more</a>
                       </div>
                     </section>

diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Protocols/CanShowPreview.html b/docs/docsets/.docset/Contents/Resources/Documents/Protocols/CanShowPreview.html
@@ -345,7 +345,8 @@
         <section>
           <section class="section">
             <h1>CanShowPreview</h1>
-
+            <p>Add this to any UIViewController to let it easily present a UIDocumentInteractionController controller using openPreview(&hellip;)</p>
+
           </section>
           <section class="section task-group-section">
             <div class="task-group">

diff --git a/docs/docsets/.docset/Contents/Resources/Documents/Protocols/CanShowSafari.html b/docs/docsets/.docset/Contents/Resources/Documents/Protocols/CanShowSafari.html
@@ -345,7 +345,8 @@
         <section>
           <section class="section">
             <h1>CanShowSafari</h1>
-
+            <p>Add this to any UIViewController to let it easily present a SFSafariView controller using openSafari(url:)</p>
+
           </section>
           <section class="section task-group-section">
             <div class="task-group">

diff --git a/docs/docsets/.docset/Contents/Resources/Documents/index.html b/docs/docsets/.docset/Contents/Resources/Documents/index.html
@@ -360,6 +360,10 @@ <h1 id='hshelpers' class='heading'>HSHelpers</h1>
 <li>HSTime - Extension on <a href="https://github.com/dreymonde/Time">https://github.com/dreymonde/Time</a></li>
 </ul>
 
+<p><a href="https://confusedvorlon.github.io/HSHelpers/index.html">Browse Documentation</a></p>
+
+<p>Note - all the modules are mixed up in the docs, because that&rsquo;s what jazzy seems to do!</p>
+
           </section>
         </section>
         <section id="footer">

diff --git a/docs/docsets/.tgz b/docs/docsets/.tgz
diff --git a/docs/index.html b/docs/index.html
@@ -360,6 +360,10 @@ <h1 id='hshelpers' class='heading'>HSHelpers</h1>
 <li>HSTime - Extension on <a href="https://github.com/dreymonde/Time">https://github.com/dreymonde/Time</a></li>
 </ul>
 
+<p><a href="https://confusedvorlon.github.io/HSHelpers/index.html">Browse Documentation</a></p>
+
+<p>Note - all the modules are mixed up in the docs, because that&rsquo;s what jazzy seems to do!</p>
+
           </section>
         </section>
         <section id="footer">

diff --git a/document.sh b/document.sh
@@ -3,4 +3,4 @@ sourcekitten doc --spm --module-name HSHelpers > .tmp/mod1.json
 sourcekitten doc --spm --module-name HSAppKit > .tmp/mod2.json
 sourcekitten doc --spm --module-name HSUIKit > .tmp/mod3.json
 sourcekitten doc --spm --module-name HSTime > .tmp/mod4.json
-jazzy --sourcekitten-sourcefile .tmp/mod1.json,.tmp/mod2.json,.tmp/mod3.json,.tmp/mod4.json
+jazzy --sourcekitten-sourcefile .tmp/mod1.json,.tmp/mod2.json,.tmp/mod3.json,.tmp/mod4.json --disable-search