chore(docs): add support for language specific notes (#5810)

microsoft · Mar 17, 2021 · 693e569 · 693e569
1 parent 1fab845
commit 693e569
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/utils/doclint/documentation.js b/utils/doclint/documentation.js
@@ -207,6 +207,7 @@ Documentation.Class = class {
       member.filterForLanguage(lang);
       membersArray.push(member);
     }
+    this.spec = filterSpecs(this.spec, lang);
     this.membersArray = membersArray;
   }
 
@@ -340,6 +341,7 @@ Documentation.Member = class {
       argsArray.push(overriddenArg);
     }
     this.argsArray = argsArray;
+    this.spec = filterSpecs(this.spec, lang);
   }
 
   clone() {
@@ -687,4 +689,16 @@ function generateSourceCodeComment(spec) {
   return md.render(comments, 120);
 }
 
+/**
+ * 
+ * @param {MarkdownNode[]} spec 
+ * @param {string} lang 
+ * @returns {MarkdownNode[]}
+ */
+function filterSpecs(spec, lang) {
+  if(!spec)
+    return;
+  return spec.filter(n => n.type !== 'note' || (n.type === 'note' && (!n.codeLang || n.codeLang === lang)));
+}
+
 module.exports = Documentation;
diff --git a/utils/markdown.js b/utils/markdown.js
@@ -141,10 +141,12 @@ function buildTree(lines) {
     }
 
     if (content.startsWith(':::')) {
+      let noteType = content.substring(3).split(' ');
       /** @type {MarkdownNode} */
       const node = {
         type: 'note',
-        noteType: content.substring(3)
+        noteType: noteType[0],
+        codeLang: noteType[1]
       };
       line = lines[++i];
       const tokens = [];