npm - @nikovirtala/projen-constructs - Versions diffs - 0.1.8 → 0.2.1 - Mend

@nikovirtala/projen-constructs 0.1.8 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (74) hide show

package/.jsii +2021 -157
package/API.md +769 -52
package/README.md +37 -8
package/docs/api/.nojekyll +1 -0
package/docs/api/assets/hierarchy.js +1 -0
package/docs/api/assets/highlight.css +99 -0
package/docs/api/assets/icons.js +18 -0
package/docs/api/assets/icons.svg +1 -0
package/docs/api/assets/main.js +60 -0
package/docs/api/assets/navigation.js +1 -0
package/docs/api/assets/search.js +1 -0
package/docs/api/assets/style.css +1633 -0
package/docs/api/classes/AwsCdkConstructLibraryProject.html +308 -0
package/docs/api/classes/AwsCdkTypeScriptAppProject.html +306 -0
package/docs/api/classes/JsiiProject.html +294 -0
package/docs/api/classes/ProjectGenerator.html +38 -0
package/docs/api/classes/TypeDoc.html +37 -0
package/docs/api/classes/TypeScriptProject.html +294 -0
package/docs/api/classes/Vitest.html +38 -0
package/docs/api/enums/CommentStyle.html +11 -0
package/docs/api/enums/CoverageProvider.html +7 -0
package/docs/api/enums/CoverageReporter.html +11 -0
package/docs/api/enums/EntryPointStrategy.html +11 -0
package/docs/api/enums/Environment.html +12 -0
package/docs/api/enums/LogLevel.html +13 -0
package/docs/api/enums/Pool.html +17 -0
package/docs/api/enums/ProjectType.html +47 -0
package/docs/api/enums/Visibility.html +9 -0
package/docs/api/functions/applyDefaults.html +1 -0
package/docs/api/functions/toJson_TypeDocConfiguration.html +2 -0
package/docs/api/hierarchy.html +1 -0
package/docs/api/index.html +86 -0
package/docs/api/interfaces/AwsCdkConstructLibraryProjectOptions.html +1075 -0
package/docs/api/interfaces/AwsCdkTypeScriptAppProjectOptions.html +1026 -0
package/docs/api/interfaces/Component.html +13 -0
package/docs/api/interfaces/ComponentOptions.html +8 -0
package/docs/api/interfaces/JsiiProjectOptions.html +1003 -0
package/docs/api/interfaces/ProjectGeneratorOptions.html +49 -0
package/docs/api/interfaces/TypeDocConfiguration.html +141 -0
package/docs/api/interfaces/TypeDocOptions.html +9 -0
package/docs/api/interfaces/TypeScriptProjectOptions.html +899 -0
package/docs/api/interfaces/ValidationOptions.html +9 -0
package/docs/api/interfaces/VitestConfigOptions.html +111 -0
package/docs/api/interfaces/VitestOptions.html +13 -0
package/docs/api/modules.html +1 -0
package/docs/api/variables/defaultOptions.html +1 -0
package/docs/api/variables/defaults.html +1 -0
package/docs/api/variables/projectDefaultOptions.html +1 -0
package/lib/components/typedoc-config.d.ts +321 -0
package/lib/components/typedoc-config.js +73 -1
package/lib/components/typedoc.d.ts +19 -0
package/lib/components/typedoc.js +14 -1
package/lib/components/vitest.d.ts +197 -0
package/lib/components/vitest.js +72 -2
package/lib/config.d.ts +4 -4
package/lib/errors.d.ts +16 -0
package/lib/errors.js +26 -2
package/lib/index.d.ts +2 -0
package/lib/index.js +3 -1
package/lib/project-generator.d.ts +87 -63
package/lib/project-generator.js +344 -60
package/lib/project-type.d.ts +78 -16
package/lib/project-type.js +79 -17
package/lib/projects/awscdk-construct-library.generated.js +4 -4
package/lib/projects/awscdk-typescript-app.generated.js +4 -4
package/lib/projects/jsii-options.generated.d.ts +11 -1
package/lib/projects/jsii-options.generated.js +1 -1
package/lib/projects/jsii.generated.js +5 -4
package/lib/projects/typescript.generated.js +4 -4
package/lib/utils.d.ts +2 -2
package/lib/utils.js +3 -3
package/package.json +3 -1
package/scripts/generate-project-types.ts +103 -0
package/typedoc.jsonc +10 -0

package/docs/api/variables/projectDefaultOptions.html ADDED Viewed

@@ -0,0 +1 @@

+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>projectDefaultOptions | @nikovirtala/projen-constructs</title><meta name="description" content="Documentation for @nikovirtala/projen-constructs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@nikovirtala/projen-constructs</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">projectDefaultOptions</a></li></ul><h1>Variable projectDefaultOptions<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature">projectDefaultOptions: { autoApproveOptions: { allowedUsernames: string[]; secret: string }; autoMerge: true; biome: true; biomeOptions: { biomeConfig: { formatter: { indentStyle: SPACE; indentWidth: number; lineWidth: number; useEditorconfig: false; }; }; formatter: true; linter: true; }; defaultReleaseBranch: string; dependabot: false; depsUpgradeOptions: { workflowOptions: { labels: string[] } }; eslint: false; github: true; jest: false; mergify: true; minNodeVersion: string; packageManager: PNPM; pnpmVersion: string; prettier: false; projenrcTs: true; tsconfig: { compilerOptions: { allowSyntheticDefaultImports: true; alwaysStrict: true; declaration: true; esModuleInterop: true; experimentalDecorators: true; inlineSourceMap: true; inlineSources: true; isolatedModules: true; noEmit: true; noEmitOnError: false; noFallthroughCasesInSwitch: true; noImplicitAny: true; noImplicitOverride: true; noImplicitReturns: true; noImplicitThis: true; noUnusedLocals: true; noUnusedParameters: true; resolveJsonModule: true; strict: true; strictNullChecks: true; strictPropertyInitialization: true; stripInternal: true; }; }; typescriptVersion: string; } = ...</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5 id="autoapproveoptions">autoApproveOptions: { allowedUsernames: string[]; secret: string }</h5></li><li class="tsd-parameter"><h5 id="automerge">autoMerge: true</h5></li><li class="tsd-parameter"><h5 id="biome">biome: true</h5></li><li class="tsd-parameter"><h5 id="biomeoptions">biomeOptions: { biomeConfig: { formatter: { indentStyle: SPACE; indentWidth: number; lineWidth: number; useEditorconfig: false; }; }; formatter: true; linter: true; }</h5></li><li class="tsd-parameter"><h5 id="defaultreleasebranch">defaultReleaseBranch: string</h5></li><li class="tsd-parameter"><h5 id="dependabot">dependabot: false</h5></li><li class="tsd-parameter"><h5 id="depsupgradeoptions">depsUpgradeOptions: { workflowOptions: { labels: string[] } }</h5></li><li class="tsd-parameter"><h5 id="eslint">eslint: false</h5></li><li class="tsd-parameter"><h5 id="github">github: true</h5></li><li class="tsd-parameter"><h5 id="jest">jest: false</h5></li><li class="tsd-parameter"><h5 id="mergify">mergify: true</h5></li><li class="tsd-parameter"><h5 id="minnodeversion">minNodeVersion: string</h5></li><li class="tsd-parameter"><h5 id="packagemanager">packageManager: PNPM</h5></li><li class="tsd-parameter"><h5 id="pnpmversion">pnpmVersion: string</h5></li><li class="tsd-parameter"><h5 id="prettier">prettier: false</h5></li><li class="tsd-parameter"><h5 id="projenrcts">projenrcTs: true</h5></li><li class="tsd-parameter"><h5 id="tsconfig">tsconfig: { compilerOptions: { allowSyntheticDefaultImports: true; alwaysStrict: true; declaration: true; esModuleInterop: true; experimentalDecorators: true; inlineSourceMap: true; inlineSources: true; isolatedModules: true; noEmit: true; noEmitOnError: false; noFallthroughCasesInSwitch: true; noImplicitAny: true; noImplicitOverride: true; noImplicitReturns: true; noImplicitThis: true; noUnusedLocals: true; noUnusedParameters: true; resolveJsonModule: true; strict: true; strictNullChecks: true; strictPropertyInitialization: true; stripInternal: true; }; }</h5></li><li class="tsd-parameter"><h5 id="typescriptversion">typescriptVersion: string</h5></li></ul></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility">Member Visibility<ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Protected</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Inherited</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>External</label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@nikovirtala/projen-constructs</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></footer><div class="overlay"></div></body></html>

package/lib/components/typedoc-config.d.ts CHANGED Viewed

@@ -1,78 +1,399 @@
+/**
+ * TypeDoc configuration
+ *
+ * @see https://typedoc.org/options/
+ */
 export interface TypeDocConfiguration {
+    /**
+     * Specifies the entry points to be documented by TypeDoc.
+     *
+     * @see https://typedoc.org/documents/Options.Input.html#entrypoints
+     */
     readonly entryPoints?: string[];
+    /**
+     * Specifies the strategy to be used to convert entry points into documentation.
+     *
+     * @see https://typedoc.org/documents/Options.Input.html#entrypointstrategy
+     */
     readonly entryPointStrategy?: EntryPointStrategy;
+    /**
+     * Define patterns to be excluded when expanding directories.
+     *
+     * @see https://typedoc.org/documents/Options.Input.html#exclude
+     */
     readonly exclude?: string[];
+    /**
+     * Prevent externally resolved symbols from being documented.
+     *
+     * @see https://typedoc.org/documents/Options.Input.html#excludeexternals
+     */
     readonly excludeExternals?: boolean;
+    /**
+     * Prevent private members from being included in the generated documentation.
+     *
+     * @see https://typedoc.org/documents/Options.Input.html#excludeprivate
+     */
     readonly excludePrivate?: boolean;
+    /**
+     * Prevent protected members from being included in the generated documentation.
+     *
+     * @see https://typedoc.org/documents/Options.Input.html#excludeprotected
+     */
     readonly excludeProtected?: boolean;
+    /**
+     * Prevent symbols that are not exported from being documented.
+     *
+     * @see https://typedoc.org/documents/Options.Input.html#excludeinternal
+     */
     readonly excludeInternal?: boolean;
+    /**
+     * Specifies the output directory the documentation should be written to.
+     *
+     * @see https://typedoc.org/documents/Options.Output.html#out
+     */
     readonly out?: string;
+    /**
+     * Specify the location the documentation should be written to.
+     *
+     * @see https://typedoc.org/documents/Options.Output.html#json
+     */
     readonly json?: string;
+    /**
+     * Specify a theme name to use.
+     *
+     * @see https://typedoc.org/documents/Options.Output.html#theme
+     */
     readonly theme?: string;
+    /**
+     * Specify the base path for all urls.
+     *
+     * @see https://typedoc.org/documents/Options.Output.html#basepath
+     */
     readonly basePath?: string;
+    /**
+     * Set the name of the project that will be used in the header of the template.
+     *
+     * @see https://typedoc.org/documents/Options.Output.html#name
+     */
     readonly name?: string;
+    /**
+     * Prevent TypeDoc from cleaning the output directory specified with --out.
+     *
+     * @see https://typedoc.org/documents/Options.Output.html#cleanoutputdir
+     */
     readonly cleanOutputDir?: boolean;
+    /**
+     * Specify the location to look for included documents.
+     *
+     * @see https://typedoc.org/documents/Options.Output.html#includes
+     */
     readonly includes?: string;
+    /**
+     * Specify the location with media files that should be copied to the output directory.
+     *
+     * @see https://typedoc.org/documents/Options.Output.html#media
+     */
     readonly media?: string;
+    /**
+     * Specify the location and filename a .tsbuildinfo file should be written to.
+     *
+     * @see https://typedoc.org/documents/Options.Input.html#tsbuildinfo
+     */
     readonly tsBuildInfo?: string;
+    /**
+     * Specify a TypeScript config file that should be used to load TypeScript configuration.
+     *
+     * @see https://typedoc.org/documents/Options.Input.html#tsconfig
+     */
     readonly tsconfig?: string;
+    /**
+     * Specify the logger that should be used.
+     *
+     * @see https://typedoc.org/documents/Options.Other.html#loglevel
+     */
     readonly logLevel?: LogLevel;
+    /**
+     * Specify the sort strategy for documented values.
+     *
+     * @see https://typedoc.org/documents/Options.Organization.html#sort
+     */
     readonly sort?: string[];
+    /**
+     * Specify the sort strategy for static and instance members.
+     *
+     * @see https://typedoc.org/documents/Options.Organization.html#sortentrypoints
+     */
     readonly sortEntryPoints?: boolean;
+    /**
+     * Specify the documentation mode TypeDoc should use.
+     *
+     * @see https://typedoc.org/documents/Options.Comments.html#commentstyle
+     */
     readonly commentStyle?: CommentStyle;
+    /**
+     * Specify the default visibility for members without a visibility tag.
+     *
+     * @see https://typedoc.org/documents/Options.Comments.html#defaultvisibility
+     */
     readonly defaultVisibility?: Visibility;
+    /**
+     * Specify the default category for reflections without a category.
+     *
+     * @see https://typedoc.org/documents/Options.Organization.html#defaultcategory
+     */
     readonly defaultCategory?: string;
+    /**
+     * Specify the default group for reflections without a group.
+     *
+     * @see https://typedoc.org/documents/Options.Organization.html#defaultgroup
+     */
     readonly defaultGroup?: string;
+    /**
+     * Specify the categories that will be used to group reflections.
+     *
+     * @see https://typedoc.org/documents/Options.Organization.html#categorizebygroup
+     */
     readonly categorizeByGroup?: boolean;
+    /**
+     * Specify the search group boosts.
+     *
+     * @see https://typedoc.org/documents/Options.Organization.html#searchgroupboosts
+     */
     readonly searchGroupBoosts?: Record<string, number>;
+    /**
+     * Specify the search category boosts.
+     *
+     * @see https://typedoc.org/documents/Options.Organization.html#searchcategoryboosts
+     */
     readonly searchCategoryBoosts?: Record<string, number>;
+    /**
+     * Specify the readme file that should be displayed on the index page.
+     *
+     * @see https://typedoc.org/documents/Options.Input.html#readme
+     */
     readonly readme?: string;
+    /**
+     * Specify the package.json file that should be used to determine the package name.
+     *
+     * @see https://typedoc.org/documents/Options.Input.html#packagejson
+     */
     readonly packageJson?: string;
+    /**
+     * Specify the git revision that should be used to link to source files.
+     *
+     * @see https://typedoc.org/documents/Options.Comments.html#gitrevision
+     */
     readonly gitRevision?: string;
+    /**
+     * Specify the git remote that should be used to link to source files.
+     *
+     * @see https://typedoc.org/documents/Options.Comments.html#gitremote
+     */
     readonly gitRemote?: string;
+    /**
+     * Specify a link template to be used when generating source urls.
+     *
+     * @see https://typedoc.org/documents/Options.Input.html#sourcelinktemplate
+     */
     readonly sourceLinkTemplate?: string;
+    /**
+     * Disables automatically linking to source code.
+     *
+     * @see https://typedoc.org/documents/Options.Comments.html#disablesources
+     */
     readonly disableSources?: boolean;
+    /**
+     * Disables setting the source of reflections when documenting projects within a Git repository.
+     *
+     * @see https://typedoc.org/documents/Options.Comments.html#disablegit
+     */
     readonly disableGit?: boolean;
+    /**
+     * Do not print the TypeDoc link at the end of the page.
+     *
+     * @see https://typedoc.org/documents/Options.Output.html#hidegenerator
+     */
     readonly hideGenerator?: boolean;
+    /**
+     * Hide parameter types in the signature.
+     *
+     * @see https://typedoc.org/documents/Options.Output.html#hideparametertypesintitle
+     */
     readonly hideParameterTypesInTitle?: boolean;
+    /**
+     * Include the generation time in links to prevent browsers from using a cached version.
+     *
+     * @see https://typedoc.org/documents/Options.Output.html#cachebust
+     */
     readonly cacheBust?: boolean;
+    /**
+     * If set, the search index will also include comments.
+     *
+     * @see https://typedoc.org/documents/Options.Output.html#searchincomments
+     */
     readonly searchInComments?: boolean;
+    /**
+     * If set, the search index will also include documents.
+     *
+     * @see https://typedoc.org/documents/Options.Output.html#searchindocuments
+     */
     readonly searchInDocuments?: boolean;
+    /**
+     * Specify validation options.
+     *
+     * @see https://typedoc.org/documents/Options.Validation.html
+     */
     readonly validation?: ValidationOptions;
+    /**
+     * Specify the type of reflections that must be documented.
+     *
+     * @see https://typedoc.org/documents/Options.Validation.html#requiredtobedocumented
+     */
     readonly requiredToBeDocumented?: string[];
+    /**
+     * If set, warnings will be treated as errors.
+     *
+     * @see https://typedoc.org/documents/Options.Validation.html#treatwarningsaserrors
+     */
     readonly treatWarningsAsErrors?: boolean;
+    /**
+     * If set, validation warnings will be treated as errors.
+     *
+     * @see https://typedoc.org/documents/Options.Validation.html#treatvalidationwarningsaserrors
+     */
     readonly treatValidationWarningsAsErrors?: boolean;
+    /**
+     * A list of types that should not produce warnings when not being exported.
+     *
+     * @see https://typedoc.org/documents/Options.Validation.html#intentionallynotexported
+     */
     readonly intentionallyNotExported?: string[];
+    /**
+     * Define patterns for files that should be considered external.
+     *
+     * @see https://typedoc.org/documents/Options.Input.html#externalpattern
+     */
     readonly externalPattern?: string[];
+    /**
+     * Define custom mappings for symbols in external packages.
+     *
+     * @see https://typedoc.org/documents/Options.Comments.html#externalsymbollinkmappings
+     */
     readonly externalSymbolLinkMappings?: Record<string, Record<string, string>>;
 }
+/**
+ * Converts TypeDocConfiguration to JSON representation
+ * @internal
+ */
 export declare function toJson_TypeDocConfiguration(obj: TypeDocConfiguration | undefined): Record<string, unknown> | undefined;
+/**
+ * Specifies the strategy to be used to convert entry points into documentation
+ *
+ * @see https://typedoc.org/documents/Options.Input.html#entrypointstrategy
+ */
 export declare enum EntryPointStrategy {
+    /**
+     * Expects all entry points to be contained within a single package
+     */
     RESOLVE = "resolve",
+    /**
+     * Expects all entry points to be top-level directories
+     */
     EXPAND = "expand",
+    /**
+     * Expects all entry points to be individual files
+     */
     PACKAGES = "packages",
+    /**
+     * Merges multiple projects into a single documentation site
+     */
     MERGE = "merge"
 }
+/**
+ * Specifies the logger that should be used
+ *
+ * @see https://typedoc.org/documents/Options.Other.html#loglevel
+ */
 export declare enum LogLevel {
+    /**
+     * Log all messages including verbose debug information
+     */
     VERBOSE = "Verbose",
+    /**
+     * Log informational messages and above
+     */
     INFO = "Info",
+    /**
+     * Log warnings and errors only
+     */
     WARN = "Warn",
+    /**
+     * Log errors only
+     */
     ERROR = "Error",
+    /**
+     * Disable all logging
+     */
     NONE = "None"
 }
+/**
+ * Specifies the documentation mode TypeDoc should use
+ *
+ * @see https://typedoc.org/documents/Options.Comments.html#commentstyle
+ */
 export declare enum CommentStyle {
+    /**
+     * Parse JSDoc style comments only
+     */
     JSDOC = "jsdoc",
+    /**
+     * Parse block comments
+     */
     BLOCK = "block",
+    /**
+     * Parse line comments (//)
+     */
     LINE = "line",
+    /**
+     * Parse all comment styles
+     */
     ALL = "all"
 }
+/**
+ * Specifies the default visibility for members without a visibility tag
+ *
+ * @see https://typedoc.org/documents/Options.Comments.html#defaultvisibility
+ */
 export declare enum Visibility {
+    /**
+     * Public visibility - accessible from anywhere
+     */
     PUBLIC = "public",
+    /**
+     * Protected visibility - accessible from class and subclasses
+     */
     PROTECTED = "protected",
+    /**
+     * Private visibility - accessible only within the class
+     */
     PRIVATE = "private"
 }
+/**
+ * Validation options
+ *
+ * @see https://typedoc.org/documents/Options.Validation.html
+ */
 export interface ValidationOptions {
+    /**
+     * If set, TypeDoc will produce warnings when a symbol is referenced by the documentation
+     */
     readonly notExported?: boolean;
+    /**
+     * If set, TypeDoc will produce warnings when an exported symbol is not documented
+     */
     readonly notDocumented?: boolean;
+    /**
+     * If set, TypeDoc will produce warnings about \@link tags which will produce broken links
+     */
     readonly invalidLink?: boolean;
 }