fix(core) Some corrections to the JSDoc

Signed-off-by: jeromesimeon <[email protected]>
accordproject · Dec 2, 2021 · c641751 · c641751
1 parent 9a6f449
commit c641751
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/packages/concerto-core/api.txt b/packages/concerto-core/api.txt
@@ -197,7 +197,7 @@ class ModelManager {
    + void constructor(object?) 
    + boolean isModelManager() 
    + Object accept(Object,Object) 
-   + void validateModelFile(string,string?) throws IllegalModelException
+   + void validateModelFile(string|ModelFile,string?) throws IllegalModelException
    + Object addModelFile(string|ModelFile,string,boolean?) throws IllegalModelException
    + Object updateModelFile(string|ModelFile,string?,boolean?) throws IllegalModelException
    + void deleteModelFile(string) 

diff --git a/packages/concerto-core/changelog.txt b/packages/concerto-core/changelog.txt
@@ -24,7 +24,7 @@
 # Note that the latest public API is documented using JSDocs and is available in api.txt.
 #
 
-Version 1.2.2 {f3671c1416edd096c788dffd63639b48} 2021-11-24
+Version 1.2.2 {e30709343834104db4936fc5f1c96091} 2021-11-24
 - Remove custom instanceof and add methods to check runtime type
 - Remove support for Node 12
 - Generate Typescript definitions from JSDoc

diff --git a/packages/concerto-core/lib/introspect/modelfile.js b/packages/concerto-core/lib/introspect/modelfile.js
@@ -39,8 +39,8 @@ class ModelFile {
      * Use the ModelManager to manage ModelFiles.
      * @param {ModelManager} modelManager - the ModelManager that manages this
      * ModelFile
-     * @param {object} ast - The DSL model as a string.
-     * @param {string} [definitions] - The (optional) CTO model as a string.
+     * @param {object} ast - The abstract syntax tree of the model as a JSON object.
+     * @param {string} [definitions] - The optional CTO model as a string.
      * @param {string} [fileName] - The optional filename for this modelfile
      * @throws {IllegalModelException}
      */

diff --git a/packages/concerto-core/lib/modelmanager.js b/packages/concerto-core/lib/modelmanager.js
@@ -100,7 +100,7 @@ abstract concept Event {}
      * Note that if there are dependencies between multiple files the files
      * must be added in dependency order, or the addModelFiles method can be
      * used to add a set of files irrespective of dependencies.
-     * @param {string} modelFile - The Concerto file as a string
+     * @param {string|ModelFile} modelFile - The Concerto file as a string
      * @param {string} [fileName] - a file name to associate with the model file
      * @throws {IllegalModelException}
      */