archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

minor doc fixes

Browse Source
This commit is contained in:
Jeff Williams 2014-12-28 15:45:40 -08:00
parent 0080e5f99f
commit dfdce46683
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lib/jsdoc/src/astnode.js
View File

@ -1,4 +1,5 @@
// TODO: docs // TODO: docs
/** @module jsdoc/src/astnode */
'use strict'; 'use strict';
var Syntax = require('jsdoc/src/syntax').Syntax; var Syntax = require('jsdoc/src/syntax').Syntax;
@ -10,6 +11,7 @@ var uid = 100000000;
/** /**
* Check whether an AST node represents a function. * Check whether an AST node represents a function.
* *
* @alias module:jsdoc/src/astnode.isFunction
* @param {Object} node - The AST node to check. * @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. * @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. * Check whether an AST node creates a new scope.
* *
* @alias module:jsdoc/src/astnode.isScope
* @param {Object} node - The AST node to check. * @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. * @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 // TODO: docs
/** /**
* Retrieve information about the node, including its name and type. * Retrieve information about the node, including its name and type.
* @alias module:jsdoc/src/astnode.getInfo
*/ */
var getInfo = exports.getInfo = function(node) { var getInfo = exports.getInfo = function(node) {
var info = {}; var info = {};