Build a documentation using Docc (#11)

* Update Flare's documentation

* Implement an action for building a documentation web page

* Update `CHANGELOG.md`

* Update `publish-pages.yml`

* Update `README.md`

.github/workflows/publish-pages.yml

@@ -0,0 +1,42 @@
+name: Deploy DocC
+
+on:
+  push:
+    branches: 
+      - main
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: macos-12
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v3
+      - name: Build DocC
+        run: |
+          swift build;
+          swift package \
+            --allow-writing-to-directory ./docs \
+            generate-documentation \
+            --target Flare \
+            --output-path ./docs \
+            --transform-for-static-hosting \
+            --hosting-base-path flare;
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: 'docs'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
 ## [Unreleased]
 
 ## Added
+- Build a documentation using `Docc`
+  - Added in Pull Request [#11](https://github.com/space-code/flare/pull/11).
+
 - Integrate the `StoreKit2` purchase method
   - Added in Pull Request [#10](https://github.com/space-code/flare/pull/10).
 

Package.resolved

@@ -8,6 +8,24 @@
         "revision" : "f9611694f77f64e43d9467a16b2f5212cd04099b",
         "version" : "0.0.1"
       }
+    },
+    {
+      "identity" : "swift-docc-plugin",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/apple/swift-docc-plugin",
+      "state" : {
+        "revision" : "26ac5758409154cc448d7ab82389c520fa8a8247",
+        "version" : "1.3.0"
+      }
+    },
+    {
+      "identity" : "swift-docc-symbolkit",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/apple/swift-docc-symbolkit",
+      "state" : {
+        "revision" : "b45d1f2ed151d057b54504d653e0da5552844e34",
+        "version" : "1.0.0"
+      }
     }
   ],
   "version" : 2

Package.swift

@@ -20,6 +20,7 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/space-code/concurrency.git", .upToNextMajor(from: "0.0.1")),
+        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.1.0"),
     ],
     targets: [
         .target(

Package@swift-5.7.swift

@@ -17,6 +17,7 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/space-code/concurrency.git", .upToNextMajor(from: "0.0.1")),
+        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.1.0"),
     ],
     targets: [
         .target(

Package@swift-5.8.swift

@@ -17,6 +17,7 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/space-code/concurrency.git", .upToNextMajor(from: "0.0.1")),
+        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.1.0"),
     ],
     targets: [
         .target(

README.md

@@ -30,7 +30,7 @@ Flare is a framework written in Swift that makes it easy for you to work with in
 - [x] Complete Unit Test Coverage
 
 ## Documentation
-Check out [flare documentation](https://github.com/space-code/flare/blob/main/Documentation/Usage.md).
+Check out [flare documentation](https://space-code.github.io/flare/documentation/flare/).
 
 ## Requirements
 - iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 7.0+ / visionOS 1.0+

Sources/Flare/Flare.swift → Sources/Flare/Classes/Flare.swift

@@ -1,6 +1,6 @@
 //
 // Flare
-// Copyright © 2023 Space Code. All rights reserved.
+// Copyright © 2024 Space Code. All rights reserved.
 //
 
 import StoreKit

Sources/Flare/IFlare.swift → Sources/Flare/Classes/IFlare.swift

@@ -1,6 +1,6 @@
 //
 // Flare
-// Copyright © 2023 Space Code. All rights reserved.
+// Copyright © 2024 Space Code. All rights reserved.
 //
 
 import Foundation

Sources/Flare/Classes/Models/ProductCategory.swift

@@ -1,10 +1,11 @@
 //
 // Flare
-// Copyright © 2023 Space Code. All rights reserved.
+// Copyright © 2024 Space Code. All rights reserved.
 //
 
 import Foundation
 
+/// Enumeration representing different categories of products in an app.
 public enum ProductCategory: Int {
     /// A non-renewable or auto-renewable subscription.
     case subscription

Sources/Flare/Classes/Models/SubscriptionPeriod.swift

@@ -1,14 +1,14 @@
 //
 // Flare
-// Copyright © 2023 Space Code. All rights reserved.
+// Copyright © 2024 Space Code. All rights reserved.
 //
 
 import Foundation
 import StoreKit
 
 // MARK: - SubscriptionPeriod
 
-// A class representing a subscription period with a specific value and unit.
+/// A class representing a subscription period with a specific value and unit.
 public final class SubscriptionPeriod: NSObject {
     // MARK: Types
 

Sources/Flare/Classes/Models/VerificationError.swift

@@ -1,10 +1,12 @@
 //
 // Flare
-// Copyright © 2023 Space Code. All rights reserved.
+// Copyright © 2024 Space Code. All rights reserved.
 //
 
 import Foundation
 
-public enum VerificationError: Swift.Error {
+/// Enumeration representing errors that can occur during verification.
+public enum VerificationError: Error {
+    // Case for unverified product with associated productID and error details.
     case unverified(productID: String, error: Error)
 }