From dfdce46683ae474f0ccd004f6f2da9f7a978d0eb Mon Sep 17 00:00:00 2001 From: Jeff Williams Date: Sun, 28 Dec 2014 15:45:40 -0800 Subject: [PATCH] minor doc fixes --- lib/jsdoc/src/astnode.js | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/jsdoc/src/astnode.js b/lib/jsdoc/src/astnode.js index 3eac7d52..a89e652b 100644 --- a/lib/jsdoc/src/astnode.js +++ b/lib/jsdoc/src/astnode.js @@ -1,4 +1,5 @@ // TODO: docs +/** @module jsdoc/src/astnode */ 'use strict'; var Syntax = require('jsdoc/src/syntax').Syntax; @@ -10,6 +11,7 @@ var uid = 100000000; /** * Check whether an AST node represents a function. * + * @alias module:jsdoc/src/astnode.isFunction * @param {Object} node - The AST node to check. * @return {boolean} Set to `true` if the node is a function or `false` in all other cases. */ @@ -20,6 +22,7 @@ var isFunction = exports.isFunction = function(node) { /** * Check whether an AST node creates a new scope. * + * @alias module:jsdoc/src/astnode.isScope * @param {Object} node - The AST node to check. * @return {Boolean} Set to `true` if the node creates a new scope, or `false` in all other cases. */ @@ -214,6 +217,7 @@ var isAssignment = exports.isAssignment = function(node) { // TODO: docs /** * Retrieve information about the node, including its name and type. + * @alias module:jsdoc/src/astnode.getInfo */ var getInfo = exports.getInfo = function(node) { var info = {};