2020-05-16 14:40:49 +02:00
|
|
|
'use strict';
|
2017-03-23 15:59:33 -04:00
|
|
|
module.exports = function parseOptional() {
|
|
|
|
return {
|
|
|
|
$runBefore: ['rendering-docs'],
|
2021-09-27 22:09:05 +02:00
|
|
|
$process: (docs) => {
|
|
|
|
docs.forEach((doc) => {
|
2017-03-23 22:07:59 -04:00
|
|
|
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-23 15:59:33 -04:00
|
|
|
doc.members[i].params[ii].description += '<strong class="tag">Optional</strong>';
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
});
|
|
|
|
return docs;
|
2020-05-16 14:40:49 +02:00
|
|
|
},
|
|
|
|
};
|
2017-03-23 15:59:33 -04:00
|
|
|
};
|