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