You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
For the most part @ignored and @internal work expected, but I've identified 2 cases where they don't. The first one is if you use /** @internal */ with @Input or @Output:
/** @internal */
@Input()
public internalInputProp: string = '';
Still gets generated (see below, it even recogniced the jsdoc tag), but /** @ignore */ or removing @Input() lead to the property correctly being omitted.
vogloblinsky
changed the title
[BUG] @ignored and @internal not working in some cases
[BUG] @ignore and @internal not working in some cases
Feb 9, 2022
Overview of the issue
For the most part
@ignored
and@internal
work expected, but I've identified 2 cases where they don't. The first one is if you use/** @internal */
with@Input
or@Output
:Still gets generated (see below, it even recogniced the jsdoc tag), but
/** @ignore */
or removing@Input()
lead to the property correctly being omitted.The other case is when you set
/** @ignore */
or/** @internal */
on constructor properties:This time both of those properties will get generated and again the jsdoc tags are included in the generated JSON.
Reproduce the error
Reproduction:
https://github.com/stefan-schweiger/compodoc-repro/tree/ignore-internal-bug
Just run
npm run docs:json
and look in the generateddocumentation.json
forinternalInputProp
,internalConstructorProp
andignoredConstructorProp
.The text was updated successfully, but these errors were encountered: