MarkTraceur has uploaded a new change for review. https://gerrit.wikimedia.org/r/54511
Change subject: Polish out the TokenTransnformManager docs ...................................................................... Polish out the TokenTransnformManager docs 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, 20 insertions(+), 25 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Parsoid refs/changes/11/54511/1 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 f091a82..a541d08 100644 --- a/js/lib/ext.core.AttributeExpander.js +++ b/js/lib/ext.core.AttributeExpander.js @@ -18,7 +18,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 cf0bed6..945f084 100644 --- a/js/lib/ext.core.Sanitizer.js +++ b/js/lib/ext.core.Sanitizer.js @@ -569,7 +569,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 0db8d19..9cfefeb 100644 --- a/js/lib/ext.util.TokenCollector.js +++ b/js/lib/ext.util.TokenCollector.js @@ -12,18 +12,17 @@ * Calls the passed-in callback with the collected tokens. * * @constructor - * @param {Object} manager SyncTokenTransformManager to register with + * @param {TokenTransformManager} manager * @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.cb.tokens + * @param {TokenTransformManager} transformation.manager * @param {boolean} toEnd Match the 'end' tokens as closing tag as well (accept unclosed sections). - * @param {number} rank Numerical rank of the tranform + * @param {number} rank * @param {string} type Token type to register for ('tag', 'text' etc) * @param {string} name (optional, only for token type 'tag'): tag name. */ - function TokenCollector ( manager, transformation, toEnd, rank, type, name ) { this.transformation = transformation; this.manager = manager; diff --git a/js/lib/mediawiki.TokenTransformManager.js b/js/lib/mediawiki.TokenTransformManager.js index 9ee33f4..e15a617 100644 --- a/js/lib/mediawiki.TokenTransformManager.js +++ b/js/lib/mediawiki.TokenTransformManager.js @@ -50,8 +50,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 ) { // Separate the constructor, so that we can call it from subclasses. @@ -241,12 +244,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 ) { this.uid = auid++; // useful for debugging @@ -265,7 +263,11 @@ AsyncTokenTransformManager.prototype = new TokenTransformManager(); AsyncTokenTransformManager.prototype.constructor = AsyncTokenTransformManager; -// Reset state between uses +/** + * @method + * + * Reset state between uses + */ AsyncTokenTransformManager.prototype.reset = function() { this.tailAccumulator = null; this.tokenCB = this.emitChunk.bind( this ); @@ -805,12 +807,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 ) { this.env = env; @@ -967,7 +964,7 @@ * * @class * @constructor - * @param {AsyncTokenTransformManager} manager + * @param {TokenTransformManager} manager * @param {Object} options * @param {Function} callback * @param {Array} callback.attributes @@ -1156,7 +1153,7 @@ * @class * @private * @constructor - * @param {Object} manager + * @param {TokenTransformManager} manager * @param {Function} parentCB The callback to call after we've finished accumulating. */ function TokenAccumulator( manager, parentCB ) { -- To view, visit https://gerrit.wikimedia.org/r/54511 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I5948ea6045e0228bfea28da40e2ffff27f54b091 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/Parsoid Gerrit-Branch: master Gerrit-Owner: MarkTraceur <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
