typedoc 0.27.9 → 0.28.0-beta.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.
- package/README.md +26 -26
- package/bin/package.json +1 -1
- package/dist/browser-locales/en.d.ts +2 -0
- package/dist/browser-locales/en.js +62 -0
- package/dist/browser-locales/ja.d.ts +2 -0
- package/dist/browser-locales/ja.js +62 -0
- package/dist/browser-locales/ko.d.ts +2 -0
- package/dist/browser-locales/ko.js +62 -0
- package/dist/browser-locales/zh.d.ts +2 -0
- package/dist/browser-locales/zh.js +62 -0
- package/dist/browser-utils.d.ts +3 -0
- package/dist/browser-utils.js +3 -0
- package/dist/index.d.ts +15 -9
- package/dist/index.js +13 -7
- package/dist/lib/application.d.ts +9 -10
- package/dist/lib/application.js +75 -56
- package/dist/lib/cli.js +4 -3
- package/dist/lib/converter/comments/blockLexer.js +2 -2
- package/dist/lib/converter/comments/declarationReferenceResolver.d.ts +1 -1
- package/dist/lib/converter/comments/declarationReferenceResolver.js +8 -10
- package/dist/lib/converter/comments/discovery.d.ts +1 -1
- package/dist/lib/converter/comments/discovery.js +3 -4
- package/dist/lib/converter/comments/index.d.ts +1 -1
- package/dist/lib/converter/comments/index.js +5 -7
- package/dist/lib/converter/comments/linkResolver.d.ts +1 -1
- package/dist/lib/converter/comments/linkResolver.js +10 -16
- package/dist/lib/converter/comments/parser.d.ts +2 -2
- package/dist/lib/converter/comments/parser.js +8 -8
- package/dist/lib/converter/comments/textParser.d.ts +3 -2
- package/dist/lib/converter/comments/textParser.js +1 -2
- package/dist/lib/converter/context.d.ts +13 -14
- package/dist/lib/converter/context.js +49 -13
- package/dist/lib/converter/converter.d.ts +10 -5
- package/dist/lib/converter/converter.js +59 -42
- package/dist/lib/converter/factories/index-signature.js +3 -2
- package/dist/lib/converter/factories/signature.js +5 -6
- package/dist/lib/converter/factories/symbol-id.d.ts +4 -0
- package/dist/lib/converter/factories/symbol-id.js +92 -0
- package/dist/lib/converter/factories/types.d.ts +4 -0
- package/dist/lib/converter/factories/types.js +13 -0
- package/dist/lib/converter/index.d.ts +3 -4
- package/dist/lib/converter/index.js +2 -2
- package/dist/lib/converter/jsdoc.js +5 -4
- package/dist/lib/converter/plugins/CategoryPlugin.js +4 -2
- package/dist/lib/converter/plugins/CommentPlugin.d.ts +0 -1
- package/dist/lib/converter/plugins/CommentPlugin.js +8 -6
- package/dist/lib/converter/plugins/GroupPlugin.d.ts +2 -3
- package/dist/lib/converter/plugins/GroupPlugin.js +8 -7
- package/dist/lib/converter/plugins/ImplementsPlugin.js +6 -8
- package/dist/lib/converter/plugins/IncludePlugin.d.ts +1 -1
- package/dist/lib/converter/plugins/IncludePlugin.js +19 -16
- package/dist/lib/converter/plugins/InheritDocPlugin.js +7 -9
- package/dist/lib/converter/plugins/MergeModuleWithPlugin.js +3 -2
- package/dist/lib/converter/plugins/PackagePlugin.d.ts +3 -2
- package/dist/lib/converter/plugins/PackagePlugin.js +23 -19
- package/dist/lib/converter/plugins/SourcePlugin.d.ts +2 -1
- package/dist/lib/converter/plugins/SourcePlugin.js +10 -9
- package/dist/lib/converter/plugins/TypePlugin.d.ts +1 -1
- package/dist/lib/converter/plugins/TypePlugin.js +1 -1
- package/dist/lib/converter/plugins/index.d.ts +1 -1
- package/dist/lib/converter/plugins/index.js +1 -1
- package/dist/lib/converter/symbols.js +103 -32
- package/dist/lib/converter/types.js +14 -13
- package/dist/lib/converter/utils/repository.d.ts +1 -1
- package/dist/lib/converter/utils/repository.js +2 -2
- package/dist/lib/debug/index.d.ts +2 -2
- package/dist/lib/debug/index.js +2 -2
- package/dist/lib/debug/{debugReflectionLifetimes.d.ts → reflectionLifetimes.d.ts} +2 -1
- package/dist/lib/debug/{debugReflectionLifetimes.js → reflectionLifetimes.js} +12 -4
- package/dist/lib/debug/{debugRendererUrls.d.ts → rendererUrls.d.ts} +1 -0
- package/dist/lib/debug/rendererUrls.js +68 -0
- package/dist/lib/internationalization/index.d.ts +2 -1
- package/dist/lib/internationalization/index.js +2 -1
- package/dist/lib/internationalization/internationalization.d.ts +16 -46
- package/dist/lib/internationalization/internationalization.js +44 -213
- package/dist/lib/internationalization/locales/en.cjs +9 -1
- package/dist/lib/internationalization/locales/en.d.cts +9 -1
- package/dist/lib/internationalization/locales/ja.cjs +1 -0
- package/dist/lib/internationalization/locales/zh.cjs +61 -5
- package/dist/lib/internationalization/locales/zh.d.cts +26 -2
- package/dist/lib/internationalization/translatable.d.ts +2 -1
- package/dist/lib/models/{comments/comment.d.ts → Comment.d.ts} +9 -8
- package/dist/lib/models/{comments/comment.js → Comment.js} +15 -18
- package/dist/lib/models/{reflections/container.d.ts → ContainerReflection.d.ts} +6 -6
- package/dist/lib/models/{reflections/container.js → ContainerReflection.js} +4 -5
- package/dist/lib/models/{reflections/declaration.d.ts → DeclarationReflection.d.ts} +11 -19
- package/dist/lib/models/{reflections/declaration.js → DeclarationReflection.js} +11 -29
- package/dist/lib/models/{reflections/document.d.ts → DocumentReflection.d.ts} +3 -3
- package/dist/lib/models/{reflections/document.js → DocumentReflection.js} +3 -3
- package/dist/lib/models/FileRegistry.d.ts +12 -20
- package/dist/lib/models/FileRegistry.js +8 -44
- package/dist/lib/models/{reflections/parameter.d.ts → ParameterReflection.d.ts} +4 -4
- package/dist/lib/models/{reflections/parameter.js → ParameterReflection.js} +2 -2
- package/dist/lib/models/{reflections/project.d.ts → ProjectReflection.d.ts} +12 -21
- package/dist/lib/models/{reflections/project.js → ProjectReflection.js} +16 -48
- package/dist/lib/models/{reflections/reference.d.ts → ReferenceReflection.d.ts} +3 -3
- package/dist/lib/models/{reflections/reference.js → ReferenceReflection.js} +3 -4
- package/dist/lib/models/{reflections/abstract.d.ts → Reflection.d.ts} +15 -28
- package/dist/lib/models/{reflections/abstract.js → Reflection.js} +38 -21
- package/dist/lib/models/ReflectionCategory.d.ts +2 -6
- package/dist/lib/models/ReflectionCategory.js +3 -9
- package/dist/lib/models/ReflectionGroup.d.ts +1 -5
- package/dist/lib/models/ReflectionGroup.js +2 -8
- package/dist/lib/models/{reflections/ReflectionSymbolId.d.ts → ReflectionSymbolId.d.ts} +23 -10
- package/dist/lib/models/ReflectionSymbolId.js +75 -0
- package/dist/lib/models/{reflections/signature.d.ts → SignatureReflection.d.ts} +8 -7
- package/dist/lib/models/{reflections/signature.js → SignatureReflection.js} +7 -11
- package/dist/lib/models/{sources/file.d.ts → SourceReference.d.ts} +3 -4
- package/dist/lib/models/{reflections/type-parameter.d.ts → TypeParameterReflection.d.ts} +6 -5
- package/dist/lib/models/{reflections/type-parameter.js → TypeParameterReflection.js} +4 -1
- package/dist/lib/models/index.d.ts +18 -6
- package/dist/lib/models/index.js +18 -6
- package/dist/lib/models/{reflections/kind.d.ts → kind.d.ts} +2 -8
- package/dist/lib/models/{reflections/kind.js → kind.js} +99 -30
- package/dist/lib/models/types.d.ts +8 -10
- package/dist/lib/models/types.js +11 -22
- package/dist/lib/models/{reflections/variant.d.ts → variant.d.ts} +7 -7
- package/dist/lib/output/components.d.ts +2 -2
- package/dist/lib/output/components.js +1 -1
- package/dist/lib/output/events.d.ts +10 -18
- package/dist/lib/output/events.js +10 -27
- package/dist/lib/output/formatter.d.ts +8 -5
- package/dist/lib/output/formatter.js +45 -18
- package/dist/lib/output/index.d.ts +4 -5
- package/dist/lib/output/index.js +4 -4
- package/dist/lib/output/output.js +5 -4
- package/dist/lib/output/plugins/AssetsPlugin.js +7 -6
- package/dist/lib/output/plugins/HierarchyPlugin.js +4 -3
- package/dist/lib/output/plugins/IconsPlugin.js +3 -3
- package/dist/lib/output/plugins/JavascriptIndexPlugin.js +12 -17
- package/dist/lib/output/plugins/SitemapPlugin.js +6 -7
- package/dist/lib/output/renderer.d.ts +22 -14
- package/dist/lib/output/renderer.js +76 -36
- package/dist/lib/output/router.d.ts +175 -0
- package/dist/lib/output/router.js +478 -0
- package/dist/lib/output/theme.d.ts +3 -28
- package/dist/lib/output/theme.js +2 -15
- package/dist/lib/output/themes/MarkedPlugin.d.ts +2 -2
- package/dist/lib/output/themes/MarkedPlugin.js +32 -30
- package/dist/lib/output/themes/default/DefaultTheme.d.ts +11 -40
- package/dist/lib/output/themes/default/DefaultTheme.js +207 -406
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts +49 -47
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.js +17 -14
- package/dist/lib/output/themes/default/Slugger.js +1 -1
- package/dist/lib/output/themes/default/layouts/default.d.ts +1 -1
- package/dist/lib/output/themes/default/layouts/default.js +6 -6
- package/dist/lib/output/themes/default/partials/anchor-icon.d.ts +4 -1
- package/dist/lib/output/themes/default/partials/anchor-icon.js +12 -2
- package/dist/lib/output/themes/default/partials/breadcrumb.d.ts +2 -2
- package/dist/lib/output/themes/default/partials/breadcrumb.js +11 -5
- package/dist/lib/output/themes/default/partials/comment.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/comment.js +9 -9
- package/dist/lib/output/themes/default/partials/footer.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/footer.js +2 -2
- package/dist/lib/output/themes/default/partials/header.d.ts +2 -2
- package/dist/lib/output/themes/default/partials/header.js +4 -3
- package/dist/lib/output/themes/default/partials/hierarchy.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/hierarchy.js +10 -8
- package/dist/lib/output/themes/default/partials/icon.d.ts +2 -3
- package/dist/lib/output/themes/default/partials/icon.js +3 -3
- package/dist/lib/output/themes/default/partials/index.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/index.js +10 -18
- package/dist/lib/output/themes/default/partials/member.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/member.declaration.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/member.declaration.js +2 -2
- package/dist/lib/output/themes/default/partials/member.getterSetter.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/member.getterSetter.js +5 -5
- package/dist/lib/output/themes/default/partials/member.js +10 -9
- package/dist/lib/output/themes/default/partials/member.signature.body.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/member.signature.body.js +4 -4
- package/dist/lib/output/themes/default/partials/member.signature.title.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/member.signature.title.js +1 -1
- package/dist/lib/output/themes/default/partials/member.signatures.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/member.signatures.js +4 -4
- package/dist/lib/output/themes/default/partials/member.sources.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/member.sources.js +7 -7
- package/dist/lib/output/themes/default/partials/members.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/members.js +2 -2
- package/dist/lib/output/themes/default/partials/moduleReflection.d.ts +2 -2
- package/dist/lib/output/themes/default/partials/moduleReflection.js +5 -5
- package/dist/lib/output/themes/default/partials/navigation.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/navigation.js +17 -15
- package/dist/lib/output/themes/default/partials/reflectionPreview.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/reflectionPreview.js +2 -2
- package/dist/lib/output/themes/default/partials/toolbar.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/toolbar.js +10 -13
- package/dist/lib/output/themes/default/partials/type.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/type.js +1 -1
- package/dist/lib/output/themes/default/partials/typeAndParent.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/typeAndParent.js +3 -3
- package/dist/lib/output/themes/default/partials/typeDetails.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/typeDetails.js +23 -19
- package/dist/lib/output/themes/default/partials/typeParameters.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/typeParameters.js +12 -7
- package/dist/lib/output/themes/default/templates/document.d.ts +1 -1
- package/dist/lib/output/themes/default/templates/document.js +2 -2
- package/dist/lib/output/themes/default/templates/hierarchy.d.ts +1 -1
- package/dist/lib/output/themes/default/templates/hierarchy.js +4 -3
- package/dist/lib/output/themes/default/templates/index.d.ts +1 -1
- package/dist/lib/output/themes/default/templates/index.js +2 -2
- package/dist/lib/output/themes/default/templates/reflection.d.ts +1 -1
- package/dist/lib/output/themes/default/templates/reflection.js +9 -12
- package/dist/lib/output/themes/lib.d.ts +1 -1
- package/dist/lib/output/themes/lib.js +3 -3
- package/dist/lib/serialization/components.d.ts +1 -1
- package/dist/lib/serialization/deserializer.d.ts +9 -13
- package/dist/lib/serialization/deserializer.js +22 -24
- package/dist/lib/serialization/events.d.ts +1 -1
- package/dist/lib/serialization/index.d.ts +1 -1
- package/dist/lib/serialization/index.js +1 -1
- package/dist/lib/serialization/schema.d.ts +15 -10
- package/dist/lib/serialization/schema.js +1 -1
- package/dist/lib/serialization/serializer.d.ts +4 -4
- package/dist/lib/serialization/serializer.js +1 -2
- package/dist/lib/utils/ValidatingFileRegistry.d.ts +10 -0
- package/dist/lib/utils/ValidatingFileRegistry.js +34 -0
- package/dist/lib/utils/component.d.ts +1 -1
- package/dist/lib/utils/component.js +1 -1
- package/dist/lib/utils/entry-point.d.ts +3 -3
- package/dist/lib/utils/entry-point.js +29 -26
- package/dist/lib/utils/fs.d.ts +5 -13
- package/dist/lib/utils/fs.js +11 -67
- package/dist/lib/utils/general.d.ts +1 -47
- package/dist/lib/utils/general.js +4 -74
- package/dist/lib/utils/highlighter.js +1 -2
- package/dist/lib/utils/html.d.ts +0 -1
- package/dist/lib/utils/html.js +4 -13
- package/dist/lib/utils/index.d.ts +9 -17
- package/dist/lib/utils/index.js +8 -15
- package/dist/lib/utils/loggers.d.ts +5 -108
- package/dist/lib/utils/loggers.js +24 -168
- package/dist/lib/utils/options/declaration.d.ts +63 -38
- package/dist/lib/utils/options/declaration.js +124 -66
- package/dist/lib/utils/options/defaults.d.ts +1 -1
- package/dist/lib/utils/options/help.d.ts +1 -2
- package/dist/lib/utils/options/help.js +5 -5
- package/dist/lib/utils/options/index.d.ts +4 -4
- package/dist/lib/utils/options/index.js +3 -3
- package/dist/lib/utils/options/options.d.ts +3 -6
- package/dist/lib/utils/options/options.js +10 -12
- package/dist/lib/utils/options/readers/arguments.d.ts +2 -2
- package/dist/lib/utils/options/readers/arguments.js +4 -3
- package/dist/lib/utils/options/readers/package-json.d.ts +1 -1
- package/dist/lib/utils/options/readers/package-json.js +3 -2
- package/dist/lib/utils/options/readers/tsconfig.d.ts +1 -1
- package/dist/lib/utils/options/readers/tsconfig.js +27 -27
- package/dist/lib/utils/options/readers/typedoc.d.ts +1 -1
- package/dist/lib/utils/options/readers/typedoc.js +8 -9
- package/dist/lib/utils/options/sources/typedoc.js +143 -135
- package/dist/lib/utils/options/tsdoc-defaults.d.ts +1 -1
- package/dist/lib/utils/options/tsdoc-defaults.js +3 -1
- package/dist/lib/utils/package-manifest.d.ts +3 -3
- package/dist/lib/utils/package-manifest.js +9 -8
- package/dist/lib/utils/paths.d.ts +17 -6
- package/dist/lib/utils/paths.js +94 -11
- package/dist/lib/utils/perf.d.ts +4 -1
- package/dist/lib/utils/perf.js +32 -13
- package/dist/lib/utils/plugins.js +4 -3
- package/dist/lib/utils/sort.d.ts +1 -1
- package/dist/lib/utils/sort.js +8 -3
- package/dist/lib/utils/tsconfig.d.ts +1 -1
- package/dist/lib/utils/tsconfig.js +4 -3
- package/dist/lib/utils-common/general.d.ts +40 -0
- package/dist/lib/utils-common/general.js +20 -0
- package/dist/lib/utils-common/i18n.d.ts +17 -0
- package/dist/lib/utils-common/i18n.js +39 -0
- package/dist/lib/utils-common/index.d.ts +16 -0
- package/dist/lib/utils-common/index.js +18 -0
- package/dist/lib/{utils → utils-common}/jsx.d.ts +3 -3
- package/dist/lib/{utils → utils-common}/jsx.js +1 -1
- package/dist/lib/utils-common/logger.d.ts +86 -0
- package/dist/lib/utils-common/logger.js +120 -0
- package/dist/lib/{utils → utils-common}/minimalSourceFile.d.ts +7 -2
- package/dist/lib/{utils → utils-common}/minimalSourceFile.js +3 -2
- package/dist/lib/utils-common/path.d.ts +35 -0
- package/dist/lib/utils-common/path.js +123 -0
- package/dist/lib/utils-common/string.d.ts +11 -0
- package/dist/lib/utils-common/string.js +84 -0
- package/dist/lib/validation/documentation.d.ts +2 -2
- package/dist/lib/validation/documentation.js +5 -6
- package/dist/lib/validation/exports.d.ts +1 -1
- package/dist/lib/validation/exports.js +4 -4
- package/dist/lib/validation/links.d.ts +1 -1
- package/dist/lib/validation/links.js +9 -8
- package/dist/lib/validation/unusedMergeModuleWith.d.ts +1 -1
- package/dist/lib/validation/unusedMergeModuleWith.js +3 -2
- package/package.json +57 -36
- package/static/main.js +4 -4
- package/static/style.css +232 -209
- package/tsdoc.json +8 -0
- package/dist/lib/debug/debugRendererUrls.js +0 -59
- package/dist/lib/internationalization/locales/jp.cjs +0 -3
- package/dist/lib/internationalization/locales/jp.d.cts +0 -2
- package/dist/lib/models/comments/index.d.ts +0 -2
- package/dist/lib/models/comments/index.js +0 -1
- package/dist/lib/models/reflections/ReflectionSymbolId.js +0 -133
- package/dist/lib/models/reflections/index.d.ts +0 -15
- package/dist/lib/models/reflections/index.js +0 -12
- package/dist/lib/models/sources/index.d.ts +0 -1
- package/dist/lib/models/sources/index.js +0 -1
- package/dist/lib/output/models/UrlMapping.d.ts +0 -13
- package/dist/lib/output/models/UrlMapping.js +0 -10
- /package/dist/lib/models/{sources/file.js → SourceReference.js} +0 -0
- /package/dist/lib/models/{reflections/utils.d.ts → utils.d.ts} +0 -0
- /package/dist/lib/models/{reflections/utils.js → utils.js} +0 -0
- /package/dist/lib/models/{reflections/variant.js → variant.js} +0 -0
- /package/dist/lib/{utils → utils-common}/array.d.ts +0 -0
- /package/dist/lib/{utils → utils-common}/array.js +0 -0
- /package/dist/lib/{converter/comments → utils-common}/declarationReference.d.ts +0 -0
- /package/dist/lib/{converter/comments → utils-common}/declarationReference.js +0 -0
- /package/dist/lib/{utils → utils-common}/enum.d.ts +0 -0
- /package/dist/lib/{utils → utils-common}/enum.js +0 -0
- /package/dist/lib/{utils → utils-common}/events.d.ts +0 -0
- /package/dist/lib/{utils → utils-common}/events.js +0 -0
- /package/dist/lib/{utils → utils-common}/hooks.d.ts +0 -0
- /package/dist/lib/{utils → utils-common}/hooks.js +0 -0
- /package/dist/lib/{utils → utils-common}/jsx.elements.d.ts +0 -0
- /package/dist/lib/{utils → utils-common}/jsx.elements.js +0 -0
- /package/dist/lib/{utils → utils-common}/map.d.ts +0 -0
- /package/dist/lib/{utils → utils-common}/map.js +0 -0
- /package/dist/lib/{utils → utils-common}/set.d.ts +0 -0
- /package/dist/lib/{utils → utils-common}/set.js +0 -0
- /package/dist/lib/{utils → utils-common}/validation.d.ts +0 -0
- /package/dist/lib/{utils → utils-common}/validation.js +0 -0
package/README.md
CHANGED
|
@@ -45,38 +45,38 @@ https://github.com/Gerrit0/typedoc-packages-example
|
|
|
45
45
|
For a complete list of the command line arguments run `typedoc --help` or visit
|
|
46
46
|
[our website](https://typedoc.org/options/).
|
|
47
47
|
|
|
48
|
-
-
|
|
49
|
-
|
|
50
|
-
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
-
|
|
61
|
-
|
|
62
|
-
|
|
48
|
+
- `--out <path/to/documentation/>`<br>
|
|
49
|
+
Specifies the location the documentation should be written to. Defaults to `./docs`
|
|
50
|
+
- `--json <path/to/output.json>`<br>
|
|
51
|
+
Specifies the location and file name a json file describing the project is
|
|
52
|
+
written to. When specified no documentation will be generated unless `--out` is also
|
|
53
|
+
specified.
|
|
54
|
+
- `--options`<br>
|
|
55
|
+
Specify a json option file that should be loaded. If not specified TypeDoc
|
|
56
|
+
will look for 'typedoc.json' in the current directory.
|
|
57
|
+
- `--tsconfig <path/to/tsconfig.json>`<br>
|
|
58
|
+
Specify a typescript config file that should be loaded. If not
|
|
59
|
+
specified TypeDoc will look for 'tsconfig.json' in the current directory.
|
|
60
|
+
- `--exclude <pattern>`<br>
|
|
61
|
+
Exclude files by the given pattern when a path is provided as source.
|
|
62
|
+
Supports standard minimatch patterns.
|
|
63
63
|
|
|
64
64
|
#### Theming
|
|
65
65
|
|
|
66
|
-
-
|
|
67
|
-
|
|
68
|
-
-
|
|
69
|
-
|
|
70
|
-
-
|
|
71
|
-
|
|
72
|
-
|
|
66
|
+
- `--theme <default|plugin defined theme>`<br>
|
|
67
|
+
Specify the theme that should be used.
|
|
68
|
+
- `--name <Documentation title>`<br>
|
|
69
|
+
Set the name of the project that will be used in the header of the template.
|
|
70
|
+
- `--readme <path/to/readme|none>`<br>
|
|
71
|
+
Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page
|
|
72
|
+
and start the documentation on the globals page.
|
|
73
73
|
|
|
74
74
|
#### Miscellaneous
|
|
75
75
|
|
|
76
|
-
-
|
|
77
|
-
|
|
78
|
-
-
|
|
79
|
-
|
|
76
|
+
- `--version`<br>
|
|
77
|
+
Display the version number of TypeDoc.
|
|
78
|
+
- `--help`<br>
|
|
79
|
+
Display all TypeDoc options.
|
|
80
80
|
|
|
81
81
|
## Contributing
|
|
82
82
|
|
package/bin/package.json
CHANGED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
export default {
|
|
2
|
+
"serialized_project_referenced_0_not_part_of_project": "Serialized project referenced reflection {0}, which was not a part of the project",
|
|
3
|
+
"kind_project": "Project",
|
|
4
|
+
"kind_module": "Module",
|
|
5
|
+
"kind_namespace": "Namespace",
|
|
6
|
+
"kind_enum": "Enumeration",
|
|
7
|
+
"kind_enum_member": "Enumeration Member",
|
|
8
|
+
"kind_variable": "Variable",
|
|
9
|
+
"kind_function": "Function",
|
|
10
|
+
"kind_class": "Class",
|
|
11
|
+
"kind_interface": "Interface",
|
|
12
|
+
"kind_constructor": "Constructor",
|
|
13
|
+
"kind_property": "Property",
|
|
14
|
+
"kind_method": "Method",
|
|
15
|
+
"kind_call_signature": "Call Signature",
|
|
16
|
+
"kind_index_signature": "Index Signature",
|
|
17
|
+
"kind_constructor_signature": "Constructor Signature",
|
|
18
|
+
"kind_parameter": "Parameter",
|
|
19
|
+
"kind_type_literal": "Type Literal",
|
|
20
|
+
"kind_type_parameter": "Type Parameter",
|
|
21
|
+
"kind_accessor": "Accessor",
|
|
22
|
+
"kind_get_signature": "Get Signature",
|
|
23
|
+
"kind_set_signature": "Set Signature",
|
|
24
|
+
"kind_type_alias": "Type Alias",
|
|
25
|
+
"kind_reference": "Reference",
|
|
26
|
+
"kind_document": "Document",
|
|
27
|
+
"kind_plural_project": "Projects",
|
|
28
|
+
"kind_plural_module": "Modules",
|
|
29
|
+
"kind_plural_namespace": "Namespaces",
|
|
30
|
+
"kind_plural_enum": "Enumerations",
|
|
31
|
+
"kind_plural_enum_member": "Enumeration Members",
|
|
32
|
+
"kind_plural_variable": "Variables",
|
|
33
|
+
"kind_plural_function": "Functions",
|
|
34
|
+
"kind_plural_class": "Classes",
|
|
35
|
+
"kind_plural_interface": "Interfaces",
|
|
36
|
+
"kind_plural_constructor": "Constructors",
|
|
37
|
+
"kind_plural_property": "Properties",
|
|
38
|
+
"kind_plural_method": "Methods",
|
|
39
|
+
"kind_plural_call_signature": "Call Signatures",
|
|
40
|
+
"kind_plural_index_signature": "Index Signatures",
|
|
41
|
+
"kind_plural_constructor_signature": "Constructor Signatures",
|
|
42
|
+
"kind_plural_parameter": "Parameters",
|
|
43
|
+
"kind_plural_type_literal": "Type Literals",
|
|
44
|
+
"kind_plural_type_parameter": "Type Parameters",
|
|
45
|
+
"kind_plural_accessor": "Accessors",
|
|
46
|
+
"kind_plural_get_signature": "Get Signatures",
|
|
47
|
+
"kind_plural_set_signature": "Set Signatures",
|
|
48
|
+
"kind_plural_type_alias": "Type Aliases",
|
|
49
|
+
"kind_plural_reference": "References",
|
|
50
|
+
"kind_plural_document": "Documents",
|
|
51
|
+
"flag_private": "Private",
|
|
52
|
+
"flag_protected": "Protected",
|
|
53
|
+
"flag_public": "Public",
|
|
54
|
+
"flag_static": "Static",
|
|
55
|
+
"flag_external": "External",
|
|
56
|
+
"flag_optional": "Optional",
|
|
57
|
+
"flag_rest": "Rest",
|
|
58
|
+
"flag_abstract": "Abstract",
|
|
59
|
+
"flag_const": "Const",
|
|
60
|
+
"flag_readonly": "Readonly",
|
|
61
|
+
"flag_inherited": "Inherited"
|
|
62
|
+
}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
export default {
|
|
2
|
+
"serialized_project_referenced_0_not_part_of_project": "シリアル化されたプロジェクトは、プロジェクトの一部ではないリフレクション {0} を参照しました",
|
|
3
|
+
"kind_project": "プロジェクト",
|
|
4
|
+
"kind_module": "モジュール",
|
|
5
|
+
"kind_namespace": "名前空間",
|
|
6
|
+
"kind_enum": "列挙",
|
|
7
|
+
"kind_enum_member": "列挙メンバー",
|
|
8
|
+
"kind_variable": "変数",
|
|
9
|
+
"kind_function": "関数",
|
|
10
|
+
"kind_class": "クラス",
|
|
11
|
+
"kind_interface": "インターフェイス",
|
|
12
|
+
"kind_constructor": "コンストラクター",
|
|
13
|
+
"kind_property": "プロパティ",
|
|
14
|
+
"kind_method": "メソッド",
|
|
15
|
+
"kind_call_signature": "コールシグネチャ",
|
|
16
|
+
"kind_index_signature": "インデックスシグネチャ",
|
|
17
|
+
"kind_constructor_signature": "コンストラクターシグネチャ",
|
|
18
|
+
"kind_parameter": "パラメーター",
|
|
19
|
+
"kind_type_literal": "型リテラル",
|
|
20
|
+
"kind_type_parameter": "型パラメーター",
|
|
21
|
+
"kind_accessor": "アクセッサー",
|
|
22
|
+
"kind_get_signature": "署名を取得する",
|
|
23
|
+
"kind_set_signature": "署名を設定する",
|
|
24
|
+
"kind_type_alias": "型エイリアス",
|
|
25
|
+
"kind_reference": "リファレンス",
|
|
26
|
+
"kind_document": "ドキュメント",
|
|
27
|
+
"kind_plural_project": "プロジェクト",
|
|
28
|
+
"kind_plural_module": "モジュール",
|
|
29
|
+
"kind_plural_namespace": "名前空間",
|
|
30
|
+
"kind_plural_enum": "列挙",
|
|
31
|
+
"kind_plural_enum_member": "列挙メンバー",
|
|
32
|
+
"kind_plural_variable": "変数",
|
|
33
|
+
"kind_plural_function": "関数",
|
|
34
|
+
"kind_plural_class": "クラス",
|
|
35
|
+
"kind_plural_interface": "インターフェイス",
|
|
36
|
+
"kind_plural_constructor": "コンストラクター",
|
|
37
|
+
"kind_plural_property": "プロパティ",
|
|
38
|
+
"kind_plural_method": "メソッド",
|
|
39
|
+
"kind_plural_call_signature": "コールシグネチャ",
|
|
40
|
+
"kind_plural_index_signature": "インデックスシグネチャ",
|
|
41
|
+
"kind_plural_constructor_signature": "コンストラクターシグネチャ",
|
|
42
|
+
"kind_plural_parameter": "パラメータ",
|
|
43
|
+
"kind_plural_type_literal": "型リテラル",
|
|
44
|
+
"kind_plural_type_parameter": "型パラメーター",
|
|
45
|
+
"kind_plural_accessor": "アクセッサー",
|
|
46
|
+
"kind_plural_get_signature": "署名を取得する",
|
|
47
|
+
"kind_plural_set_signature": "署名を設定する",
|
|
48
|
+
"kind_plural_type_alias": "型エイリアス",
|
|
49
|
+
"kind_plural_reference": "リファレンス",
|
|
50
|
+
"kind_plural_document": "ドキュメント",
|
|
51
|
+
"flag_private": "非公開",
|
|
52
|
+
"flag_protected": "保護",
|
|
53
|
+
"flag_public": "公開",
|
|
54
|
+
"flag_static": "静的",
|
|
55
|
+
"flag_external": "外部",
|
|
56
|
+
"flag_optional": "オプション",
|
|
57
|
+
"flag_rest": "REST パラメータ",
|
|
58
|
+
"flag_abstract": "抽象",
|
|
59
|
+
"flag_const": "定数",
|
|
60
|
+
"flag_readonly": "読み取り専用",
|
|
61
|
+
"flag_inherited": "継承"
|
|
62
|
+
}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
export default {
|
|
2
|
+
"serialized_project_referenced_0_not_part_of_project": "Serialized project referenced reflection {0}, which was not a part of the project",
|
|
3
|
+
"kind_project": "프로젝트",
|
|
4
|
+
"kind_module": "모듈",
|
|
5
|
+
"kind_namespace": "네임스페이스",
|
|
6
|
+
"kind_enum": "열거형",
|
|
7
|
+
"kind_enum_member": "포함된 값",
|
|
8
|
+
"kind_variable": "변수",
|
|
9
|
+
"kind_function": "함수",
|
|
10
|
+
"kind_class": "클래스",
|
|
11
|
+
"kind_interface": "인터페이스",
|
|
12
|
+
"kind_constructor": "생성자",
|
|
13
|
+
"kind_property": "속성",
|
|
14
|
+
"kind_method": "메소드",
|
|
15
|
+
"kind_call_signature": "호출 시그니쳐",
|
|
16
|
+
"kind_index_signature": "인덱스 시그니쳐",
|
|
17
|
+
"kind_constructor_signature": "생성자 시그니쳐",
|
|
18
|
+
"kind_parameter": "매개변수",
|
|
19
|
+
"kind_type_literal": "타입 리터럴",
|
|
20
|
+
"kind_type_parameter": "타입 매개변수",
|
|
21
|
+
"kind_accessor": "접근자",
|
|
22
|
+
"kind_get_signature": "get 시그니쳐",
|
|
23
|
+
"kind_set_signature": "set 시그니쳐",
|
|
24
|
+
"kind_type_alias": "타입 별칭",
|
|
25
|
+
"kind_reference": "참조",
|
|
26
|
+
"kind_document": "문서",
|
|
27
|
+
"kind_plural_project": "프로젝트",
|
|
28
|
+
"kind_plural_module": "모듈",
|
|
29
|
+
"kind_plural_namespace": "네임스페이스",
|
|
30
|
+
"kind_plural_enum": "열거형",
|
|
31
|
+
"kind_plural_enum_member": "포함된 값",
|
|
32
|
+
"kind_plural_variable": "변수",
|
|
33
|
+
"kind_plural_function": "함수",
|
|
34
|
+
"kind_plural_class": "클래스",
|
|
35
|
+
"kind_plural_interface": "인터페이스",
|
|
36
|
+
"kind_plural_constructor": "생성자",
|
|
37
|
+
"kind_plural_property": "속성",
|
|
38
|
+
"kind_plural_method": "메소드",
|
|
39
|
+
"kind_plural_call_signature": "호출 시그니쳐",
|
|
40
|
+
"kind_plural_index_signature": "인덱스 시그니쳐",
|
|
41
|
+
"kind_plural_constructor_signature": "생성자 시그니쳐",
|
|
42
|
+
"kind_plural_parameter": "매개변수",
|
|
43
|
+
"kind_plural_type_literal": "타입 리터럴",
|
|
44
|
+
"kind_plural_type_parameter": "타입 매개변수",
|
|
45
|
+
"kind_plural_accessor": "접근자",
|
|
46
|
+
"kind_plural_get_signature": "get 시그니쳐",
|
|
47
|
+
"kind_plural_set_signature": "set 시그니쳐",
|
|
48
|
+
"kind_plural_type_alias": "타입 별칭",
|
|
49
|
+
"kind_plural_reference": "참조",
|
|
50
|
+
"kind_plural_document": "문서",
|
|
51
|
+
"flag_private": "Private",
|
|
52
|
+
"flag_protected": "Protected",
|
|
53
|
+
"flag_public": "Public",
|
|
54
|
+
"flag_static": "Static",
|
|
55
|
+
"flag_external": "External",
|
|
56
|
+
"flag_optional": "Optional",
|
|
57
|
+
"flag_rest": "Rest",
|
|
58
|
+
"flag_abstract": "Abstract",
|
|
59
|
+
"flag_const": "Const",
|
|
60
|
+
"flag_readonly": "Readonly",
|
|
61
|
+
"flag_inherited": "Inherited"
|
|
62
|
+
}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
export default {
|
|
2
|
+
"serialized_project_referenced_0_not_part_of_project": "序列化项目引用了反射 {0},但它不是项目的一部分",
|
|
3
|
+
"kind_project": "项目",
|
|
4
|
+
"kind_module": "模块",
|
|
5
|
+
"kind_namespace": "命名空间",
|
|
6
|
+
"kind_enum": "枚举",
|
|
7
|
+
"kind_enum_member": "枚举成员",
|
|
8
|
+
"kind_variable": "变量",
|
|
9
|
+
"kind_function": "函数",
|
|
10
|
+
"kind_class": "类",
|
|
11
|
+
"kind_interface": "接口",
|
|
12
|
+
"kind_constructor": "构造函数",
|
|
13
|
+
"kind_property": "属性",
|
|
14
|
+
"kind_method": "方法",
|
|
15
|
+
"kind_call_signature": "调用签名",
|
|
16
|
+
"kind_index_signature": "索引签名",
|
|
17
|
+
"kind_constructor_signature": "构造函数签名",
|
|
18
|
+
"kind_parameter": "参数",
|
|
19
|
+
"kind_type_literal": "类型字面量",
|
|
20
|
+
"kind_type_parameter": "类型参数",
|
|
21
|
+
"kind_accessor": "访问器",
|
|
22
|
+
"kind_get_signature": "Getter 签名",
|
|
23
|
+
"kind_set_signature": "Setter 签名",
|
|
24
|
+
"kind_type_alias": "类型别名",
|
|
25
|
+
"kind_reference": "参考",
|
|
26
|
+
"kind_document": "文档",
|
|
27
|
+
"kind_plural_project": "项目",
|
|
28
|
+
"kind_plural_module": "模块",
|
|
29
|
+
"kind_plural_namespace": "命名空间",
|
|
30
|
+
"kind_plural_enum": "枚举",
|
|
31
|
+
"kind_plural_enum_member": "枚举成员",
|
|
32
|
+
"kind_plural_variable": "变量",
|
|
33
|
+
"kind_plural_function": "函数",
|
|
34
|
+
"kind_plural_class": "类",
|
|
35
|
+
"kind_plural_interface": "接口",
|
|
36
|
+
"kind_plural_constructor": "构造函数",
|
|
37
|
+
"kind_plural_property": "属性",
|
|
38
|
+
"kind_plural_method": "方法",
|
|
39
|
+
"kind_plural_call_signature": "调用签名",
|
|
40
|
+
"kind_plural_index_signature": "索引签名",
|
|
41
|
+
"kind_plural_constructor_signature": "构造函数签名",
|
|
42
|
+
"kind_plural_parameter": "参数",
|
|
43
|
+
"kind_plural_type_literal": "类型字面量",
|
|
44
|
+
"kind_plural_type_parameter": "类型参数",
|
|
45
|
+
"kind_plural_accessor": "访问器",
|
|
46
|
+
"kind_plural_get_signature": "Getter 签名",
|
|
47
|
+
"kind_plural_set_signature": "Setter 签名",
|
|
48
|
+
"kind_plural_type_alias": "类型别名",
|
|
49
|
+
"kind_plural_reference": "参考",
|
|
50
|
+
"kind_plural_document": "文档",
|
|
51
|
+
"flag_private": "私有",
|
|
52
|
+
"flag_protected": "受保护",
|
|
53
|
+
"flag_public": "公开",
|
|
54
|
+
"flag_static": "静态",
|
|
55
|
+
"flag_external": "外部",
|
|
56
|
+
"flag_optional": "可选",
|
|
57
|
+
"flag_rest": "动态参数",
|
|
58
|
+
"flag_abstract": "抽象",
|
|
59
|
+
"flag_const": "常量",
|
|
60
|
+
"flag_readonly": "只读",
|
|
61
|
+
"flag_inherited": "继承"
|
|
62
|
+
}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
export * from "#models";
|
|
2
|
+
export { addTranslations, type ComponentPath, ConsoleLogger, type DeclarationReference, type EnumKeys, Logger, LogLevel, type Meaning, type MinimalNode, MinimalSourceFile, type NormalizedPath, setTranslations, type SymbolReference, type TranslatedString, translateTagName, } from "#utils";
|
|
3
|
+
export { type Deserializable, Deserializer, type DeserializerComponent, JSONOutput, SerializeEvent, Serializer, type SerializerComponent, type SerializerEvents, } from "#serialization";
|
package/dist/index.d.ts
CHANGED
|
@@ -5,12 +5,16 @@
|
|
|
5
5
|
* entry point which exports some functions which may be useful during plugin
|
|
6
6
|
* development or debugging. Exports from that entry point are **not stable**
|
|
7
7
|
* and may change or be removed at any time.
|
|
8
|
+
*
|
|
9
|
+
* TypeDoc also exports a `typedoc/browser` entry point which exports a subset
|
|
10
|
+
* of the members described here which makes it suitable for usage in browser
|
|
11
|
+
* bundles which want to use TypeDoc's JSON output in the browser.
|
|
8
12
|
*/
|
|
9
13
|
export { Application, type ApplicationEvents } from "./lib/application.js";
|
|
10
|
-
export {
|
|
11
|
-
export { resetReflectionID } from "./lib/models/reflections/abstract.js";
|
|
14
|
+
export { resetReflectionID } from "./lib/models/Reflection.js";
|
|
12
15
|
/**
|
|
13
16
|
* All symbols documented under the Models namespace are also available in the root import.
|
|
17
|
+
* @primaryExport
|
|
14
18
|
*
|
|
15
19
|
* @categoryDescription Types
|
|
16
20
|
* Describes a TypeScript type.
|
|
@@ -28,15 +32,17 @@ export * as Models from "./lib/models/index.js";
|
|
|
28
32
|
* @summary
|
|
29
33
|
* Controls how TypeDoc reads option files and what options are available.
|
|
30
34
|
*/
|
|
31
|
-
export
|
|
35
|
+
export { type CommentParserConfig, Context, Converter, type ConverterEvents, type ExternalResolveResult, type ExternalSymbolResolver, } from "./lib/converter/index.js";
|
|
32
36
|
export * from "./lib/models/index.js";
|
|
33
|
-
|
|
34
|
-
export
|
|
35
|
-
export
|
|
37
|
+
/** @primaryExport */
|
|
38
|
+
export * as Configuration from "./lib/utils/options/index.js";
|
|
39
|
+
export { BaseRouter, CategoryRouter, DefaultTheme, DefaultThemeRenderContext, GroupRouter, IndexEvent, KindDirRouter, KindRouter, MarkdownEvent, PageEvent, PageKind, Renderer, RendererEvent, Slugger, StructureDirRouter, StructureRouter, Theme, } from "./lib/output/index.js";
|
|
40
|
+
export type { Icons, NavigationElement, PageDefinition, PageHeading, RendererEvents, RendererHooks, RenderTemplate, Router, } from "./lib/output/index.js";
|
|
36
41
|
export { Outputs } from "./lib/output/output.js";
|
|
37
|
-
export { ArgumentsReader,
|
|
38
|
-
export type {
|
|
39
|
-
export {
|
|
42
|
+
export { ArgumentsReader, CommentStyle, EntryPointStrategy, normalizePath, Option, OptionDefaults, Options, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, ValidatingFileRegistry, } from "./lib/utils/index.js";
|
|
43
|
+
export type { ArrayDeclarationOption, BooleanDeclarationOption, DeclarationOption, DeclarationOptionBase, DeclarationOptionToOptionType, DocumentationEntryPoint, FancyConsoleLogger, FlagsDeclarationOption, JsDocCompatibility, KeyToDeclaration, ManuallyValidatedOption, MapDeclarationOption, MixedDeclarationOption, NumberDeclarationOption, ObjectDeclarationOption, OptionsReader, OutputSpecification, ParameterTypeToOptionTypeMap, SortStrategy, StringDeclarationOption, TypeDocOptionMap, TypeDocOptions, TypeDocOptionValues, ValidationOptions, } from "./lib/utils/index.js";
|
|
44
|
+
export { type ComponentPath, ConsoleLogger, type DeclarationReference, type EnumKeys, EventDispatcher, EventHooks, type GlobString, i18n, JSX, Logger, LogLevel, type Meaning, type MeaningKeyword, type MinimalNode, MinimalSourceFile, type NormalizedPath, type NormalizedPathOrModule, type SymbolReference, translateTagName, } from "#utils";
|
|
45
|
+
export { type Deserializable, Deserializer, type DeserializerComponent, JSONOutput, SerializeEvent, Serializer, type SerializerComponent, type SerializerEvents, } from "./lib/serialization/index.js";
|
|
40
46
|
export * as Internationalization from "./lib/internationalization/index.js";
|
|
41
47
|
export type { TranslatableStrings } from "./lib/internationalization/internationalization.js";
|
|
42
48
|
import TypeScript from "typescript";
|
package/dist/index.js
CHANGED
|
@@ -5,12 +5,16 @@
|
|
|
5
5
|
* entry point which exports some functions which may be useful during plugin
|
|
6
6
|
* development or debugging. Exports from that entry point are **not stable**
|
|
7
7
|
* and may change or be removed at any time.
|
|
8
|
+
*
|
|
9
|
+
* TypeDoc also exports a `typedoc/browser` entry point which exports a subset
|
|
10
|
+
* of the members described here which makes it suitable for usage in browser
|
|
11
|
+
* bundles which want to use TypeDoc's JSON output in the browser.
|
|
8
12
|
*/
|
|
9
13
|
export { Application } from "./lib/application.js";
|
|
10
|
-
export {
|
|
11
|
-
export { resetReflectionID } from "./lib/models/reflections/abstract.js";
|
|
14
|
+
export { resetReflectionID } from "./lib/models/Reflection.js";
|
|
12
15
|
/**
|
|
13
16
|
* All symbols documented under the Models namespace are also available in the root import.
|
|
17
|
+
* @primaryExport
|
|
14
18
|
*
|
|
15
19
|
* @categoryDescription Types
|
|
16
20
|
* Describes a TypeScript type.
|
|
@@ -28,13 +32,15 @@ export * as Models from "./lib/models/index.js";
|
|
|
28
32
|
* @summary
|
|
29
33
|
* Controls how TypeDoc reads option files and what options are available.
|
|
30
34
|
*/
|
|
31
|
-
export
|
|
35
|
+
export { Context, Converter, } from "./lib/converter/index.js";
|
|
32
36
|
export * from "./lib/models/index.js";
|
|
33
|
-
|
|
34
|
-
export
|
|
37
|
+
/** @primaryExport */
|
|
38
|
+
export * as Configuration from "./lib/utils/options/index.js";
|
|
39
|
+
export { BaseRouter, CategoryRouter, DefaultTheme, DefaultThemeRenderContext, GroupRouter, IndexEvent, KindDirRouter, KindRouter, MarkdownEvent, PageEvent, PageKind, Renderer, RendererEvent, Slugger, StructureDirRouter, StructureRouter, Theme, } from "./lib/output/index.js";
|
|
35
40
|
export { Outputs } from "./lib/output/output.js";
|
|
36
|
-
export { ArgumentsReader,
|
|
37
|
-
export {
|
|
41
|
+
export { ArgumentsReader, CommentStyle, EntryPointStrategy, normalizePath, Option, OptionDefaults, Options, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, ValidatingFileRegistry, } from "./lib/utils/index.js";
|
|
42
|
+
export { ConsoleLogger, EventDispatcher, EventHooks, i18n, JSX, Logger, LogLevel, MinimalSourceFile, translateTagName, } from "#utils";
|
|
43
|
+
export { Deserializer, JSONOutput, SerializeEvent, Serializer, } from "./lib/serialization/index.js";
|
|
38
44
|
export * as Internationalization from "./lib/internationalization/index.js";
|
|
39
45
|
import TypeScript from "typescript";
|
|
40
46
|
export { TypeScript };
|
|
@@ -1,14 +1,15 @@
|
|
|
1
1
|
import { Deserializer, Serializer } from "./serialization/index.js";
|
|
2
2
|
import { Converter } from "./converter/index.js";
|
|
3
3
|
import { Renderer } from "./output/renderer.js";
|
|
4
|
-
import type
|
|
5
|
-
import {
|
|
4
|
+
import { type ProjectReflection } from "./models/index.js";
|
|
5
|
+
import { AbstractComponent, type OptionsReader } from "./utils/index.js";
|
|
6
6
|
import { Options } from "./utils/index.js";
|
|
7
|
-
import type
|
|
7
|
+
import { type TypeDocOptions } from "./utils/options/declaration.js";
|
|
8
|
+
import { type GlobString, Logger } from "#utils";
|
|
8
9
|
import { type DocumentationEntryPoint, EntryPointStrategy } from "./utils/entry-point.js";
|
|
9
|
-
import { Internationalization } from "./internationalization/internationalization.js";
|
|
10
10
|
import { FileRegistry } from "./models/FileRegistry.js";
|
|
11
11
|
import { Outputs } from "./output/output.js";
|
|
12
|
+
import { Internationalization } from "./internationalization/internationalization.js";
|
|
12
13
|
export declare function createAppForTesting(): Application;
|
|
13
14
|
export interface ApplicationEvents {
|
|
14
15
|
bootstrapEnd: [Application];
|
|
@@ -37,6 +38,7 @@ export interface ApplicationEvents {
|
|
|
37
38
|
* @summary Root level class which contains most useful behavior.
|
|
38
39
|
*/
|
|
39
40
|
export declare class Application extends AbstractComponent<Application, ApplicationEvents> {
|
|
41
|
+
private _logger;
|
|
40
42
|
/**
|
|
41
43
|
* The converter used to create the declaration reflections.
|
|
42
44
|
*/
|
|
@@ -57,16 +59,13 @@ export declare class Application extends AbstractComponent<Application, Applicat
|
|
|
57
59
|
/**
|
|
58
60
|
* The logger that should be used to output messages.
|
|
59
61
|
*/
|
|
60
|
-
logger: Logger;
|
|
62
|
+
get logger(): Logger;
|
|
63
|
+
set logger(l: Logger);
|
|
61
64
|
/**
|
|
62
65
|
* Internationalization module which supports translating according to
|
|
63
66
|
* the `lang` option.
|
|
64
67
|
*/
|
|
65
68
|
internationalization: Internationalization;
|
|
66
|
-
/**
|
|
67
|
-
* Proxy based shortcuts for internationalization keys.
|
|
68
|
-
*/
|
|
69
|
-
i18n: import("./internationalization/internationalization.js").TranslationProxy;
|
|
70
69
|
options: Options;
|
|
71
70
|
files: FileRegistry;
|
|
72
71
|
/** @internal */
|
|
@@ -76,7 +75,7 @@ export declare class Application extends AbstractComponent<Application, Applicat
|
|
|
76
75
|
/** @internal */
|
|
77
76
|
accessor entryPointStrategy: EntryPointStrategy;
|
|
78
77
|
/** @internal */
|
|
79
|
-
accessor entryPoints:
|
|
78
|
+
accessor entryPoints: GlobString[];
|
|
80
79
|
/**
|
|
81
80
|
* The version number of TypeDoc.
|
|
82
81
|
*/
|