Add documentation comments for enums and properties in MusadoraKit

Author: rudrankriyam

Sources/MusadoraKit/Models/MusadoraKitError.swift

@@ -123,6 +123,7 @@ extension MusadoraKitError: CustomStringConvertible {
 }
 
 extension MusadoraKitError: LocalizedError {
+  /// A localized description of the error.
   public var errorDescription: String? {
     description
   }

Sources/MusadoraKit/Models/UserMusicItem.swift

@@ -14,6 +14,7 @@ public enum UserMusicItem: Equatable, Hashable, Identifiable {
 }
 
 extension UserMusicItem: MusicItem {
+  /// The unique identifier for the music item.
   public var id: MusicItemID {
     let id: MusicItemID
 
@@ -31,6 +32,7 @@ extension UserMusicItem: MusicItem {
     return id
   }
 
+  /// The artwork associated with the music item, if available.
   public var artwork: Artwork? {
     switch self {
     case .album(let album):
@@ -44,6 +46,7 @@ extension UserMusicItem: MusicItem {
     }
   }
 
+  /// The title or name of the music item.
   public var title: String {
     switch self {
     case .album(let album):
@@ -101,6 +104,7 @@ extension UserMusicItem: Encodable {
 }
 
 extension UserMusicItem: PlayableMusicItem {
+  /// The parameters to use when playing the music item.
   public var playParameters: PlayParameters? {
     switch self {
     case .album(let album):

Sources/MusadoraKit/MultipleResources/MusicCatalogResources/MusicCatalogResourcesType.swift

@@ -23,18 +23,30 @@ public enum MusicCatalogResourcesType {
   case radioShow(RadioShow)
   case musicVideo(MusicVideo)
 
+  /// The key identifying the type of catalog resource for API requests.
   public enum Key: String, Codable {
+    /// Stations resource key.
     case stations
+    /// Genres resource key.
     case genres
+    /// Songs resource key.
     case songs
+    /// Record labels resource key.
     case recordLabels = "record-labels"
+    /// Playlists resource key.
     case playlists
+    /// Artists resource key.
     case artists
+    /// Albums resource key.
     case albums
+    /// Curators resource key.
     case curators
+    /// Radio shows resource key.
     case radioShows = "apple-curators"
+    /// Music videos resource key.
     case musicVideos = "music-videos"
 
+    /// The formatted type string for use in API query parameters.
     public var type: String {
       "ids[\(rawValue)]".removingPercentEncoding ?? "ids[\(rawValue)]"
     }
@@ -43,6 +55,7 @@ public enum MusicCatalogResourcesType {
 
 @available(iOS 15.4, macOS 12.3, tvOS 15.4, watchOS 9.0, visionOS 1.0, *)
 extension MusicCatalogResourcesType: MusicItem {
+  /// The unique identifier for the catalog resource.
   public var id: MusicItemID {
     let id: MusicItemID
 

Sources/MusadoraKit/MultipleResources/MusicLibraryResources/MusicLibraryResourcesType.swift

@@ -16,20 +16,28 @@ public enum MusicLibraryResourcesType {
   case artist(Artist)
   case musicVideo(MusicVideo)
 
+  /// The key identifying the type of library resource for API requests.
   public enum Key: String, Codable {
+    /// Library songs resource key.
     case songs = "library-songs"
+    /// Library albums resource key.
     case albums = "library-albums"
+    /// Library playlists resource key.
     case playlists = "library-playlists"
+    /// Library artists resource key.
     case artists = "library-artists"
+    /// Library music videos resource key.
     case musicVideos = "library-music-videos"
 
+    /// The formatted type string for use in API query parameters.
     public var type: String {
       "ids[\(rawValue)]".removingPercentEncoding ?? "ids[\(rawValue)]"
     }
   }
 }
 
 extension MusicLibraryResourcesType: MusicItem {
+  /// The unique identifier for the library resource.
   public var id: MusicItemID {
     let id: MusicItemID
 

Sources/MusadoraKit/MusicStorefront.swift

@@ -102,13 +102,19 @@ public struct MusicStorefront: Codable {
     storefrontId = MusicStorefront.mapStorefrontIdFromCountryCode(id)
   }
 
+  /// The explicit content policy for a storefront.
   public enum ExplicitContentPolicy: String, Codable {
+    /// Explicit content is allowed in this storefront.
     case allowed
+    /// Explicit content requires the user to opt in.
     case optIn = "opt-in"
+    /// Explicit content is prohibited in this storefront.
     case prohibited
   }
 
+  /// The type of the resource.
   public enum `Type`: String, Codable {
+    /// The resource is a storefront.
     case storefronts
   }
 

Sources/MusadoraKit/Ratings/Library/LibraryRatingMusicItemType.swift

@@ -5,9 +5,14 @@
 //  Created by Rudrank Riyam on 18/05/22.
 //
 
+/// The type of library music item that can be rated.
 public enum LibraryRatingMusicItemType: String, Codable {
+  /// A song in the user's library.
   case song = "library-songs"
+  /// An album in the user's library.
   case album = "library-albums"
+  /// A music video in the user's library.
   case musicVideo = "library-music-videos"
+  /// A playlist in the user's library.
   case playlist = "library-playlists"
 }