Skip to content

Commit 0a2d069

Browse files
committed
Address comments
1 parent da03b48 commit 0a2d069

File tree

2 files changed

+15
-8
lines changed

2 files changed

+15
-8
lines changed

tools/dgeni/processors/docs-private-filter.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,24 +29,24 @@ const INTERNAL_METHODS = [
2929
module.exports = function docsPrivateFilter() {
3030
return {
3131
$runBefore: ['categorizer'],
32-
$process: docs => docs.filter(doc => validateDocEntry(doc))
32+
$process: docs => docs.filter(doc => isPublicDoc(doc))
3333
};
3434
};
3535

36-
function validateDocEntry(doc) {
36+
function isPublicDoc(doc) {
3737
if (hasDocsPrivateTag(doc)) {
3838
return false;
3939
} else if (doc.docType === 'member') {
40-
return validateMemberDoc(doc);
40+
return !isInternalMember(doc);
4141
} else if (doc.docType === 'class') {
42-
doc.members = doc.members.filter(memberDoc => validateMemberDoc(memberDoc));
42+
doc.members = doc.members.filter(memberDoc => isPublicDoc(memberDoc));
4343
}
4444

4545
return true;
4646
}
4747

48-
function validateMemberDoc(memberDoc) {
49-
return !INTERNAL_METHODS.includes(memberDoc.name)
48+
function isInternalMember(memberDoc) {
49+
return INTERNAL_METHODS.includes(memberDoc.name)
5050
}
5151

5252
function hasDocsPrivateTag(doc) {

tools/dgeni/processors/link-inherited-docs.js

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/**
2+
* Processor that iterates through all class docs and determines if a class inherits
3+
* another class. Inherited class-docs will be linked to the original class-doc.
4+
*/
5+
16
const ts = require('typescript');
27

38
module.exports = function linkInheritedDocs(readTypeScriptModules, tsParser) {
@@ -19,10 +24,12 @@ module.exports = function linkInheritedDocs(readTypeScriptModules, tsParser) {
1924
checker = tsParser.parse(sourceFiles, basePath).typeChecker;
2025

2126
// Iterate through all class docs and resolve the inherited docs.
22-
docs.filter(doc => doc.docType === 'class').forEach(classDoc => visitClassDoc(classDoc, docs));
27+
docs.filter(doc => doc.docType === 'class').forEach(classDoc => {
28+
resolveInheritedDoc(classDoc, docs);
29+
});
2330
}
2431

25-
function visitClassDoc(classDoc, docs) {
32+
function resolveInheritedDoc(classDoc, docs) {
2633
let inheritedType = resolveInheritedType(classDoc.exportSymbol);
2734
let inheritedSymbol = inheritedType && inheritedType.symbol;
2835

0 commit comments

Comments
 (0)