doc formatting improvements

Author: conqueror

README.md

@@ -9,6 +9,7 @@ Using Swift Package Manager, add the following to your packages.swift
 `.package(url: "https://github.com/PerfectAccelerators/ApplicationConfiguration.git", .branch("master"))`
 
 Run `swift package update` and if you use Xcode run `swift package generate-xcodeproj`
+
 ## Usage
 Create a file that includes the configuration for your application, for instance:
 
@@ -58,5 +59,11 @@ Then modify your main.swift:
 	    fatalError("\(error)")
 	}
 
+## Documentation
+[Jazzy][1] generated documentation can be found here:
+[https://perfectaccelerators.github.io/ApplicationConfiguration/ ]()
+
 ## Contributing
-To contribute a feature or idea to **ApplicationConfiguration**, fork the project, make your changes and submit a pull request :)
+To contribute a feature or idea to **ApplicationConfiguration**, fork the project, make your changes and submit a pull request :)
+
+[1]:	https://github.com/realm/jazzy

Sources/ApplicationConfiguration/AppFilters.swift

@@ -2,7 +2,7 @@
 import Foundation
 import PerfectHTTP
 
-/// This struct represents request and response application filters
+/// This struct represents request and response application filters.
 /// You can create AppFilters and use it in Application initialization
 public struct AppFilters {
     /// request filters

Sources/ApplicationConfiguration/AppProtocol.swift

@@ -4,8 +4,8 @@ import PerfectHTTPServer
 import PerfectHTTP
 
 /**
- A protocol to define Applications
- It is already implemented by Application
+ A protocol to define Applications.
+ It is already implemented by Application.
  - see also: Application
 */
 public protocol AppProtocol {

Sources/ApplicationConfiguration/Application.swift

@@ -6,9 +6,9 @@ import PerfectHTTP
 
 /**
  This struct represnts an Application
- with its configuration, routes and filters
+ with its configuration, routes and filters.
  You could use this application or create another
- Application object that complies with AppProtocol
+ Application object that complies with AppProtocol.
  - see also: AppProtocol
 */
 public struct Application: AppProtocol {

docs/Protocols.html

@@ -101,8 +101,8 @@ <h1>Protocols</h1>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>A protocol to define Applications
-It is already implemented by Application</p>
+                        <p>A protocol to define Applications.
+It is already implemented by Application.</p>
 <div class="aside aside-see">
     <p class="aside-title">See</p>
     see also: Application

docs/Protocols/AppProtocol.html

@@ -88,8 +88,8 @@ <h1>AppProtocol</h1>
 
                 </div>
               </div>
-            <p>A protocol to define Applications
-It is already implemented by Application</p>
+            <p>A protocol to define Applications.
+It is already implemented by Application.</p>
 <div class="aside aside-see">
     <p class="aside-title">See</p>
     see also: Application

docs/Structs.html

@@ -101,7 +101,7 @@ <h1>Structures</h1>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>This struct represents request and response application filters
+                        <p>This struct represents request and response application filters.
 You can create AppFilters and use it in Application initialization</p>
 
                       </div>
@@ -134,9 +134,9 @@ <h4>Declaration</h4>
                       <div class="pointer"></div>
                       <div class="abstract">
                         <p>This struct represnts an Application
-with its configuration, routes and filters
+with its configuration, routes and filters.
 You could use this application or create another
-Application object that complies with AppProtocol</p>
+Application object that complies with AppProtocol.</p>
 <div class="aside aside-see">
     <p class="aside-title">See</p>
     see also: AppProtocol

docs/Structs/Application.html

@@ -89,9 +89,9 @@ <h1>Application</h1>
                 </div>
               </div>
             <p>This struct represnts an Application
-with its configuration, routes and filters
+with its configuration, routes and filters.
 You could use this application or create another
-Application object that complies with AppProtocol</p>
+Application object that complies with AppProtocol.</p>
 <div class="aside aside-see">
     <p class="aside-title">See</p>
     see also: AppProtocol

docs/_config.yml

@@ -101,8 +101,8 @@ <h1>Protocols</h1>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>A protocol to define Applications
-It is already implemented by Application</p>
+                        <p>A protocol to define Applications.
+It is already implemented by Application.</p>
 <div class="aside aside-see">
     <p class="aside-title">See</p>
     see also: Application