-
-
Notifications
You must be signed in to change notification settings - Fork 745
Closed
Description
Search terms
remarks inheritdoc warning
Expected Behavior
One of two things:
- The warning is suppressed, or
- TypeDoc does what it says it's going to do
Actual Behavior
Warning printed, but does not reflect reality.
Steps to reproduce the bug
Given the docstring for DictionarySchema
contains a @remarks
section, we have another docstring:
/**
* {@inheritDoc DictionarySchema}
*
* @remarks
* Alias of {@link DictionarySchema}
* @group Schema
*/
export const NullProtoObjectSchema = DictionarySchema;
During the build, TypeDoc prints the warning:
[warning] Content in the @remarks block will be overwritten by the @inheritDoc tag in comment at ./src/schema.ts:275
But in the rendered documentation, both @remarks
are displayed:

Environment
- Typedoc version: v0.28.12
- TypeScript version: v5.9.2
- Node.js version: v24.7.0
- OS: macOS
Metadata
Metadata
Assignees
Labels
No labels