From 9b8f8586ecf4c8fe401581edb9ba7f62030ccc5e Mon Sep 17 00:00:00 2001 From: jahorton Date: Tue, 2 Jun 2020 15:46:00 +0700 Subject: [PATCH] docs(ios/engine): links for kmp.json schema references --- .../KMEI/KeymanEngine/Classes/kmp.json/KMPMetadata.swift | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/ios/engine/KMEI/KeymanEngine/Classes/kmp.json/KMPMetadata.swift b/ios/engine/KMEI/KeymanEngine/Classes/kmp.json/KMPMetadata.swift index d8d997d1d5..4874822bd7 100644 --- a/ios/engine/KMEI/KeymanEngine/Classes/kmp.json/KMPMetadata.swift +++ b/ios/engine/KMEI/KeymanEngine/Classes/kmp.json/KMPMetadata.swift @@ -8,6 +8,14 @@ import Foundation +/** + * This class serializes to and deserializes from JSON following the schema found here for every package's kmp.json: + * - https://api.keyman.com/schemas/package/1.1.0/package.json + * + * It should be kept updated to match the latest schema version whenever updates occur. + * + * Documentation link: https://help.keyman.com/developer/current-version/reference/file-types/metadata + */ public class KMPMetadata: Codable { var system: KMPSystem var options: KMPOptions