Documentation update

intelygenz · Nov 22, 2017 · 424d4a0 · 424d4a0
1 parent 660ba70
commit 424d4a0
Show file tree

Hide file tree

Showing 9 changed files with 11 additions and 8 deletions.
diff --git a/.gitignore b/.gitignore
@@ -23,6 +23,7 @@ xcuserdata/
 ## Other
 *.moved-aside
 *.xcuserstate
+docs/undocumented.json
 
 ## Obj-C/Swift specific
 *.hmap

diff --git a/Source/Dispatcher.swift b/Source/Dispatcher.swift
@@ -49,14 +49,14 @@ open class Dispatcher {
         operationQueue.addOperations(operations, waitUntilFinished: waitUntilFinished)
     }
 
-    /// Execute block in priority queue
+    /// Execute block in OperationQueue
     @discardableResult open func execute(_ block: @escaping () -> Void) -> Operation {
         let blockOperation = BlockOperation(block: block)
         execute(blockOperation)
         return blockOperation
     }
 
-    /// Execute [block] collection in priority queue (if possible) concurrently or sequentially
+    /// Execute [block] collection in OperationQueue concurrently or sequentially
     @discardableResult open func execute(_ blocks: [() -> Void], concurrent: Bool = true, waitUntilFinished: Bool = false) -> [Operation] {
         var lastOperation: Operation?
         let operations = blocks.map { block -> Operation in

diff --git a/docs/Classes/Dispatcher.html b/docs/Classes/Dispatcher.html
@@ -396,7 +396,7 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Execute block in priority queue</p>
+                        <p>Execute block in OperationQueue</p>
 
                       </div>
                       <div class="declaration">
@@ -426,7 +426,7 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Execute [block] collection in priority queue (if possible) concurrently or sequentially</p>
+                        <p>Execute [block] collection in OperationQueue concurrently or sequentially</p>
 
                       </div>
                       <div class="declaration">

diff --git a/docs/docsets/Kommander.docset/Contents/Resources/Documents/Classes/Dispatcher.html b/docs/docsets/Kommander.docset/Contents/Resources/Documents/Classes/Dispatcher.html
@@ -396,7 +396,7 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Execute block in priority queue</p>
+                        <p>Execute block in OperationQueue</p>
 
                       </div>
                       <div class="declaration">
@@ -426,7 +426,7 @@ <h4>Declaration</h4>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Execute [block] collection in priority queue (if possible) concurrently or sequentially</p>
+                        <p>Execute [block] collection in OperationQueue concurrently or sequentially</p>
 
                       </div>
                       <div class="declaration">

diff --git a/docs/docsets/Kommander.docset/Contents/Resources/Documents/index.html b/docs/docsets/Kommander.docset/Contents/Resources/Documents/index.html
@@ -80,6 +80,7 @@
 <a href="https://github.com/Carthage/Carthage"><img src="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat" alt="Carthage compatible"></a>
 <a href="https://github.com/apple/swift-package-manager"><img src="https://img.shields.io/badge/Swift%20Package%20Manager-compatible-4BC51D.svg?style=flat" alt="Swift Package Manager Compatible"></a>
 <a href="https://travis-ci.org/intelygenz/Kommander-iOS"><img src="https://travis-ci.org/intelygenz/Kommander-iOS.svg?branch=master" alt="Build Status"></a>
+<a href="https://intelygenz.github.io/Kommander-iOS"><img src="https://img.shields.io/badge/documentation-100%25-brightgreen.svg?style=flat" alt="Documentation"></a>
 <a href="http://cocoapods.org/pods/Kommander"><img src="https://img.shields.io/cocoapods/dt/Kommander.svg" alt="Downloads"></a></p>
 
 <p><strong>Kommander</strong> is a Swift library to manage the task execution in different threads. Through the definition a simple but powerful concept, <a href="https://en.wikipedia.org/wiki/Command_pattern"><strong>Kommand</strong></a>.</p>

diff --git a/docs/docsets/Kommander.docset/Contents/Resources/Documents/search.json b/docs/docsets/Kommander.docset/Contents/Resources/Documents/search.json
diff --git a/docs/docsets/Kommander.tgz b/docs/docsets/Kommander.tgz
diff --git a/docs/index.html b/docs/index.html
@@ -80,6 +80,7 @@
 <a href="https://github.com/Carthage/Carthage"><img src="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat" alt="Carthage compatible"></a>
 <a href="https://github.com/apple/swift-package-manager"><img src="https://img.shields.io/badge/Swift%20Package%20Manager-compatible-4BC51D.svg?style=flat" alt="Swift Package Manager Compatible"></a>
 <a href="https://travis-ci.org/intelygenz/Kommander-iOS"><img src="https://travis-ci.org/intelygenz/Kommander-iOS.svg?branch=master" alt="Build Status"></a>
+<a href="https://intelygenz.github.io/Kommander-iOS"><img src="https://img.shields.io/badge/documentation-100%25-brightgreen.svg?style=flat" alt="Documentation"></a>
 <a href="http://cocoapods.org/pods/Kommander"><img src="https://img.shields.io/cocoapods/dt/Kommander.svg" alt="Downloads"></a></p>
 
 <p><strong>Kommander</strong> is a Swift library to manage the task execution in different threads. Through the definition a simple but powerful concept, <a href="https://en.wikipedia.org/wiki/Command_pattern"><strong>Kommand</strong></a>.</p>

diff --git a/docs/search.json b/docs/search.json