diff options
Diffstat (limited to 'lib/models/templateBlock.js')
-rw-r--r-- | lib/models/templateBlock.js | 71 |
1 files changed, 32 insertions, 39 deletions
diff --git a/lib/models/templateBlock.js b/lib/models/templateBlock.js index 36f7c5b..458f084 100644 --- a/lib/models/templateBlock.js +++ b/lib/models/templateBlock.js @@ -43,10 +43,9 @@ TemplateBlock.prototype.getBlocks = function() { /** - Return shortcuts associated with this block or undefined - - @return {TemplateShortcut|undefined} -*/ + * Return shortcuts associated with this block or undefined + * @return {TemplateShortcut|undefined} + */ TemplateBlock.prototype.getShortcuts = function() { var shortcuts = this.get('shortcuts'); if (shortcuts.size === 0) { @@ -57,19 +56,17 @@ TemplateBlock.prototype.getShortcuts = function() { }; /** - Return name for the nunjucks extension - - @return {String} -*/ + * Return name for the nunjucks extension + * @return {String} + */ TemplateBlock.prototype.getExtensionName = function() { return 'Block' + this.getName() + 'Extension'; }; /** - Return a nunjucks extension to represents this block - - @return {Nunjucks.Extension} -*/ + * Return a nunjucks extension to represents this block + * @return {Nunjucks.Extension} + */ TemplateBlock.prototype.toNunjucksExt = function(mainContext, blocksOutput) { blocksOutput = blocksOutput || {}; @@ -192,11 +189,11 @@ TemplateBlock.prototype.toNunjucksExt = function(mainContext, blocksOutput) { }; /** - Apply a block to a content - @param {Object} inner - @param {Object} context - @return {Promise<String>|String} -*/ + * Apply a block to a content + * @param {Object} inner + * @param {Object} context + * @return {Promise<String>|String} + */ TemplateBlock.prototype.applyBlock = function(inner, context) { var processFn = this.getProcess(); @@ -215,11 +212,10 @@ TemplateBlock.prototype.applyBlock = function(inner, context) { }; /** - Normalize result from a block process function - - @param {Object|String} result - @return {Object} -*/ + * Normalize result from a block process function + * @param {Object|String} result + * @return {Object} + */ TemplateBlock.prototype.normalizeBlockResult = function(result) { if (is.string(result)) { result = { body: result }; @@ -230,12 +226,11 @@ TemplateBlock.prototype.normalizeBlockResult = function(result) { }; /** - Convert a block result to HTML - - @param {Object} result - @param {Object} blocksOutput: stored post processing blocks in this object - @return {String} -*/ + * Convert a block result to HTML + * @param {Object} result + * @param {Object} blocksOutput: stored post processing blocks in this object + * @return {String} + */ TemplateBlock.prototype.blockResultToHtml = function(result, blocksOutput) { var indexedKey; var toIndex = (!result.parse) || (result.post !== undefined); @@ -256,12 +251,11 @@ TemplateBlock.prototype.blockResultToHtml = function(result, blocksOutput) { }; /** - Create a template block from a function or an object - - @param {String} blockName - @param {Object} block - @return {TemplateBlock} -*/ + * Create a template block from a function or an object + * @param {String} blockName + * @param {Object} block + * @return {TemplateBlock} + */ TemplateBlock.create = function(blockName, block) { if (is.fn(block)) { block = new Immutable.Map({ @@ -275,11 +269,10 @@ TemplateBlock.create = function(blockName, block) { }; /** - Extract kwargs from an arguments array - - @param {Array} args - @return {Object} -*/ + * Extract kwargs from an arguments array + * @param {Array} args + * @return {Object} + */ function extractKwargs(args) { var last = args[args.length - 1]; return (is.object(last) && last.__keywords)? args.pop() : {}; |