refactor: add comments to the new models

Author: htmlprogrammist

Sources/EmojiPicker/Models/Category.swift

@@ -19,12 +19,20 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+/// An object that represents category of emojis.
 struct Category: Decodable {
-    let id: CategoryType
+    /// Type-safe category type.
+    let type: CategoryType
+    /// Identifiers of emojis.
     let emojis: [String]
+    
+    enum CodingKeys: String, CodingKey {
+        case type = "id"
+        case emojis
+    }
 }
 
-/// Describes types of emoji categories.
+/// Type-safe representation of emoji categories.
 enum CategoryType: String, Decodable, CaseIterable {
     case people
     case nature

Sources/EmojiPicker/Models/Emoji.swift

@@ -19,10 +19,16 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+/// An object that represents emoji.
 struct Emoji: Decodable {
-    let id, name: String
+    /// Emoji identifier.
+    let id: String
+    /// Name of an emoji.
+    let name: String
+    /// Keywords for an emoji.
     let keywords: [String]
+    /// Skin tones.
     let skins: [Skin]
+    /// Version in which the emoji appeared.
     let version: Double
-    let emoticons: [String]?
 }

Sources/EmojiPicker/Models/EmojiSet.swift

@@ -19,8 +19,12 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+/// An object that represents set of emojis.
 struct EmojiSet: Decodable {
+    /// Emoji categories.
     let categories: [Category]
+    /// Emojis dictionary. Key is the name (id) of emoji.
     let emojis: [String: Emoji]
+    /// Aliases of keywords for emojis.
     let aliases: [String: String]
 }

Sources/EmojiPicker/Models/Skin.swift

@@ -19,7 +19,10 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+/// An object that represents skin tones for emojis.
 struct Skin: Decodable {
+    /// Unicode.
     let unified: String
+    /// Emoji as symbol. For example: 😄
     let native: String
 }

Sources/EmojiPicker/ViewModel/EmojiPickerViewModel.swift

@@ -75,7 +75,7 @@ final class EmojiPickerViewModel: EmojiPickerViewModelProtocol {
 
     func sectionHeaderViewModel(for section: Int) -> String {
         return NSLocalizedString(
-            emojiSet.categories[section].id.rawValue,
+            emojiSet.categories[section].type.rawValue,
             bundle: .module,
             comment: ""
         )