mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-18 14:17:30 +00:00
25152edeb9
* style(prettier): Use prettier for code formatting This saves us style issues. Also adds husky and lint-staged for pre-commit testing Refs https://github.com/documentationjs/documentation/issues/709
28 lines
670 B
JavaScript
28 lines
670 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;
|