DOCS: Added documentation to models (#31)

Author: adamayoung

README.md

@@ -28,7 +28,7 @@ import PackageDescription
 let package = Package(
   name: "MyProject",
   dependencies: [
-    .package(url: "https://github.com/adamayoung/TMDb.git", upToNextMajor: "4.1.0")
+    .package(url: "https://github.com/adamayoung/TMDb.git", upToNextMajor: "5.0.0")
   ],
   targets: [
     .target(name: "MyProject", dependencies: ["TMDb"])

Sources/TMDb/Client/TMDbAPIClient.swift

@@ -111,6 +111,7 @@ extension TMDbAPIClient {
 
         return urlComponents.url!
             .appendingAPIKey(apiKey)
+            .appendingCurrentLanguage()
     }
 
 }

Sources/TMDb/Extensions/URL+QueryItem.swift

@@ -22,6 +22,28 @@ extension URL {
         appendingQueryItem(name: "api_key", value: apiKey)
     }
 
+    func appendingCurrentLanguage() -> Self {
+        let locale = Locale.current
+        var parts = [String]()
+        if let languageCode = locale.languageCode {
+            parts.append(languageCode)
+
+            if let regionCode = locale.regionCode {
+                parts.append(regionCode)
+            }
+        }
+
+        guard !parts.isEmpty else {
+            return self
+        }
+
+        return appendingLanguage(parts.joined(separator: "-"))
+    }
+
+    func appendingLanguage(_ language: String) -> Self {
+        return appendingQueryItem(name: "language", value: language)
+    }
+
     func appendingPage(_ page: Int?) -> Self {
         guard var page = page else {
             return self

Sources/TMDb/Models/APIConfiguration.swift

@@ -2,7 +2,7 @@ import Foundation
 
 /// API Configuration.
 ///
-/// - Note: Some elements of the API require some knowledge of this configuration data. The purpose of this is to try and keep the actual API responses as light as possible. It is recommended you cache this data within your application and check for updates every few days.
+/// Some elements of the API require some knowledge of this configuration data. The purpose of this is to try and keep the actual API responses as light as possible. It is recommended you cache this data within your application and check for updates every few days.
 public struct APIConfiguration: Decodable, Equatable {
 
     /// Images configuration.

Sources/TMDb/Models/CastMember.swift

@@ -3,13 +3,13 @@ import Foundation
 /// A cast member of a movie or TV show.
 public struct CastMember: Identifiable, Decodable, Equatable, ProfileURLProviding {
 
-    /// Cast member identifier.
+    /// Cast member's identifier.
     public let id: Int
-    /// Cast member identifier for the particular movie or TV show.
+    /// Cast member's identifier for the particular movie or TV show.
     public let castID: Int?
     /// Credit identifier for that particular movie or TV show.
     public let creditID: String
-    /// Cast member name.
+    /// Cast member's real name.
     public let name: String
     /// Cast member's character name.
     public let character: String
@@ -23,10 +23,10 @@ public struct CastMember: Identifiable, Decodable, Equatable, ProfileURLProvidin
     /// Creates a new `CastMember`.
     ///
     /// - Parameters:
-    ///    - id: Cast member identifier.
-    ///    - castID: Cast member identifier for the particular movie or TV show.
+    ///    - id: Cast member's identifier.
+    ///    - castID: Cast member's identifier for the particular movie or TV show.
     ///    - creditID: Credit identifier for that particular movie or TV show.
-    ///    - name: Cast member name.
+    ///    - name: Cast member's name.
     ///    - character: Cast member's character name.
     ///    - gender: Cast member's gender.
     ///    - profilePath: Cast member's profile image.

Sources/TMDb/Models/CrewMember.swift

@@ -3,14 +3,31 @@ import Foundation
 /// A crew member of a movie or TV show.
 public struct CrewMember: Identifiable, Decodable, Equatable, ProfileURLProviding {
 
+    /// Crew member's identifier.
     public let id: Int
+    /// Crew member's identifier for the particular movie or TV show.
     public let creditID: String
+    /// Crew member's name.
     public let name: String
+    /// Crew member's job.
     public let job: String
+    /// Crew member's department.
     public let department: String
+    /// Crew member's gender.
     public let gender: Gender?
+    /// Crew member's profile image.
     public let profilePath: URL?
 
+    /// Creates a new `CrewMember`.
+    ///
+    /// - Parameters:
+    ///    - id: Crew member's identifier.
+    ///    - creditID: Crew member's identifier for the particular movie or TV show.
+    ///    - name: Crew member's name.
+    ///    - job: Crew member's job.
+    ///    - department: Crew member's department.
+    ///    - gender: Crew member's gender.
+    ///    - profilePath: Crew member's profile image.
     public init(id: Int, creditID: String, name: String, job: String, department: String, gender: Gender? = nil,
                 profilePath: URL? = nil) {
         self.id = id

Sources/TMDb/Models/Gender.swift

@@ -1,10 +1,15 @@
 import Foundation
 
+/// Gender of a person.
 public enum Gender: Int, Decodable, Equatable {
 
+    /// Unknown.
     case unknown = 0
+    /// Female.
     case female = 1
+    /// Male.
     case male = 2
+    /// Other.
     case other = 3
 
 }

Sources/TMDb/Models/Genre.swift

@@ -1,10 +1,18 @@
 import Foundation
 
+/// Genre.
 public struct Genre: Identifiable, Decodable, Equatable {
 
+    /// Genre Identifier.
     public let id: Int
+    /// Genre name.
     public let name: String
 
+    /// Creates a new `Genre`.
+    ///
+    /// - Parameters:
+    ///    - id: Genre Identifier.
+    ///    - name: Genre name.
     public init(id: Int, name: String) {
         self.id = id
         self.name = name

Sources/TMDb/Models/ImageCollection.swift

@@ -1,11 +1,21 @@
 import Foundation
 
+/// A collection of poster and backdrop images for a movie or TV show.
 public struct ImageCollection: Decodable, Equatable {
 
+    /// Movie or TV show identifier for these images.
     public let id: Int
+    /// Poster images.
     public let posters: [ImageMetadata]
+    /// Backdrop images.
     public let backdrops: [ImageMetadata]
 
+    /// Creates a new `ImageCollection`.
+    ///
+    /// - Parameters:
+    ///    - id: Movie or TV show identifier for these images.
+    ///    - posters: Poster images.
+    ///    - backdrops: Backdrop images.
     public init(id: Int, posters: [ImageMetadata], backdrops: [ImageMetadata]) {
         self.id = id
         self.posters = posters

Sources/TMDb/Models/ImageMetadata.swift

@@ -1,12 +1,22 @@
 import Foundation
 
+/// Details describing an image.
 public struct ImageMetadata: Identifiable, Decodable, Equatable {
 
     public var id: URL { filePath }
+    /// Path of the image.
     public let filePath: URL
+    /// Image width.
     public let width: Int
+    /// Image height.
     public let height: Int
 
+    /// Creates a new `ImageMetadata`.
+    ///
+    /// - Parameters:
+    ///    - filePath: Path of the image.
+    ///    - width: Image width.
+    ///    - height: Image height.
     public init(filePath: URL, width: Int, height: Int) {
         self.filePath = filePath
         self.width = width