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
24 lines
659 B
JavaScript
24 lines
659 B
JavaScript
/* @flow */
|
|
'use strict';
|
|
|
|
/**
|
|
* Apply a function to all comments within a hierarchy: this iterates
|
|
* through children in the 'members' property.
|
|
*
|
|
* @param {Array<Object>} comments an array of nested comments
|
|
* @param {Function} fn a walker function
|
|
* @param {Object} [options] options passed through to walker function
|
|
* @returns {Array<Object>} comments
|
|
*/
|
|
function walk(comments/*: Array<Comment>*/, fn/*: Function*/, options/*: ?Object*/) {
|
|
comments.forEach(comment => {
|
|
fn(comment, options);
|
|
for (var scope in comment.members) {
|
|
walk(comment.members[scope], fn, options);
|
|
}
|
|
});
|
|
return comments;
|
|
}
|
|
|
|
module.exports = walk;
|