rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity

Improved the source code documentation of the source code in the package.

Browse Source
This commit is contained in:
Javier Cicchelli
2026-03-24 01:26:27 +01:00
parent 25b62a4f67
commit a559ae0163
14 changed files with 50 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/DiscogsService/Public/Models/Product.swift
+12 -7
View File
@@ -14,27 +14,32 @@
import Foundation
/// A type that represents a product that uses the ``Client`` client.
/// A representation of the product information used to generate the `User-Agent` header for requests to the Discogs API.
///
/// The Discogs API requires a `User-Agent` header that identifies the application making the request. This model captures
/// the product name, version, and URL needed to build that header via the ``UserAgentMiddleware``.
///
/// The generated `User-Agent` header follows the format: `ProductName/1.0.0 +https://example.com`
public struct Product: Sendable {
// MARK: Properties
/// A camel-cased name of a product.
/// The camel-cased name of the product (e.g., `MyDiscogsApp`).
let name: String
/// A URI link related to a product.
/// A URI link related to the product (e.g., `https://example.com`).
let url: String
/// A semantic version of a product.
/// The semantic version of the product (e.g., `1.0.0`).
let version: String
// MARK: Initializers
/// Initializes this model.
/// - Parameters:
/// - name: A camel-cased name of a product.
/// - version: A semantic version of a product.
/// - url: A URI link related to a product.
/// - name: The camel-cased name of the product.
/// - version: The semantic version of the product, following [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html).
/// - url: A URI link related to the product.
public init(
name: String,
version: String,