archive-gh-me/documentation
1
0
Fork 0
mirror of https://github.com/documentationjs/documentation.git synced 2026-01-18 14:17:30 +00:00
Code Issues Projects Releases Wiki Activity

Improve internal documentation

Browse Source
This commit is contained in:
Tom MacWright 2016-06-02 12:40:06 -04:00
parent 69a0fdcb80
commit e25919b0d4
2 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
lib/infer/finders.js
View File

@ -1,5 +1,13 @@
var t = require('babel-types');
/**
* Try to find the part of JavaScript a comment is referring to, by
* looking at the syntax tree closest to that comment.
*
* @param {Object} path abstract syntax tree path
* @returns {?Object} ast node, if one is found.
* @private
*/
function findTarget(path) {
if (!path) {
@ -27,6 +35,14 @@ function findTarget(path) {
return path;
}
/**
* Try to find a JavaScript class that this comment refers to,
* whether an expression in an assignment, or a declaration.
*
* @param {Object} node abstract syntax tree node
* @returns {?Object} ast node, if one is found.
* @private
*/
function findClass(node) {
var target = findTarget(node);
return (t.isClassDeclaration(target) || t.isClassExpression(target)) && target;

11
lib/infer/membership.js
View File

@ -6,6 +6,15 @@ var n = require('babel-types'),
isJSDocComment = require('../../lib/is_jsdoc_comment'),
parse = require('../../lib/parse');
/**
* Given an AST node, try to find a comment in front of it that
* has a `lends` tag, and if it has that, return the tag, split by
* .s.
*
* @private
* @param {Object} node AST node
* @returns {string|undefined} lends identifier, if any
*/
function findLendsIdentifiers(node) {
if (!node || !node.leadingComments) {
return;
@ -44,6 +53,7 @@ function extractIdentifiers(path) {
/**
* Count leading identifiers that refer to a module export (`exports` or `module.exports`).
* @private
* @param {Object} comment parsed comment
* @param {Array<string>} identifiers array of identifier names
* @returns {number} number of identifiers referring to a module export (0, 1 or 2)
@ -65,6 +75,7 @@ function countModuleIdentifiers(comment, identifiers) {
* tags from the placement of JSDoc
* annotations within a file
*
* @private
* @param {Object} comment parsed comment
* @returns {Object} comment with membership inferred
*/