[[ ExtensionUtils ]] Add docs for extension package validation

livecodeali · livecodeali · commit 01b67d8a3f25 · 2018-03-17T14:28:31.000Z
diff --git a/extensions/script-libraries/extension-utils/extension-utils.livecodescript b/extensions/script-libraries/extension-utils/extension-utils.livecodescript
@@ -1641,6 +1641,25 @@ end extensionFetchSourceFromFolder
 
 /**
 Validate an extension package
+
+Parameters:
+pPackage: The .lce package to validate
+rManifestDataA: The basic manifest data extracted from the package
+
+The result: 
+If the package was deemed invalid, the result contains the reason why 
+the package failed validation.
+
+Description:
+Use the <extensionValidateLCEPackage> command to naively validate the 
+contents of an .lce package. <extensionValidateLCEPackage> checks if 
+there is a file that looks like the main extension (either a compiled 
+LiveCode Builder module file or a LiveCode stack), that it contains a
+manifest XML file and that the manifest contains the minimum required
+information, namely the name, version, author, type, and title.
+
+The manifest information is returned in the <rManifestDataA> out 
+parameter.
 */
 command extensionValidateLCEPackage pPackage, @rManifestDataA
    # Open the zip archive
