Skip to content

Commit

Permalink
Jonathan/add options jsdoc (accordproject#729)
Browse files Browse the repository at this point in the history
* feat(map): add jsdoc for enableMapType option

Signed-off-by: Jonathan Casey <[email protected]>

* chore(*): update changelog

Signed-off-by: Jonathan Casey <[email protected]>

---------

Signed-off-by: Jonathan Casey <[email protected]>
  • Loading branch information
jonathan-casey authored Oct 10, 2023
1 parent e067cc3 commit a801e7d
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 1 deletion.
2 changes: 1 addition & 1 deletion packages/concerto-core/api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ class AstModelManager extends BaseModelManager {
+ void constructor(object?)
}
class BaseModelManager {
+ void constructor(object?,boolean?,Object?,boolean?,boolean?,processFile?)
+ void constructor(object?,boolean?,Object?,boolean?,boolean?,boolean?,processFile?)
+ boolean isModelManager()
+ boolean isStrict()
+ Object accept(Object,Object)
Expand Down
3 changes: 3 additions & 0 deletions packages/concerto-core/changelog.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@
# Note that the latest public API is documented using JSDocs and is available in api.txt.
#

Version 3.13.1 {6b09c1c58abcc77eecbb44e375c2efb8} 2023-10-03
- Add enableMapType option to BaseModelManager options

Version 3.13.0 {125b7f97f8740628b2629b2793384cc7} 2023-10-03
- Update DecoratorManager to support multiple value compare
- Create DecoratorManager.validate method to validate structure of decorator command set
Expand Down
1 change: 1 addition & 0 deletions packages/concerto-core/lib/basemodelmanager.js
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ class BaseModelManager {
* @param {Object} [options.regExp] - An alternative regular expression engine.
* @param {boolean} [options.metamodelValidation] - When true, modelfiles will be validated
* @param {boolean} [options.addMetamodel] - When true, the Concerto metamodel is added to the model manager
* @param {boolean} [options.enableMapType] - When true, the Concerto Map Type feature is enabled
* @param {*} [processFile] - how to obtain a concerto AST from an input to the model manager
*/
constructor(options, processFile) {
Expand Down
4 changes: 4 additions & 0 deletions packages/concerto-core/types/lib/basemodelmanager.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,15 @@ declare class BaseModelManager {
* @param {Object} [options.regExp] - An alternative regular expression engine.
* @param {boolean} [options.metamodelValidation] - When true, modelfiles will be validated
* @param {boolean} [options.addMetamodel] - When true, the Concerto metamodel is added to the model manager
* @param {boolean} [options.enableMapType] - When true, the Concerto Map Type feature is enabled
* @param {*} [processFile] - how to obtain a concerto AST from an input to the model manager
*/
constructor(options?: {
strict?: boolean;
regExp?: any;
metamodelValidation?: boolean;
addMetamodel?: boolean;
enableMapType?: boolean;
}, processFile?: any);
processFile: any;
modelFiles: {};
Expand All @@ -42,7 +44,9 @@ declare class BaseModelManager {
regExp?: any;
metamodelValidation?: boolean;
addMetamodel?: boolean;
enableMapType?: boolean;
};
enableMapType: boolean;
metamodelModelFile: any;
/**
* Returns true
Expand Down

0 comments on commit a801e7d

Please sign in to comment.