jenkins-bot has submitted this change and it was merged. Change subject: Polish out the TokenTransformManager docs ......................................................................
Polish out the TokenTransformManager docs Includes a change to the docs for addTransform, which I'll use to document the handler methods in the next patch. Change-Id: I5948ea6045e0228bfea28da40e2ffff27f54b091 --- M js/doc.basicTypes.js M js/lib/ext.core.AttributeExpander.js M js/lib/ext.core.Sanitizer.js M js/lib/ext.util.TokenCollector.js M js/lib/mediawiki.TokenTransformManager.js 5 files changed, 30 insertions(+), 27 deletions(-) Approvals: Subramanya Sastry: Looks good to me, approved Cscott: Looks good to me, but someone else must approve jenkins-bot: Verified diff --git a/js/doc.basicTypes.js b/js/doc.basicTypes.js index ad10e57..445c537 100644 --- a/js/doc.basicTypes.js +++ b/js/doc.basicTypes.js @@ -49,4 +49,3 @@ * * A Request object for the express application. [See the express documentation for more](http://expressjs.com/api.html#req.params). */ - diff --git a/js/lib/ext.core.AttributeExpander.js b/js/lib/ext.core.AttributeExpander.js index 0312693..e7504c0 100644 --- a/js/lib/ext.core.AttributeExpander.js +++ b/js/lib/ext.core.AttributeExpander.js @@ -110,7 +110,7 @@ * Generic attribute expansion handler. * * @constructor - * @param {Object} manager The manager for this stage of the parse. + * @param {TokenTransformManager} manager The manager for this stage of the parse. * @param {Object} options Any options for the expander. */ function AttributeExpander ( manager, options ) { diff --git a/js/lib/ext.core.Sanitizer.js b/js/lib/ext.core.Sanitizer.js index dfcd964..06947e0 100644 --- a/js/lib/ext.core.Sanitizer.js +++ b/js/lib/ext.core.Sanitizer.js @@ -575,7 +575,7 @@ * @class * * @constructor - * @param {Object} manager The manager for this part of the pipeline. + * @param {TokenTransformManager} manager The manager for this part of the pipeline. */ function Sanitizer ( manager ) { this.manager = manager; diff --git a/js/lib/ext.util.TokenCollector.js b/js/lib/ext.util.TokenCollector.js index 3ab7701..9167166 100644 --- a/js/lib/ext.util.TokenCollector.js +++ b/js/lib/ext.util.TokenCollector.js @@ -19,12 +19,12 @@ * Calls the passed-in callback with the collected tokens. * * @constructor - * @param {Object} manager SyncTokenTransformManager to register with + * @param {TokenTransformManager} manager SyncTokenTransformManager to register with * @param {Function} transformation Transform function - * @param {Array} transformation.tokens Chunk of tokens - * @param {Function} transformation.cb Callback fired on each chunk - * @param {Array} transformation.cb.tokens Tokens we got back - * @param {TokenTransformManager} transformation.manager Manager for the token chunk + * @param {Array} transformation.tokens Chunk of tokens + * @param {Function} transformation.cb Callback fired on each chunk + * @param {Array} transformation.cb.tokens Tokens we got back + * @param {TokenTransformManager} transformation.manager Manager for the token chunk * @param {boolean} toEnd Match the 'end' tokens as closing tag as well (accept unclosed sections). * @param {number} rank Numerical rank of the tranform * @param {string} type Token type to register for ('tag', 'text' etc) diff --git a/js/lib/mediawiki.TokenTransformManager.js b/js/lib/mediawiki.TokenTransformManager.js index e3aa16a..9bb993e 100644 --- a/js/lib/mediawiki.TokenTransformManager.js +++ b/js/lib/mediawiki.TokenTransformManager.js @@ -60,8 +60,11 @@ * * @class * @constructor - * @param {Function} callback, a callback function accepting a token list as - * its only argument. + * @param {MWParserEnvironment} env + * @param {Object} options + * @param {ParserPipelineFactory} pipeFactory + * @param {number} phaseEndRank + * @param {string} attributeType */ function TokenTransformManager( env, options, pipeFactory, phaseEndRank, attributeType ) { events.EventEmitter.call(this); @@ -120,9 +123,16 @@ * Add a transform registration. * * @method - * @param {Function} transform. + * @param {Function} transformation + * @param {Token} transformation.token + * @param {Object} transformation.frame + * @param {Function} transformation.cb + * @param {Object} transformation.cb.result + * @param {Token[]} transformation.cb.result.tokens + * @param {Object} transformation.return + * @param {Token[]} transformation.return.tokens * @param {string} Debug string to identify the transformer in a trace. - * @param {Number} rank, [0,3) with [0,1) in-order on input token stream, + * @param {number} rank, [0,3) with [0,1) in-order on input token stream, * [1,2) out-of-order and [2,3) in-order on output token stream * @param {string} type, one of 'tag', 'text', 'newline', 'comment', 'end', * 'martian' (unknown token), 'any' (any token, matched before other matches). @@ -247,12 +257,7 @@ * { tokens: [tokens] }: fully expanded, tokens will be reprocessed * * @class - * @constructor - * @param {MWParserEnvironment} env - * @param {Object} options - * @param {ParserPipelineFactory} pipeFactory - * @param {number} phaseEndRank - * @param {string} attributeType + * @extends TokenTransformManager */ function AsyncTokenTransformManager ( env, options, pipeFactory, phaseEndRank, attributeType ) { TokenTransformManager.call(this); @@ -270,7 +275,11 @@ // Inherit from TokenTransformManager, and thus also from EventEmitter. util.inherits(AsyncTokenTransformManager, TokenTransformManager); -// Reset state between uses +/** + * @method + * + * Reset state between uses + */ AsyncTokenTransformManager.prototype.reset = function() { this.tailAccumulator = null; this.tokenCB = this.emitChunk.bind( this ); @@ -812,12 +821,7 @@ * Subclass for phase 3, in-order and synchronous processing. * * @class - * @constructor - * @param {MWParserEnvironment} env - * @param {Object} options - * @param {ParserPipelineFactory} pipeFactory - * @param {Number} phaseEndRank - * @param {string} attributeType + * @extends TokenTransformManager */ function SyncTokenTransformManager ( env, options, pipeFactory, phaseEndRank, attributeType ) { TokenTransformManager.call(this); @@ -978,7 +982,7 @@ * * @class * @constructor - * @param {AsyncTokenTransformManager} manager + * @param {TokenTransformManager} manager * @param {Object} options * @param {Function} callback * @param {Array} callback.attributes @@ -1165,7 +1169,7 @@ * @class * @private * @constructor - * @param {Object} manager + * @param {TokenTransformManager} manager * @param {Function} parentCB The callback to call after we've finished accumulating. */ TokenAccumulator = function( manager, parentCB ) { -- To view, visit https://gerrit.wikimedia.org/r/54511 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I5948ea6045e0228bfea28da40e2ffff27f54b091 Gerrit-PatchSet: 6 Gerrit-Project: mediawiki/extensions/Parsoid Gerrit-Branch: master Gerrit-Owner: MarkTraceur <[email protected]> Gerrit-Reviewer: Cscott <[email protected]> Gerrit-Reviewer: GWicke <[email protected]> Gerrit-Reviewer: Subramanya Sastry <[email protected]> Gerrit-Reviewer: jenkins-bot _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
