fix(core): JSDoc for new addModel methods to the model manager

Signed-off-by: Jerome Simeon <[email protected]>
accordproject · Mar 15, 2022 · 2c3bf4e · 2c3bf4e
1 parent 476d638
commit 2c3bf4e
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 8 deletions.
diff --git a/packages/concerto-core/api.txt b/packages/concerto-core/api.txt
@@ -3,8 +3,8 @@ class BaseModelManager {
    + boolean isModelManager() 
    + Object accept(Object,Object) 
    + void validateModelFile(string|ModelFile,string?) throws IllegalModelException
-   + Object addModelFile(ModelFile|,string,string,boolean?) throws IllegalModelException
-   + Object addModel(modelInput,string,string,boolean?) throws IllegalModelException
+   + Object addModelFile(ModelFile,string?,string?,boolean?) throws IllegalModelException
+   + Object addModel(modelInput,string?,string?,boolean?) throws IllegalModelException
    + Object updateModelFile(string|ModelFile,string?,boolean?) throws IllegalModelException
    + void deleteModelFile(string) 
    + Object[] addModelFiles(|,string[],boolean?) 

diff --git a/packages/concerto-core/changelog.txt b/packages/concerto-core/changelog.txt
@@ -24,13 +24,16 @@
 # Note that the latest public API is documented using JSDocs and is available in api.txt.
 #
 
-Version 1.2.2 {a437ce0b297bb18414cf37492a8528fe} 2021-11-24
+Version 1.2.2 {a92fdef435d8588901b0c5f4b7b7cff1} 2021-11-24
 - Remove custom instanceof and add methods to check runtime type
 - Remove support for Node 12
 - Generate Typescript definitions from JSDoc
 - Parser directly constructs metamodel instance
 - Convert MetaModel to a class for Typescript + Webpack compatability
 - Update Acorn to latest and refactor the JavaScript parser so we can use static class members
+- New packages for parsing and metamodel, distinct from core
+- Revisions to model manager API to support various inputs (e.g., CTO or AST)
+- New vocabulary package for handling model vocabularies
 
 Version 1.2.1 {b19318bb094e5da7bdff192cf9a3b4f2} 2021-08-12
 - Fixes to metamodel, including terminology changes

diff --git a/packages/concerto-core/lib/basemodelmanager.js b/packages/concerto-core/lib/basemodelmanager.js
@@ -141,9 +141,9 @@ class BaseModelManager {
      * 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 {ModelFile|*} modelFile - Model as an AST or object
-     * @param {string} cto - an optional cto string
-     * @param {string} fileName - an optional file name to associate with the model file
+     * @param {ModelFile} modelFile - Model as a ModelFile object
+     * @param {string} [cto] - an optional cto string
+     * @param {string} [fileName] - an optional file name to associate with the model file
      * @param {boolean} [disableValidation] - If true then the model files are not validated
      * @throws {IllegalModelException}
      * @return {Object} The newly added model file (internal).
@@ -173,8 +173,8 @@ class BaseModelManager {
      * must be added in dependency order, or the addModel method can be
      * used to add a set of files irrespective of dependencies.
      * @param {*} modelInput - Model (as a string or object)
-     * @param {string} cto - an optional cto string
-     * @param {string} fileName - an optional file name to associate with the model file
+     * @param {string} [cto] - an optional cto string
+     * @param {string} [fileName] - an optional file name to associate with the model file
      * @param {boolean} [disableValidation] - If true then the model files are not validated
      * @throws {IllegalModelException}
      * @return {Object} The newly added model file (internal).