mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-25 14:26:29 +00:00
631c6925d4
* feat(core): Switch to Promises everywhere. Adopt Node v4 ES6 Big changes: * Uses template strings where appropriate * Config and argument parsing is unified and there is no such thing as formatterOptions anymore. All user-passed options go through mergeConfig. * The node API surface changed (again): `buildSync` is removed, building operations return Promises. * Now using Flow for internal type annotations. More changes: * Remove buildSync command * feat(inference): Partially implement object shorthand support * Refs #649 * Use Flow annotations to enforce types * Keep flow but switch to comment syntax * Clarify types * More flow improvements * Turn server into class * LinkerStack becomes class too * Fix comment description type * Run flow on lint * Many more flow fixes * More intense flow refactoring * Simplify inference steps * Update inference tests, flow errors down to 1 * Continue refining types * Fix more flow issues * Use 'use strict' everywhere * Make 'ast' property configurable * Fix many tests * Fix more tests * Fix more tests * Fix augments * Test Markdown meta support * Improve test coverage * Switch back from for of to for for speed
48 lines
1.1 KiB
JavaScript
48 lines
1.1 KiB
JavaScript
|
|
'use strict';
|
|
/* @flow */
|
|
|
|
var findTarget = require('./finders').findTarget,
|
|
t = require('babel-types'),
|
|
flowDoctrine = require('../flow_doctrine');
|
|
|
|
/**
|
|
* Infers returns tags by using Flow return type annotations
|
|
*
|
|
* @name inferReturn
|
|
* @param {Object} comment parsed comment
|
|
* @returns {Object} comment with return tag inferred
|
|
*/
|
|
function inferReturn(comment/*: Comment */) {
|
|
if (Array.isArray(comment.returns) &&
|
|
comment.returns.length &&
|
|
comment.returns[0].type) {
|
|
return comment;
|
|
}
|
|
var path = findTarget(comment.context.ast);
|
|
var fn = path && path.node;
|
|
|
|
// In case of `/** */ var x = function () {}` findTarget returns
|
|
// the declarator.
|
|
if (t.isVariableDeclarator(fn)) {
|
|
fn = fn.init;
|
|
}
|
|
|
|
if (t.isFunction(fn) &&
|
|
fn.returnType &&
|
|
fn.returnType.typeAnnotation) {
|
|
var returnType = flowDoctrine(fn.returnType.typeAnnotation);
|
|
if (comment.returns && comment.returns.length > 0) {
|
|
comment.returns[0].type = returnType;
|
|
} else {
|
|
comment.returns = [{
|
|
title: 'returns',
|
|
type: returnType
|
|
}];
|
|
}
|
|
}
|
|
return comment;
|
|
}
|
|
|
|
module.exports = inferReturn;
|