File tree 4 files changed +31
-4
lines changed
4 files changed +31
-4
lines changed Original file line number Diff line number Diff line change 7
7
- If a relative linked image is referenced multiple times, TypeDoc will no longer sometimes produce invalid links to the image #2627 .
8
8
- ` @link ` tags will now be validated in referenced markdown documents, #2629 .
9
9
- ` @link ` tags are now resolved in project documents, #2629 .
10
+ - ` @hidden ` is now properly applied when placed in a function implementation comment.
10
11
- Comments on re-exports are now rendered.
11
12
12
13
### Thanks!
Original file line number Diff line number Diff line change @@ -634,14 +634,12 @@ export class CommentPlugin extends ConverterComponent {
634
634
( comment . hasModifier ( "@internal" ) && this . excludeInternal ) ;
635
635
636
636
if (
637
- isHidden &&
637
+ ! isHidden &&
638
638
reflection . kindOf ( ReflectionKind . ContainsCallSignatures )
639
639
) {
640
640
return ( reflection as DeclarationReflection )
641
641
. getNonIndexSignatures ( )
642
- . every ( ( sig ) => {
643
- return ! sig . comment || this . isHidden ( sig ) ;
644
- } ) ;
642
+ . every ( ( sig ) => this . isHidden ( sig ) ) ;
645
643
}
646
644
647
645
return isHidden ;
Original file line number Diff line number Diff line change
1
+ /**
2
+ * @param a - Number param.
3
+ */
4
+ export function hidden ( a : number ) : void ;
5
+
6
+ /**
7
+ * @param a - String param.
8
+ */
9
+ export function hidden ( a : string ) : void ;
10
+
11
+ /** @hidden */
12
+ export function hidden ( a : string | number ) : void {
13
+ console . log ( a ) ;
14
+ }
15
+
16
+ /** @hidden */
17
+ export function implicitlyHidden ( x : string ) : void ;
18
+ /** @hidden */
19
+ export function implicitlyHidden ( x : number ) : void ;
20
+ export function implicitlyHidden ( ) { }
21
+
22
+ /** @hidden */
23
+ export const hiddenVariableFunc = ( ) => 1 ;
Original file line number Diff line number Diff line change @@ -1636,4 +1636,9 @@ describe("Issue Tests", () => {
1636
1636
1637
1637
logger . expectNoOtherMessages ( ) ;
1638
1638
} ) ;
1639
+
1640
+ it ( "#2634 handles @hidden on function implementations" , ( ) => {
1641
+ const project = convert ( ) ;
1642
+ equal ( project . children ?. map ( ( c ) => c . name ) || [ ] , [ ] ) ;
1643
+ } ) ;
1639
1644
} ) ;
You can’t perform that action at this time.
0 commit comments