TypeStrong
notDocumented validation from v0.27 to v0.28
On older versions, I used to have the following in my typedoc.json:
"validation": true,
This would also report notDocumented warnings.
After updating to 0.28.x, this is no longer the case. Even when I explicitely do the following:
"validation": {
"notDocumented": true
},
Or pass it on the CLI: npx typedoc --validation.notDocumented, it will simply no do anything.
If I switch back to 0.27.x, the warnings are shown as expected again.
Unit tests indicate this is working as intended, needs a minimal reproduction.
https://github.com/TypeStrong/typedoc/blob/c902e555bddb243724d8fd38fd21bb6d272cc1a4/src/test/behavior.c2.test.ts#L890-L908
Yes, though without something minimal I'm unlikely to get to anything this month.
Hey @Gerrit0 - I stripped out pretty much everything, so no need to be secretive.
I've tested:
- 0.27.6
- 0.27.9
- 0.28.15
Anything below 0.28 reports a bunch of warnings, switching to 0.28 or higher stops reporting the warnings.
While not in scope of this issue, I did notice that some things don't seem to generate warnings (anymore?), of which I'm sure they did when I wrote the code at the time (0.27.6 era).
eg. type ActionClass = ClassReference<Action>; I would expect to complain, since I've enabled excludePrivate, and I'm pretty sure I used to get warning for missing @return too, even if something was private. Could all be related in the end.
Add this to your typedoc config:
"packagesRequiringDocumentation": [
"@adventure-game/api",
"@adventure-game/root",
],
Prior to 0.28, TypeDoc required documentation for all packages, which caused problems if your docs included classes which were defined by some external package which you didn't have control over.
TypeDoc's default value for this will cause warnings to show up in code associated with @adventure-game/root, but TypeDoc doesn't realize that the /api project should also be validated without some help.