chore(docs): parse optional

2026-04-13 00:00:10 +08:00 · 2017-03-23 15:59:33 -04:00
parent 072fe8df94
commit 87916aec20
3 changed files with 28 additions and 7 deletions
@@ -0,0 +1,21 @@
+module.exports = function parseOptional() {
+  return {
+    $runBefore: ['rendering-docs'],
+    $process: function(docs) {
+      docs.forEach(function(doc) {
+        if(doc.members && doc.members.length) {
+          for (var i in doc.members) {
+            if(doc.members[i].params && doc.members[i].params.length) {
+              for (var ii in doc.members[i].params) {
+                if(doc.members[i].params[ii].optional){
+                  doc.members[i].params[ii].description += '<strong class="tag">Optional</strong>';
+                }
+              }
+            }
+          }
+        }
+      });
+      return docs;
+    }
+  }
+};