Fix #2860

TypeStrong · Feb 20, 2025 · 927f06d · 927f06d
1 parent 0bad04c
commit 927f06d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/src/lib/internationalization/locales/en.cts b/src/lib/internationalization/locales/en.cts
@@ -328,6 +328,8 @@ export = {
         "If set and no @summary tag is specified, TypeDoc will use the first paragraph of comments as the short summary in the module/namespace view",
     help_jsDocCompatibility:
         "Sets compatibility options for comment parsing that increase similarity with JSDoc comments",
+    help_suppressCommentWarningsInDeclarationFiles:
+        "Prevents warnings due to unspecified tags from being reported in comments within .d.ts files.",
     help_commentStyle: "Determines how TypeDoc searches for comments",
     help_useTsLinkResolution:
         "Use TypeScript's link resolution when determining where @link tags point. This only applies to JSDoc style comments",

diff --git a/src/lib/utils/options/sources/typedoc.ts b/src/lib/utils/options/sources/typedoc.ts
@@ -743,7 +743,7 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
 
     options.addDeclaration({
         name: "suppressCommentWarningsInDeclarationFiles",
-        help: (i18n) => i18n.help_lang(),
+        help: (i18n) => i18n.help_suppressCommentWarningsInDeclarationFiles(),
         type: ParameterType.Boolean,
         defaultValue: true,
     });