| 1 | /**
|
| 2 | * Part of the {@link TSDocConfiguration} object.
|
| 3 | */
|
| 4 | export declare class TSDocValidationConfiguration {
|
| 5 | /**
|
| 6 | * Set `ignoreUndefinedTags` to true to silently ignore unrecognized tags,
|
| 7 | * instead of reporting a warning.
|
| 8 | *
|
| 9 | * @remarks
|
| 10 | * Normally the parser will issue errors when it encounters tag names that do not
|
| 11 | * have a corresponding definition in {@link TSDocConfiguration.tagDefinitions}.
|
| 12 | * This helps to catch common mistakes such as a misspelled tag.
|
| 13 | *
|
| 14 | * @defaultValue `false`
|
| 15 | */
|
| 16 | ignoreUndefinedTags: boolean;
|
| 17 | /**
|
| 18 | * Set `reportUnsupportedTags` to true to issue a warning for tags that are not
|
| 19 | * supported by your tool.
|
| 20 | *
|
| 21 | * @remarks
|
| 22 | * The TSDoc standard defines may tags. By default it assumes that if your tool does
|
| 23 | * not implement one of these tags, then it will simply ignore it. But sometimes this
|
| 24 | * may be misleading for developers. (For example, they might write an `@example` block
|
| 25 | * and then be surprised if it doesn't appear in the documentation output.).
|
| 26 | *
|
| 27 | * For a better experience, you can tell the parser which tags you support, and then it
|
| 28 | * will issue warnings wherever unsupported tags are used. This is done using
|
| 29 | * {@link TSDocConfiguration.setSupportForTag}. Note that calling that function
|
| 30 | * automatically sets `reportUnsupportedTags` to true.
|
| 31 | *
|
| 32 | * @defaultValue `false`
|
| 33 | */
|
| 34 | reportUnsupportedTags: boolean;
|
| 35 | /**
|
| 36 | * Set `reportUnsupportedHtmlElements` to true to issue a warning for HTML elements which
|
| 37 | * are not defined in your TSDoc configuration's `supportedHtmlElements` field.
|
| 38 | *
|
| 39 | * @defaultValue `false`
|
| 40 | */
|
| 41 | reportUnsupportedHtmlElements: boolean;
|
| 42 | }
|
| 43 | //# sourceMappingURL=TSDocValidationConfiguration.d.ts.map |
| \ | No newline at end of file |