Skip to content

Commit 7322a66

Browse files
author
Cary Hu
committed
fix excludeNotDocumented behavior
1 parent dd15e08 commit 7322a66

File tree

3 files changed

+78
-1
lines changed

3 files changed

+78
-1
lines changed

src/lib/converter/plugins/CommentPlugin.ts

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,26 @@ export class CommentPlugin extends ConverterComponent {
203203
this.removeExcludedTags(comment);
204204
}
205205

206+
private getHiddenItems(reflection: Reflection) {
207+
const hiddenItems = new Set<Reflection>();
208+
if (reflection.kindOf(ReflectionKind.FunctionOrMethod)) {
209+
const decl = reflection as DeclarationReflection;
210+
if (decl.signatures) {
211+
for (const sig of decl.signatures) {
212+
if (!sig.comment) {
213+
hiddenItems.add(sig);
214+
}
215+
}
216+
}
217+
if (!decl.signatures?.some(sig => sig.comment)) {
218+
hiddenItems.add(decl);
219+
}
220+
} else {
221+
hiddenItems.add(reflection);
222+
}
223+
return hiddenItems || [];
224+
}
225+
206226
/**
207227
* Triggered when the converter begins resolving a project.
208228
*
@@ -225,7 +245,7 @@ export class CommentPlugin extends ConverterComponent {
225245
}
226246

227247
if (this.isHidden(ref)) {
228-
hidden.add(ref);
248+
this.getHiddenItems(ref).forEach(item => hidden.add(item));
229249
}
230250
}
231251
hidden.forEach((reflection) => project.removeReflection(reflection));
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
/**
2+
*
3+
* test 2
4+
*/
5+
declare class Collection {
6+
7+
/**
8+
*
9+
* @param {boolean} n Test boolean
10+
*/
11+
public case1(n: boolean)
12+
public case1(n: number)
13+
private case2()
14+
}
15+
16+
17+
/**
18+
* Comment for case4
19+
*/
20+
export declare type Case4 = {
21+
case5: string;
22+
23+
/**
24+
* comment for case6
25+
*
26+
* @param number1 test comment
27+
*/
28+
case6: (number1: number) => boolean;
29+
}
30+
31+
/**
32+
* Comment for case7
33+
*/
34+
export declare type case7 = (number1: number) => boolean;
35+
36+
/**
37+
* Rounds or truncates a number to a specified precision.
38+
*
39+
* @param value Value to round or truncate.
40+
* @param prec Number of decimal digits for the result.
41+
* @param truncate Whether to truncate or round the original value.
42+
*/
43+
declare function case3(value: number, prec: number, truncate: boolean): number;
44+
45+
export {
46+
Collection,
47+
case3
48+
}

src/test/issueTests.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -608,4 +608,13 @@ export const issueTests: {
608608
logger.discardDebugMessages();
609609
logger.expectNoOtherMessages();
610610
},
611+
612+
gh1994(project, logger) {
613+
const case1 = query(project, "Collection.case1");
614+
// TODO: I don't know how to add test case for this case
615+
// and I added a test simple file in 'issues' folder.
616+
// But I don't know how to test it.
617+
logger.discardDebugMessages();
618+
logger.expectNoOtherMessages();
619+
}
611620
};

0 commit comments

Comments
 (0)