awesome-cordova-plugins/scripts/docs/processors/parse-optional.js

23 lines
642 B
JavaScript
Raw Normal View History

2017-03-24 10:07:59 +08:00
"use strict";
2017-03-24 03:59:33 +08:00
module.exports = function parseOptional() {
return {
$runBefore: ['rendering-docs'],
2017-03-24 10:07:59 +08:00
$process: docs => {
docs.forEach(doc => {
if (doc.members && doc.members.length) {
for (let i in doc.members) {
if (doc.members[i].params && doc.members[i].params.length) {
for (let ii in doc.members[i].params) {
if (doc.members[i].params[ii].optional) {
2017-03-24 03:59:33 +08:00
doc.members[i].params[ii].description += '<strong class="tag">Optional</strong>';
}
}
}
}
}
});
return docs;
}
}
};