Skip to content

Commit 51585f5

Browse files
committed
fix(doc) Some cleanup on jsdoc annotations for API doc generation
Signed-off-by: Jerome Simeon <jeromesimeon@me.com>
1 parent 3731038 commit 51585f5

9 files changed

+19
-11
lines changed

packages/concerto-core/api.txt

+15
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
1+
class BaseException extends Error {
2+
+ void constructor(string,string)
3+
}
4+
class BaseFileException extends BaseException {
5+
+ void constructor(string,string,string,string,string)
6+
+ string getFileLocation()
7+
+ string getShortMessage()
8+
+ string getFileName()
9+
}
110
class Factory {
11+
+ void constructor(ModelManager)
212
+ Resource newResource(String,String,String,Object,boolean,String,boolean,boolean) throws TypeNotFoundException
313
+ Resource newConcept(String,String,Object,boolean,String,boolean) throws TypeNotFoundException
414
+ Relationship newRelationship(String,String,String) throws TypeNotFoundException
@@ -75,6 +85,7 @@ class Introspector {
7585
+ ClassDeclaration getClassDeclaration(String) throws Error
7686
}
7787
class ModelFile {
88+
+ void constructor(ModelManager,string,string,boolean) throws IllegalModelException
7889
+ boolean isExternal()
7990
+ ModelManager getModelManager()
8091
+ string[] getImports()
@@ -169,6 +180,7 @@ class ValidatedResource extends Resource {
169180
+ void validate() throws Error
170181
}
171182
class ModelManager {
183+
+ void constructor()
172184
+ void validateModelFile(string,string) throws IllegalModelException
173185
+ Object addModelFile(string,string,boolean,boolean) throws IllegalModelException
174186
+ Object updateModelFile(string,string,boolean) throws IllegalModelException
@@ -193,6 +205,9 @@ class ModelManager {
193205
+ void addDecoratorFactory(DecoratorFactory)
194206
+ boolean hasInstance(object)
195207
}
208+
class SecurityException extends BaseException {
209+
+ void constructor(string)
210+
}
196211
class Serializer {
197212
+ void constructor(Factory,ModelManager)
198213
+ void setDefaultOptions(Object)

packages/concerto-core/changelog.txt

+3
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@
2424
# Note that the latest public API is documented using JSDocs and is available in api.txt.
2525
#
2626

27+
Version 0.82.1 {cb6c3b228035279e6997a4e3a34ef348} 2019-10-22
28+
- Make several constructors public
29+
2730
Version 0.80.3 {6f5a9ab45943cb76732c14b11f47d044} 2019-08-24
2831
- Add Ergo option to serializer
2932

packages/concerto-core/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
* Concerto module. Concerto is a framework for defining domain
1919
* specific models.
2020
*
21-
* @module concerto
21+
* @module concerto-core
2222
*/
2323

2424
module.exports.AssetDeclaration = require('./lib/introspect/assetdeclaration');

packages/concerto-core/lib/baseexception.js

-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ const packageJson = require('../package.json');
2121
* @extends Error
2222
* @class
2323
* @memberof module:concerto-core
24-
* @private
2524
*/
2625
class BaseException extends Error {
2726

packages/concerto-core/lib/basefileexception.js

-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ const BaseException = require('./baseexception');
2222
* @see {@link BaseException}
2323
* @class
2424
* @memberof module:concerto-core
25-
* @private
2625
*/
2726
class BaseFileException extends BaseException {
2827

packages/concerto-core/lib/factory.js

-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ class Factory {
5050
* Create the factory.
5151
*
5252
* @param {ModelManager} modelManager - The ModelManager to use for this registry
53-
* @private
5453
*/
5554
constructor(modelManager) {
5655
this.modelManager = modelManager;

packages/concerto-core/lib/introspect/modelfile.js

-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ class ModelFile {
3838
/**
3939
* Create a ModelFile. This should only be called by framework code.
4040
* Use the ModelManager to manage ModelFiles.
41-
* @private
4241
* @param {ModelManager} modelManager - the ModelManager that manages this
4342
* ModelFile
4443
* @param {string} definitions - The DSL model as a string.

packages/concerto-core/lib/modelmanager.js

-5
Original file line numberDiff line numberDiff line change
@@ -33,28 +33,23 @@ const debug = require('debug')('concerto:ModelManager');
3333
/**
3434
* Manages the Concerto model files.
3535
*
36-
*
3736
* The structure of {@link Resource}s (Assets, Transactions, Participants) is modelled
3837
* in a set of Concerto files. The contents of these files are managed
3938
* by the {@link ModelManager}. Each Concerto file has a single namespace and contains
4039
* a set of asset, transaction and participant type definitions.
4140
*
42-
*
4341
* Concerto applications load their Concerto files and then call the {@link ModelManager#addModelFile addModelFile}
4442
* method to register the Concerto file(s) with the ModelManager. The ModelManager
4543
* parses the text of the Concerto file and will make all defined types available
4644
* to other Concerto services, such as the {@link Serializer} (to convert instances to/from JSON)
4745
* and {@link Factory} (to create instances).
4846
*
49-
*
50-
*
5147
* @class
5248
* @memberof module:concerto-core
5349
*/
5450
class ModelManager {
5551
/**
5652
* Create the ModelManager.
57-
* @private
5853
*/
5954
constructor() {
6055
this.modelFiles = {};

packages/concerto-core/lib/securityexception.js

-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ const BaseException = require('./baseexception');
2222
* @see See {@link BaseException}
2323
* @class
2424
* @memberof module:concerto-core
25-
* @private
2625
*/
2726
class SecurityException extends BaseException {
2827

0 commit comments

Comments
 (0)