Skip to content

Commit

Permalink
Add documentation to pipeline-converter & property-descriptor
Browse files Browse the repository at this point in the history
  • Loading branch information
Thomas Jaede committed Aug 22, 2017
1 parent 7cc05d1 commit da4f20b
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 3 deletions.
13 changes: 12 additions & 1 deletion core/converter/pipeline-converter.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
var Converter = require("./converter").Converter,
Promise = require("core/promise").Promise;


/**
* Converter that chains a series of converters together
*
*
* @class PipelineConverter
* @extends Converter
*/
exports.PipelineConverter = Converter.specialize({


Expand All @@ -27,10 +33,15 @@ exports.PipelineConverter = Converter.specialize({
* Convert/Revert
*/

/**
* The converters to chain on convert()
* @type {Converter[]}
*/
converters: {
value: undefined
},


convert: {
value: function (value) {
return this._convertWithNextConverter(value, this.converters.slice());
Expand Down
2 changes: 1 addition & 1 deletion core/meta/property-descriptor.js
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ exports.PropertyDescriptor = Montage.specialize( /** @lends PropertyDescriptor#
* @type {string}
* Definition can be used to express a property as the result of evaluating an expression
* An example would be to flatten/traverse two properties across two objects to make its
* content accessible as a new property name. For example, in a many to many relaational
* content accessible as a new property name. For example, in a many to many relational
* style, a Movie would have a toDirector property to a "DirectorRole" which itself would
* point through a toTalent property to the actual Person. A "director" property definition
* would then be "toDirector.toTalent"
Expand Down
3 changes: 2 additions & 1 deletion jsdoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
"montage.js",
"composer/",
"core/",
"core/converter/",
"ui/"
],
"includePattern": ".+\\.js(doc)?$",
Expand All @@ -32,4 +33,4 @@
"collapseSymbols" : false,
"inverseNav" : true
}
}
}

0 comments on commit da4f20b

Please sign in to comment.