Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JacobSyndeo committed Feb 6, 2024
1 parent d01c61c commit 30801e7
Show file tree
Hide file tree
Showing 301 changed files with 418 additions and 452 deletions.
24 changes: 3 additions & 21 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -13,36 +13,18 @@ let package = Package(
.watchOS(.v7)
],
products: [
// Products define the executables and libraries a package produces, and make them visible to other packages.

// 🎆 Ether
.library(name: "Ether",
targets: ["Ether"]),
],
dependencies: [
// Dependencies declare other packages that this package depends on.
// .package(url: "https://github.com/1024jp/GzipSwift", from: "5.1.1"),
// .package(url: "https://github.com/vapor/vapor", .upToNextMajor(from: "4.0.0")),
// .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
// .package(url: "https://github.com/themomax/swift-docc-plugin", branch: "add-extended-types-flag")
.package(url: "https://github.com/vapor/vapor", .upToNextMajor(from: "4.0.0")),
.package(url: "https://github.com/themomax/swift-docc-plugin", branch: "add-extended-types-flag")
],
targets: [
// Targets are the basic building blocks of a package. A target can define a module or a test suite.
// Targets can depend on other targets in this package, and on products in packages this package depends on.

// 🎆 Ether
.target(name: "Ether",
dependencies: [
// .product(name: "Gzip", package: "GzipSwift")
]
// swiftSettings: [.unsafeFlags(["-emit-extension-block-symbols"])]
swiftSettings: [.unsafeFlags(["-emit-extension-block-symbols"])]
),
// .testTarget(
// name: "EtherTests",
// dependencies: ["Ether",
// .product(name: "Vapor", package: "vapor"),
// ],
// resources: [.copy("Resources/你好.jpeg")
// ]),
]
)
2 changes: 0 additions & 2 deletions Sources/Ether/Core+TypedRoute.swift
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,10 @@ extension Ether {
/// Compare with ``Ether/EtherRoute/get(type:parameters:decoder:)``, a convenience version of this method.
public static func get<T>(typedRoute: T,
parameters: Parameters = [:],
/*cacheBehavior: CacheBehavior = .neverUse,*/ // TODO: Get caching working!
decoder: JSONDecoder = JSONDecoder()) async throws -> T.DecodedType where T: TypedRoute {
try await Ether.get(route: typedRoute,
type: T.DecodedType.self,
parameters: parameters,
/*cacheBehavior: cacheBehavior,*/
decoder: decoder)
}

Expand Down
2 changes: 0 additions & 2 deletions Sources/Ether/Route.swift
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,10 @@ extension Ether.Route {
/// Compare with ``Ether/Ether/get(route:type:parameters:decoder:)``, the main version of this method.
public func get<T>(type: T.Type,
parameters: Ether.Parameters = [:],
/*cacheBehavior: CacheBehavior = .neverUse*/ // TODO: Get caching working!
decoder: JSONDecoder = .init()) async throws -> T where T: Decodable {
try await Ether.get(route: self,
type: type,
parameters: parameters,
/*cacheBehavior: cacheBehavior,*/
decoder: decoder)
}

Expand Down
2 changes: 0 additions & 2 deletions Sources/Ether/TypedRoute.swift
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,10 @@ extension EtherTypedRoute {
///
/// Compare with ``Ether/Ether/get(route:type:parameters:decoder:)``, the main version of this method.
public func get(parameters: Ether.Parameters = [:],
/*cacheBehavior: CacheBehavior = .neverUse,*/ // TODO: Get caching working!
decoder: JSONDecoder = JSONDecoder()) async throws -> DecodedType {
try await Ether.get(route: self,
type: DecodedType.self,
parameters: parameters,
/*cacheBehavior: cacheBehavior,*/
decoder: decoder)
}

Expand Down
9 changes: 0 additions & 9 deletions docs/css/chunk-384ef189.7ede1ea3.css

This file was deleted.

9 changes: 9 additions & 0 deletions docs/css/chunk-c0335d80.10a2f091.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions docs/css/documentation-topic.1d1eec04.css

Large diffs are not rendered by default.

9 changes: 0 additions & 9 deletions docs/css/documentation-topic.29351f99.css

This file was deleted.

9 changes: 9 additions & 0 deletions docs/css/documentation-topic~topic.b6287bcf.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 30801e7

Please sign in to comment.