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
26 lines
777 B
JavaScript
26 lines
777 B
JavaScript
|
|
'use strict';
|
|
/* @flow */
|
|
|
|
/**
|
|
* Detect whether a comment is a JSDoc comment: it must be a block
|
|
* comment which starts with two asterisks, not any other number of asterisks.
|
|
*
|
|
* The code parser automatically strips out the first asterisk that's
|
|
* required for the comment to be a comment at all, so we count the remaining
|
|
* comments.
|
|
*
|
|
* @name isJSDocComment
|
|
* @param {Object} comment an ast node of the comment
|
|
* @return {boolean} whether it is valid
|
|
*/
|
|
module.exports = function isJSDocComment(comment/*: {
|
|
value: string,
|
|
type: string
|
|
}*/) {
|
|
var asterisks = comment.value.match(/^(\*+)/);
|
|
return (comment.type === 'CommentBlock' || // estree
|
|
comment.type === 'Block') // get-comments / traditional
|
|
&& asterisks && asterisks[ 1 ].length === 1;
|
|
};
|