parse-optional.js 638 B

12345678910111213141516171819202122
  1. module.exports = function parseOptional() {
  2. return {
  3. $runBefore: ['rendering-docs'],
  4. $process: function(docs) {
  5. docs.forEach(function(doc) {
  6. if(doc.members && doc.members.length) {
  7. for (var i in doc.members) {
  8. if(doc.members[i].params && doc.members[i].params.length) {
  9. for (var ii in doc.members[i].params) {
  10. if(doc.members[i].params[ii].optional){
  11. doc.members[i].params[ii].description += '<strong class="tag">Optional</strong>';
  12. }
  13. }
  14. }
  15. }
  16. }
  17. });
  18. return docs;
  19. }
  20. }
  21. };