rock-n-code/amiibo-service
1
0
Fork 0
Code Issues Pull Requests Actions Releases 15 Activity

DocC documentation support (#4)

Browse Source 
This PR contains the work done to:
* Documented all the `private`, `internal`, and `public` interfaces on the existing codebase;
* Set the DocC documentation catalog in the project;
* Written the main `Library` article for the DocC documentation catalog;
* Added the documentation tasks in the `Makefile` file.

Reviewed-on: #4
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
This commit was merged in pull request #4.
This commit is contained in:
Javier Cicchelli
2025-09-09 17:30:19 +00:00
committed by Javier Cicchelli
parent 39c6d6e8d6
commit 37c0f3e322
30 changed files with 543 additions and 151 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Package.swift
+8 -27
View File
@@ -26,44 +26,25 @@ let package = Package(
products: [
.library(
name: AmiiboService.package,
targets: [
AmiiboService.target
]
targets: [AmiiboService.target]
)
],
dependencies: [
.package(
url: "https://github.com/apple/swift-openapi-generator.git",
from: "1.3.0"
),
.package(
url: "https://github.com/apple/swift-openapi-runtime",
from: "1.5.0"
),
.package(
url: "https://github.com/apple/swift-openapi-urlsession",
from: "1.0.2"
)
.package(url: "https://github.com/apple/swift-openapi-generator.git", from: "1.3.0"),
.package(url: "https://github.com/apple/swift-openapi-runtime", from: "1.5.0"),
.package(url: "https://github.com/apple/swift-openapi-urlsession", from: "1.0.2"),
.package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.1.0"),
],
targets: [
.target(
name: AmiiboService.target,
dependencies: [
.product(
name: "OpenAPIRuntime",
package: "swift-openapi-runtime"
),
.product(
name: "OpenAPIURLSession",
package: "swift-openapi-urlsession"
)
.product(name: "OpenAPIRuntime", package: "swift-openapi-runtime"),
.product(name: "OpenAPIURLSession", package: "swift-openapi-urlsession")
],
path: "Sources",
plugins: [
.plugin(
name: "OpenAPIGenerator",
package: "swift-openapi-generator"
),
.plugin(name: "OpenAPIGenerator", package: "swift-openapi-generator"),
]
),
.testTarget(