📚 Improve documentation

- Add missing comments
- Add script to generate docs

Author: alexaubry

.generate-docs.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+set -e
+
+MODULE_VERSION=$1
+OUTPUT=$2
+SWIFT_VERSION="4.0"
+AUTHOR="Alexis Aubry"
+AUTHOR_URL="https://twitter.com/_alexaubry"
+MODULE_NAME="JavaScriptKit"
+COPYRIGHT="Copyright © 2017 $AUTHOR. Available under the MIT License."
+GITHUB_URL="https://github.com/alexaubry/JavaScriptKit"
+GH_PAGES_URL="https://alexaubry.github.io/JavaScriptKit"
+
+jazzy \
+    --swift-version $SWIFT_VERSION \
+    -a "$AUTHOR" \
+    -u "$AUTHOR_URL" \
+    -m "$MODULE_NAME" \
+    --module-version "$MODULE_VERSION" \
+    --copyright "$COPYRIGHT" \
+    -g "$GITHUB_URL" \
+    --github-file-prefix "$GITHUB_URL/tree/master" \
+    -r "$GH_PAGES_URL" \
+    -o "$OUTPUT"\
+    --min-acl public \
+    --use-safe-filenames

Sources/Expressions/JSFunction.swift

@@ -63,6 +63,7 @@ public final class JSFunction<T>: JSExpression where T: Decodable {
         self.arguments = arguments
     }
 
+    /// Creates the JavaScript text of the expression.
     public func makeExpressionString() throws -> String {
 
         let encoder = JavaScriptEncoder()

Sources/Expressions/JSScript.swift

@@ -65,6 +65,7 @@ public final class JSScript<T>: JSExpression where T: Decodable {
         self.javaScriptString = javaScriptString
     }
 
+    /// Creates the JavaScript text of the expression.
     public func makeExpressionString() -> String {
         return javaScriptString
     }

Sources/Expressions/JSVariable.swift

@@ -55,6 +55,7 @@ public final class JSVariable<T>: JSExpression where T: Decodable {
         self.keyPath = keyPath
     }
 
+    /// Creates the JavaScript text of the expression.
     public func makeExpressionString() -> String {
         return "this.\(keyPath);"
     }

Sources/JSErrorDomain.swift

@@ -30,8 +30,10 @@ public enum JSErrorDomain {
 
 extension JSErrorDomain: LocalizedError {
 
+    /// The identifier of the error domain.
     public static var identifier = "fr.alexaubry.JavaScriptKit.JSErrorDomain"
 
+    /// The code of the error.
     public var code: Int {
 
         switch self {
@@ -47,6 +49,7 @@ extension JSErrorDomain: LocalizedError {
 
     }
 
+    /// The localized description of the error.
     public var localizedDescription: String {
 
         switch self {
@@ -65,6 +68,7 @@ extension JSErrorDomain: LocalizedError {
 
     }
 
+    /// The error that caused this error to be thrown.
     public var underlyingError: NSError? {
 
         switch self {
@@ -89,6 +93,7 @@ extension JSErrorDomain: LocalizedError {
 
     }
 
+    /// The localized description of the error.
     public var errorDescription: String {
         return localizedDescription
     }

Sources/JSTypes.swift

@@ -11,5 +11,8 @@ import CoreGraphics
 ///
 
 public struct JSVoid: Equatable, Decodable {
+
+    /// Compares two Void values. Always evaluates to `true`.
     public static func == (lhs: JSVoid, rhs: JSVoid) -> Bool { return true }
+
 }