chore(docs): add support for language specific notes (#5810)
This commit is contained in:
parent
1fab84577a
commit
693e5699ac
|
|
@ -207,6 +207,7 @@ Documentation.Class = class {
|
||||||
member.filterForLanguage(lang);
|
member.filterForLanguage(lang);
|
||||||
membersArray.push(member);
|
membersArray.push(member);
|
||||||
}
|
}
|
||||||
|
this.spec = filterSpecs(this.spec, lang);
|
||||||
this.membersArray = membersArray;
|
this.membersArray = membersArray;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -340,6 +341,7 @@ Documentation.Member = class {
|
||||||
argsArray.push(overriddenArg);
|
argsArray.push(overriddenArg);
|
||||||
}
|
}
|
||||||
this.argsArray = argsArray;
|
this.argsArray = argsArray;
|
||||||
|
this.spec = filterSpecs(this.spec, lang);
|
||||||
}
|
}
|
||||||
|
|
||||||
clone() {
|
clone() {
|
||||||
|
|
@ -687,4 +689,16 @@ function generateSourceCodeComment(spec) {
|
||||||
return md.render(comments, 120);
|
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;
|
module.exports = Documentation;
|
||||||
|
|
|
||||||
|
|
@ -141,10 +141,12 @@ function buildTree(lines) {
|
||||||
}
|
}
|
||||||
|
|
||||||
if (content.startsWith(':::')) {
|
if (content.startsWith(':::')) {
|
||||||
|
let noteType = content.substring(3).split(' ');
|
||||||
/** @type {MarkdownNode} */
|
/** @type {MarkdownNode} */
|
||||||
const node = {
|
const node = {
|
||||||
type: 'note',
|
type: 'note',
|
||||||
noteType: content.substring(3)
|
noteType: noteType[0],
|
||||||
|
codeLang: noteType[1]
|
||||||
};
|
};
|
||||||
line = lines[++i];
|
line = lines[++i];
|
||||||
const tokens = [];
|
const tokens = [];
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue