Code coverage report for master/lib/jsdoc/doclet.js

Statements: 97.55% (159 / 163)      Branches: 92.81% (129 / 139)      Functions: 100% (20 / 20)      Lines: 97.52% (157 / 161)      Ignored: none     

All files » master/lib/jsdoc/ » doclet.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471                      1 1                       1 1 1   1 5798 960     5798 1855     5798 699       1 1               1 1332 1332 1332   1332 461   871 10 3   7 5     861 9   852   1   851       851       851 9     1332     1 1865           1863           1863             1 1865 1865 1865 1865       1865           4430 3039   3039 2565 2565   2565 2565                 1865     1 1865   1865 686       686   1865                     1 26 26 26                     1 1865     1865 1865   1865 1865   1865   1865 2565     1863       1 2740 2740   2740 2725   2740 10   2740 2     2740 1331     2740 6       2740 118 134 6                       1 5800     5798 2274     5798 39 39     5798     1 1769   1769               1           766                 1           1003 1003 77                       1 1 1                           1 99 99 99   99 1   1   1       1     98                 1 10 10 6     10           8   10     1           24 24               1           27 27               1           1865   1865           1793     1865           1794           1794   1794 1794 25                 1865 1865 1865 1114           770   1114           1077   1114 1114         1114 19   1114           344   1114 655        
/**
 * @overview
 * @author Michael Mathews <micmath@gmail.com>
 * @license Apache License 2.0 - See file 'LICENSE.md' in this project.
 */
 
/**
 * @module jsdoc/doclet
 */
'use strict';
 
var _ = require('underscore');
var jsdoc = {
    env: require('jsdoc/env'),
    name: require('jsdoc/name'),
    src: {
        astnode: require('jsdoc/src/astnode'),
        Syntax: require('jsdoc/src/syntax').Syntax
    },
    tag: {
        Tag: require('jsdoc/tag').Tag,
        dictionary: require('jsdoc/tag/dictionary')
    }
};
var path = require('jsdoc/path');
var Syntax = jsdoc.src.Syntax;
var util = require('util');
 
function applyTag(doclet, tag) {
    if (tag.title === 'name') {
        doclet.name = tag.value;
    }
 
    if (tag.title === 'kind') {
        doclet.kind = tag.value;
    }
 
    if (tag.title === 'description') {
        doclet.description = tag.value;
    }
}
 
function fakeMeta(node) {
    return {
        type: node ? node.type : null,
        node: node
    };
}
 
// use the meta info about the source code to guess what the doclet kind should be
// TODO: set this elsewhere (maybe jsdoc/src/astnode.getInfo)
function codeToKind(code) {
    var isFunction = jsdoc.src.astnode.isFunction;
    var kind = 'member';
    var node = code.node;
 
    if ( isFunction(code.type) && code.type !== Syntax.MethodDefinition ) {
        kind = 'function';
    }
    else if (code.type === Syntax.MethodDefinition) {
        if (code.node.kind === 'constructor') {
            kind = 'class';
        }
        else if (code.node.kind !== 'get' && code.node.kind !== 'set') {
            kind = 'function';
        }
    }
    else if (code.type === Syntax.ClassDeclaration || code.type === Syntax.ClassExpression) {
        kind = 'class';
    }
    else if (code.type === Syntax.ExportAllDeclaration) {
        // this value will often be an Identifier for a variable, which isn't very useful
        kind = codeToKind(fakeMeta(node.source));
    }
    else Iif (code.type === Syntax.ExportDefaultDeclaration ||
        code.type === Syntax.ExportNamedDeclaration) {
        kind = codeToKind(fakeMeta(node.declaration));
    }
    else Iif (code.type === Syntax.ExportSpecifier) {
        // this value will often be an Identifier for a variable, which isn't very useful
        kind = codeToKind(fakeMeta(node.local));
    }
    else if ( code.node && code.node.parent && isFunction(code.node.parent) ) {
        kind = 'param';
    }
 
    return kind;
}
 
function unwrap(docletSrc) {
    if (!docletSrc) { return ''; }
 
    // note: keep trailing whitespace for @examples
    // extra opening/closing stars are ignored
    // left margin is considered a star and a space
    // use the /m flag on regex to avoid having to guess what this platform's newline is
    docletSrc =
        docletSrc.replace(/^\/\*\*+/, '') // remove opening slash+stars
        .replace(/\**\*\/$/, '\\Z')       // replace closing star slash with end-marker
        .replace(/^\s*(\* ?|\\Z)/gm, '')  // remove left margin like: spaces+star or spaces+end-marker
        .replace(/\s*\\Z$/g, '');         // remove end-marker
 
    return docletSrc;
}
 
/**
 * Convert the raw source of the doclet comment into an array of pseudo-Tag objects.
 * @private
 */
function toTags(docletSrc) {
    var parsedTag;
    var tagData = [];
    var tagText;
    var tagTitle;
 
    // split out the basic tags, keep surrounding whitespace
    // like: @tagTitle tagBody
    docletSrc
        // replace splitter ats with an arbitrary sequence
        .replace(/^(\s*)@(\S)/gm, '$1\\@$2')
        // then split on that arbitrary sequence
        .split('\\@')
        .forEach(function($) {
            if ($) {
                parsedTag = $.match(/^(\S+)(?:\s+(\S[\s\S]*))?/);
 
                if (parsedTag) {
                    tagTitle = parsedTag[1];
                    tagText = parsedTag[2];
 
                    Eif (tagTitle) {
                        tagData.push({
                            title: tagTitle,
                            text: tagText
                        });
                    }
                }
            }
    });
 
    return tagData;
}
 
function fixDescription(docletSrc, meta) {
    var isClass;
 
    if (!/^\s*@/.test(docletSrc) && docletSrc.replace(/\s/g, '').length) {
        isClass = meta.code &&
            (meta.code.type === Syntax.ClassDeclaration ||
            meta.code.type === Syntax.ClassExpression);
 
        docletSrc = (isClass ? '@classdesc' : '@description') + ' ' + docletSrc;
    }
    return docletSrc;
}
 
/**
 * Replace the existing tag dictionary with a new tag dictionary.
 *
 * Used for testing only.
 *
 * @private
 * @param {module:jsdoc/tag/dictionary.Dictionary} dict - The new tag dictionary.
 */
exports._replaceDictionary = function _replaceDictionary(dict) {
    jsdoc.tag.dictionary = dict;
    require('jsdoc/tag')._replaceDictionary(dict);
    require('jsdoc/util/templateHelper')._replaceDictionary(dict);
};
 
/**
 * @class
 * @classdesc Represents a single JSDoc comment.
 * @alias module:jsdoc/doclet.Doclet
 *
 * @param {string} docletSrc - The raw source code of the jsdoc comment.
 * @param {object=} meta - Properties describing the code related to this comment.
 */
var Doclet = exports.Doclet = function(docletSrc, meta) {
    var newTags = [];
 
    /** The original text of the comment from the source code. */
    this.comment = docletSrc;
    this.setMeta(meta);
 
    docletSrc = unwrap(docletSrc);
    docletSrc = fixDescription(docletSrc, meta);
 
    newTags = toTags.call(this, docletSrc);
 
    for (var i = 0, l = newTags.length; i < l; i++) {
        this.addTag(newTags[i].title, newTags[i].text);
    }
 
    this.postProcess();
};
 
/** Called once after all tags have been added. */
Doclet.prototype.postProcess = function() {
    var i;
    var l;
 
    if (!this.preserveName) {
        jsdoc.name.resolve(this);
    }
    if (this.name && !this.longname) {
        this.setLongname(this.name);
    }
    if (this.memberof === '') {
        delete this.memberof;
    }
 
    if (!this.kind && this.meta && this.meta.code) {
        this.addTag( 'kind', codeToKind(this.meta.code) );
    }
 
    if (this.variation && this.longname && !/\)$/.test(this.longname) ) {
        this.longname += '(' + this.variation + ')';
    }
 
    // add in any missing param names
    if (this.params && this.meta && this.meta.code && this.meta.code.paramnames) {
        for (i = 0, l = this.params.length; i < l; i++) {
            if (!this.params[i].name) {
                this.params[i].name = this.meta.code.paramnames[i] || '';
            }
        }
    }
};
 
/**
 * Add a tag to the doclet.
 *
 * @param {string} title - The title of the tag being added.
 * @param {string} [text] - The text of the tag being added.
 */
Doclet.prototype.addTag = function(title, text) {
    var tagDef = jsdoc.tag.dictionary.lookUp(title),
        newTag = new jsdoc.tag.Tag(title, text, this.meta);
 
    if (tagDef && tagDef.onTagged) {
       tagDef.onTagged(this, newTag);
    }
 
    if (!tagDef) {
        this.tags = this.tags || [];
        this.tags.push(newTag);
    }
 
    applyTag(this, newTag);
};
 
function removeGlobal(longname) {
    var globalRegexp = new RegExp('^' + jsdoc.name.LONGNAMES.GLOBAL + '\\.?');
 
    return longname.replace(globalRegexp, '');
}
 
/**
 * Set the doclet's `memberof` property.
 *
 * @param {string} sid - The longname of the doclet's parent symbol.
 */
Doclet.prototype.setMemberof = function(sid) {
    /**
     * The longname of the symbol that contains this one, if any.
     * @alias module:jsdoc/doclet.Doclet#memberof
     * @type {string}
     */
    this.memberof = removeGlobal(sid)
        .replace(/\.prototype/g, jsdoc.name.SCOPE.PUNC.INSTANCE);
};
 
/**
 * Set the doclet's `longname` property.
 *
 * @param {string} name - The longname for the doclet.
 */
Doclet.prototype.setLongname = function(name) {
    /**
     * The fully resolved symbol name.
     * @alias module:jsdoc/doclet.Doclet#longname
     * @type {string}
     */
    this.longname = removeGlobal(name);
    if (jsdoc.tag.dictionary.isNamespace(this.kind)) {
        this.longname = jsdoc.name.applyNamespace(this.longname, this.kind);
    }
};
 
/**
 * Get the full path to the source file that is associated with a doclet.
 *
 * @private
 * @param {module:jsdoc/doclet.Doclet} The doclet to check for a filepath.
 * @return {string} The path to the doclet's source file, or an empty string if the path is not
 * available.
 */
function getFilepath(doclet) {
    Eif (!doclet || !doclet.meta || !doclet.meta.filename) {
        return '';
    }
 
    return path.join(doclet.meta.path || '', doclet.meta.filename);
}
 
/**
 * Set the doclet's `scope` property. Must correspond to a scope name that is defined in
 * {@link module:jsdoc/name.SCOPE.NAMES}.
 *
 * @param {module:jsdoc/name.SCOPE.NAMES} scope - The scope for the doclet relative to the symbol's
 * parent.
 * @throws {Error} If the scope name is not recognized.
 */
Doclet.prototype.setScope = function(scope) {
    var errorMessage;
    var filepath;
    var scopeNames = _.values(jsdoc.name.SCOPE.NAMES);
 
    if (scopeNames.indexOf(scope) === -1) {
        filepath = getFilepath(this);
 
        errorMessage = util.format('The scope name "%s" is not recognized. Use one of the ' +
            'following values: %j', scope, scopeNames);
        Iif (filepath) {
            errorMessage += util.format(' (Source file: %s)', filepath);
        }
 
        throw new Error(errorMessage);
    }
 
    this.scope = scope;
};
 
/**
 * Add a symbol to this doclet's `borrowed` array.
 *
 * @param {string} source - The longname of the symbol that is the source.
 * @param {string} target - The name the symbol is being assigned to.
 */
Doclet.prototype.borrow = function(source, target) {
    var about = { from: source };
    if (target) {
        about.as = target;
    }
 
    if (!this.borrowed) {
        /**
         * A list of symbols that are borrowed by this one, if any.
         * @alias module:jsdoc/doclet.Doclet#borrowed
         * @type {Array.<string>}
         */
        this.borrowed = [];
    }
    this.borrowed.push(about);
};
 
Doclet.prototype.mix = function(source) {
    /**
     * A list of symbols that are mixed into this one, if any.
     * @alias module:jsdoc/doclet.Doclet#mixes
     * @type Array.<string>
     */
    this.mixes = this.mixes || [];
    this.mixes.push(source);
};
 
/**
 * Add a symbol to the doclet's `augments` array.
 *
 * @param {string} base - The longname of the base symbol.
 */
Doclet.prototype.augment = function(base) {
    /**
     * A list of symbols that are augmented by this one, if any.
     * @alias module:jsdoc/doclet.Doclet#augments
     * @type Array.<string>
     */
    this.augments = this.augments || [];
    this.augments.push(base);
};
 
/**
 * Set the `meta` property of this doclet.
 *
 * @param {object} meta
 */
Doclet.prototype.setMeta = function(meta) {
    /**
     * Information about the source code associated with this doclet.
     * @alias module:jsdoc/doclet.Doclet#meta
     * @namespace
     */
    this.meta = this.meta || {};
 
    if (meta.range) {
        /**
         * The positions of the first and last characters of the code associated with this doclet.
         * @alias module:jsdoc/doclet.Doclet#meta.range
         * @type Array.<number>
         */
        this.meta.range = meta.range.slice(0);
    }
 
    if (meta.lineno) {
        /**
         * The name of the file containing the code associated with this doclet.
         * @alias module:jsdoc/doclet.Doclet#meta.filename
         * @type string
         */
        this.meta.filename = path.basename(meta.filename);
        /**
         * The line number of the code associated with this doclet.
         * @alias module:jsdoc/doclet.Doclet#meta.lineno
         * @type number
         */
        this.meta.lineno = meta.lineno;
 
        var pathname = path.dirname(meta.filename);
        if (pathname && pathname !== '.') {
            this.meta.path = pathname;
        }
    }
 
    /**
     * Information about the code symbol.
     * @alias module:jsdoc/doclet.Doclet#meta.code
     * @namespace
     */
    this.meta.code = this.meta.code || {};
    if (meta.id) { this.meta.code.id = meta.id; }
    if (meta.code) {
        if (meta.code.name) {
            /**
             * The name of the symbol in the source code.
             * @alias module:jsdoc/doclet.Doclet#meta.code.name
             * @type {string}
             */
            this.meta.code.name = meta.code.name;
        }
        if (meta.code.type) {
            /**
             * The type of the symbol in the source code.
             * @alias module:jsdoc/doclet.Doclet#
             * @type {string}
             */
            this.meta.code.type = meta.code.type;
        }
        Eif (meta.code.node) {
            Object.defineProperty(this.meta.code, 'node', {
                value: meta.code.node,
                enumerable: false
            });
        }
        if (meta.code.funcscope) {
            this.meta.code.funcscope = meta.code.funcscope;
        }
        if (typeof meta.code.value !== 'undefined') {
            /**
             * The value of the symbol in the source code.
             * @alias module:jsdoc/doclet.Doclet#meta.code.value
             * @type {*}
             */
            this.meta.code.value = meta.code.value;
        }
        if (meta.code.paramnames) {
            this.meta.code.paramnames = meta.code.paramnames.slice(0);
        }
    }
};