typedoc 0.26.11 → 0.27.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/bin/package.json +3 -0
- package/bin/typedoc +1 -1
- package/dist/index.d.ts +23 -13
- package/dist/index.js +22 -81
- package/dist/lib/application-events.js +1 -4
- package/dist/lib/application.d.ts +26 -16
- package/dist/lib/application.js +222 -242
- package/dist/lib/cli.js +3 -40
- package/dist/lib/converter/comments/blockLexer.d.ts +1 -1
- package/dist/lib/converter/comments/blockLexer.js +24 -30
- package/dist/lib/converter/comments/declarationReference.js +10 -21
- package/dist/lib/converter/comments/declarationReferenceResolver.d.ts +2 -2
- package/dist/lib/converter/comments/declarationReferenceResolver.js +40 -36
- package/dist/lib/converter/comments/discovery.d.ts +4 -4
- package/dist/lib/converter/comments/discovery.js +154 -172
- package/dist/lib/converter/comments/index.d.ts +4 -4
- package/dist/lib/converter/comments/index.js +39 -50
- package/dist/lib/converter/comments/lexer.d.ts +1 -1
- package/dist/lib/converter/comments/lexer.js +2 -5
- package/dist/lib/converter/comments/lineLexer.d.ts +1 -1
- package/dist/lib/converter/comments/lineLexer.js +12 -15
- package/dist/lib/converter/comments/linkResolver.d.ts +2 -2
- package/dist/lib/converter/comments/linkResolver.js +14 -21
- package/dist/lib/converter/comments/parser.d.ts +6 -6
- package/dist/lib/converter/comments/parser.js +69 -96
- package/dist/lib/converter/comments/rawLexer.d.ts +1 -1
- package/dist/lib/converter/comments/rawLexer.js +13 -16
- package/dist/lib/converter/comments/tagName.js +1 -4
- package/dist/lib/converter/comments/textParser.d.ts +4 -4
- package/dist/lib/converter/comments/textParser.js +28 -30
- package/dist/lib/converter/components.d.ts +2 -3
- package/dist/lib/converter/components.js +2 -7
- package/dist/lib/converter/context.d.ts +9 -9
- package/dist/lib/converter/context.js +54 -44
- package/dist/lib/converter/convert-expression.js +16 -23
- package/dist/lib/converter/converter-events.d.ts +1 -0
- package/dist/lib/converter/converter-events.js +2 -4
- package/dist/lib/converter/converter.d.ts +16 -13
- package/dist/lib/converter/converter.js +212 -239
- package/dist/lib/converter/factories/index-signature.d.ts +3 -3
- package/dist/lib/converter/factories/index-signature.js +43 -26
- package/dist/lib/converter/factories/signature.d.ts +2 -2
- package/dist/lib/converter/factories/signature.js +95 -106
- package/dist/lib/converter/index.d.ts +6 -7
- package/dist/lib/converter/index.js +3 -11
- package/dist/lib/converter/jsdoc.d.ts +1 -1
- package/dist/lib/converter/jsdoc.js +34 -41
- package/dist/lib/converter/plugins/CategoryPlugin.d.ts +6 -21
- package/dist/lib/converter/plugins/CategoryPlugin.js +57 -139
- package/dist/lib/converter/plugins/CommentPlugin.d.ts +3 -5
- package/dist/lib/converter/plugins/CommentPlugin.js +153 -163
- package/dist/lib/converter/plugins/GroupPlugin.d.ts +10 -9
- package/dist/lib/converter/plugins/GroupPlugin.js +87 -124
- package/dist/lib/converter/plugins/ImplementsPlugin.d.ts +3 -5
- package/dist/lib/converter/plugins/ImplementsPlugin.js +255 -321
- package/dist/lib/converter/plugins/IncludePlugin.d.ts +11 -0
- package/dist/lib/converter/plugins/IncludePlugin.js +72 -0
- package/dist/lib/converter/plugins/InheritDocPlugin.d.ts +4 -3
- package/dist/lib/converter/plugins/InheritDocPlugin.js +41 -72
- package/dist/lib/converter/plugins/LinkResolverPlugin.d.ts +5 -5
- package/dist/lib/converter/plugins/LinkResolverPlugin.js +37 -58
- package/dist/lib/converter/plugins/MergeModuleWithPlugin.d.ts +12 -0
- package/dist/lib/converter/plugins/MergeModuleWithPlugin.js +49 -0
- package/dist/lib/converter/plugins/PackagePlugin.d.ts +4 -3
- package/dist/lib/converter/plugins/PackagePlugin.js +62 -111
- package/dist/lib/converter/plugins/SourcePlugin.d.ts +3 -5
- package/dist/lib/converter/plugins/SourcePlugin.js +69 -110
- package/dist/lib/converter/plugins/TypePlugin.d.ts +4 -6
- package/dist/lib/converter/plugins/TypePlugin.js +95 -158
- package/dist/lib/converter/plugins/index.d.ts +10 -9
- package/dist/lib/converter/plugins/index.js +10 -21
- package/dist/lib/converter/symbols.d.ts +1 -1
- package/dist/lib/converter/symbols.js +234 -227
- package/dist/lib/converter/types.d.ts +2 -2
- package/dist/lib/converter/types.js +252 -237
- package/dist/lib/converter/utils/nodes.js +5 -13
- package/dist/lib/converter/utils/reflections.d.ts +1 -1
- package/dist/lib/converter/utils/reflections.js +4 -7
- package/dist/lib/converter/utils/repository.d.ts +1 -1
- package/dist/lib/converter/utils/repository.js +103 -97
- package/dist/lib/converter/utils/symbols.js +3 -9
- package/dist/lib/internationalization/index.d.ts +3 -4
- package/dist/lib/internationalization/index.js +3 -8
- package/dist/lib/internationalization/internationalization.d.ts +5 -4
- package/dist/lib/internationalization/internationalization.js +97 -103
- package/dist/lib/internationalization/locale-utils.cjs +8 -0
- package/dist/lib/internationalization/locale-utils.d.cts +8 -0
- package/dist/lib/internationalization/locales/en.cjs +372 -2
- package/dist/lib/internationalization/locales/en.d.cts +343 -2
- package/dist/lib/internationalization/locales/jp.cjs +13 -14
- package/dist/lib/internationalization/locales/jp.d.cts +307 -1
- package/dist/lib/internationalization/locales/ko.cjs +12 -11
- package/dist/lib/internationalization/locales/ko.d.cts +221 -1
- package/dist/lib/internationalization/locales/zh.cjs +43 -19
- package/dist/lib/internationalization/locales/zh.d.cts +409 -1
- package/dist/lib/internationalization/translatable.d.ts +4 -327
- package/dist/lib/internationalization/translatable.js +2 -360
- package/dist/lib/models/FileRegistry.d.ts +20 -9
- package/dist/lib/models/FileRegistry.js +54 -45
- package/dist/lib/models/ReflectionCategory.d.ts +2 -2
- package/dist/lib/models/ReflectionCategory.js +16 -12
- package/dist/lib/models/ReflectionGroup.d.ts +3 -3
- package/dist/lib/models/ReflectionGroup.js +23 -14
- package/dist/lib/models/comments/comment.d.ts +23 -37
- package/dist/lib/models/comments/comment.js +388 -325
- package/dist/lib/models/comments/index.d.ts +2 -2
- package/dist/lib/models/comments/index.js +1 -6
- package/dist/lib/models/index.d.ts +7 -7
- package/dist/lib/models/index.js +7 -23
- package/dist/lib/models/reflections/ReflectionSymbolId.d.ts +2 -2
- package/dist/lib/models/reflections/ReflectionSymbolId.js +42 -34
- package/dist/lib/models/reflections/abstract.d.ts +17 -20
- package/dist/lib/models/reflections/abstract.js +249 -256
- package/dist/lib/models/reflections/container.d.ts +7 -7
- package/dist/lib/models/reflections/container.js +43 -16
- package/dist/lib/models/reflections/declaration.d.ts +15 -12
- package/dist/lib/models/reflections/declaration.js +150 -29
- package/dist/lib/models/reflections/document.d.ts +3 -3
- package/dist/lib/models/reflections/document.js +26 -13
- package/dist/lib/models/reflections/index.d.ts +15 -15
- package/dist/lib/models/reflections/index.js +12 -31
- package/dist/lib/models/reflections/kind.d.ts +1 -1
- package/dist/lib/models/reflections/kind.js +3 -6
- package/dist/lib/models/reflections/parameter.d.ts +5 -4
- package/dist/lib/models/reflections/parameter.js +11 -13
- package/dist/lib/models/reflections/project.d.ts +14 -9
- package/dist/lib/models/reflections/project.js +104 -56
- package/dist/lib/models/reflections/reference.d.ts +3 -3
- package/dist/lib/models/reflections/reference.js +6 -9
- package/dist/lib/models/reflections/signature.d.ts +8 -8
- package/dist/lib/models/reflections/signature.js +35 -14
- package/dist/lib/models/reflections/type-parameter.d.ts +5 -5
- package/dist/lib/models/reflections/type-parameter.js +9 -10
- package/dist/lib/models/reflections/utils.js +1 -4
- package/dist/lib/models/reflections/variant.d.ts +8 -7
- package/dist/lib/models/reflections/variant.js +1 -2
- package/dist/lib/models/sources/file.d.ts +2 -2
- package/dist/lib/models/sources/file.js +22 -5
- package/dist/lib/models/sources/index.d.ts +1 -1
- package/dist/lib/models/sources/index.js +1 -5
- package/dist/lib/models/types.d.ts +29 -16
- package/dist/lib/models/types.js +236 -151
- package/dist/lib/output/components.d.ts +5 -11
- package/dist/lib/output/components.js +84 -125
- package/dist/lib/output/events.d.ts +3 -3
- package/dist/lib/output/events.js +128 -94
- package/dist/lib/output/formatter.d.ts +84 -0
- package/dist/lib/output/formatter.js +624 -0
- package/dist/lib/output/index.d.ts +9 -8
- package/dist/lib/output/index.js +7 -19
- package/dist/lib/output/models/UrlMapping.d.ts +2 -2
- package/dist/lib/output/models/UrlMapping.js +4 -5
- package/dist/lib/output/output.d.ts +14 -0
- package/dist/lib/output/output.js +91 -0
- package/dist/lib/output/plugins/AssetsPlugin.d.ts +9 -8
- package/dist/lib/output/plugins/AssetsPlugin.js +64 -80
- package/dist/lib/output/plugins/HierarchyPlugin.d.ts +7 -0
- package/dist/lib/output/plugins/HierarchyPlugin.js +67 -0
- package/dist/lib/output/plugins/IconsPlugin.d.ts +3 -2
- package/dist/lib/output/plugins/IconsPlugin.js +28 -84
- package/dist/lib/output/plugins/JavascriptIndexPlugin.d.ts +9 -2
- package/dist/lib/output/plugins/JavascriptIndexPlugin.js +90 -96
- package/dist/lib/output/plugins/NavigationPlugin.d.ts +3 -2
- package/dist/lib/output/plugins/NavigationPlugin.js +22 -102
- package/dist/lib/output/plugins/SitemapPlugin.d.ts +3 -2
- package/dist/lib/output/plugins/SitemapPlugin.js +60 -120
- package/dist/lib/output/plugins/index.d.ts +7 -6
- package/dist/lib/output/plugins/index.js +7 -15
- package/dist/lib/output/renderer.d.ts +14 -13
- package/dist/lib/output/renderer.js +130 -185
- package/dist/lib/output/theme.d.ts +9 -5
- package/dist/lib/output/theme.js +14 -62
- package/dist/lib/output/themes/MarkedPlugin.d.ts +8 -9
- package/dist/lib/output/themes/MarkedPlugin.js +152 -117
- package/dist/lib/output/themes/default/DefaultTheme.d.ts +17 -29
- package/dist/lib/output/themes/default/DefaultTheme.js +334 -310
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts +63 -48
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.js +119 -95
- package/dist/lib/output/themes/default/Slugger.d.ts +13 -0
- package/dist/lib/output/themes/default/Slugger.js +46 -0
- package/dist/lib/output/themes/default/layouts/default.d.ts +5 -5
- package/dist/lib/output/themes/default/layouts/default.js +48 -36
- package/dist/lib/output/themes/default/partials/anchor-icon.d.ts +2 -2
- package/dist/lib/output/themes/default/partials/anchor-icon.js +4 -7
- package/dist/lib/output/themes/default/partials/breadcrumb.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/breadcrumb.js +4 -8
- package/dist/lib/output/themes/default/partials/comment.d.ts +6 -4
- package/dist/lib/output/themes/default/partials/comment.js +52 -29
- package/dist/lib/output/themes/default/partials/footer.d.ts +2 -2
- package/dist/lib/output/themes/default/partials/footer.js +11 -14
- package/dist/lib/output/themes/default/partials/header.d.ts +4 -4
- package/dist/lib/output/themes/default/partials/header.js +9 -13
- package/dist/lib/output/themes/default/partials/hierarchy.d.ts +4 -4
- package/dist/lib/output/themes/default/partials/hierarchy.js +12 -15
- package/dist/lib/output/themes/default/partials/icon.d.ts +4 -4
- package/dist/lib/output/themes/default/partials/icon.js +78 -73
- package/dist/lib/output/themes/default/partials/index.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/index.js +19 -22
- package/dist/lib/output/themes/default/partials/member.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/member.declaration.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/member.declaration.js +18 -61
- package/dist/lib/output/themes/default/partials/member.getterSetter.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/member.getterSetter.js +10 -26
- package/dist/lib/output/themes/default/partials/member.js +19 -24
- package/dist/lib/output/themes/default/partials/member.signature.body.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/member.signature.body.js +17 -21
- package/dist/lib/output/themes/default/partials/member.signature.title.d.ts +4 -7
- package/dist/lib/output/themes/default/partials/member.signature.title.js +8 -35
- package/dist/lib/output/themes/default/partials/member.signatures.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/member.signatures.js +9 -13
- package/dist/lib/output/themes/default/partials/member.sources.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/member.sources.js +13 -17
- package/dist/lib/output/themes/default/partials/members.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/members.js +10 -42
- package/dist/lib/output/themes/default/partials/moduleReflection.d.ts +5 -0
- package/dist/lib/output/themes/default/partials/moduleReflection.js +62 -0
- package/dist/lib/output/themes/default/partials/navigation.d.ts +4 -4
- package/dist/lib/output/themes/default/partials/navigation.js +51 -62
- package/dist/lib/output/themes/default/partials/reflectionPreview.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/reflectionPreview.js +12 -15
- package/dist/lib/output/themes/default/partials/toolbar.d.ts +4 -4
- package/dist/lib/output/themes/default/partials/toolbar.js +16 -20
- package/dist/lib/output/themes/default/partials/type.d.ts +4 -6
- package/dist/lib/output/themes/default/partials/type.js +8 -388
- package/dist/lib/output/themes/default/partials/typeAndParent.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/typeAndParent.js +11 -15
- package/dist/lib/output/themes/default/partials/typeDetails.d.ts +8 -0
- package/dist/lib/output/themes/default/partials/typeDetails.js +222 -0
- package/dist/lib/output/themes/default/partials/typeParameters.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/typeParameters.js +14 -17
- package/dist/lib/output/themes/default/templates/document.d.ts +4 -4
- package/dist/lib/output/themes/default/templates/document.js +3 -7
- package/dist/lib/output/themes/default/templates/hierarchy.d.ts +4 -4
- package/dist/lib/output/themes/default/templates/hierarchy.js +24 -22
- package/dist/lib/output/themes/default/templates/index.d.ts +4 -4
- package/dist/lib/output/themes/default/templates/index.js +3 -7
- package/dist/lib/output/themes/default/templates/reflection.d.ts +4 -4
- package/dist/lib/output/themes/default/templates/reflection.js +32 -34
- package/dist/lib/output/themes/lib.d.ts +17 -3
- package/dist/lib/output/themes/lib.js +118 -50
- package/dist/lib/serialization/components.d.ts +2 -5
- package/dist/lib/serialization/components.js +1 -2
- package/dist/lib/serialization/deserializer.d.ts +21 -7
- package/dist/lib/serialization/deserializer.js +138 -123
- package/dist/lib/serialization/events.d.ts +2 -2
- package/dist/lib/serialization/events.js +6 -5
- package/dist/lib/serialization/index.d.ts +5 -5
- package/dist/lib/serialization/index.js +4 -33
- package/dist/lib/serialization/schema.d.ts +8 -2
- package/dist/lib/serialization/schema.js +2 -2
- package/dist/lib/serialization/serializer.d.ts +11 -5
- package/dist/lib/serialization/serializer.js +32 -25
- package/dist/lib/utils/array.d.ts +3 -0
- package/dist/lib/utils/array.js +26 -27
- package/dist/lib/utils/component.d.ts +2 -44
- package/dist/lib/utils/component.js +10 -102
- package/dist/lib/utils/entry-point.d.ts +3 -4
- package/dist/lib/utils/entry-point.js +114 -85
- package/dist/lib/utils/enum.js +6 -14
- package/dist/lib/utils/events.js +6 -12
- package/dist/lib/utils/fs.js +50 -91
- package/dist/lib/utils/general.d.ts +2 -1
- package/dist/lib/utils/general.js +50 -40
- package/dist/lib/utils/highlighter.js +30 -57
- package/dist/lib/utils/hooks.js +7 -13
- package/dist/lib/utils/html-entities.d.ts +8926 -0
- package/dist/lib/utils/html-entities.js +2329 -0
- package/dist/lib/utils/html.d.ts +8 -0
- package/dist/lib/utils/html.js +81 -34
- package/dist/lib/utils/index.d.ts +22 -22
- package/dist/lib/utils/index.js +20 -91
- package/dist/lib/utils/jsx.d.ts +12 -6
- package/dist/lib/utils/jsx.elements.d.ts +1 -1
- package/dist/lib/utils/jsx.elements.js +3 -4
- package/dist/lib/utils/jsx.js +82 -52
- package/dist/lib/utils/loggers.d.ts +3 -3
- package/dist/lib/utils/loggers.js +36 -46
- package/dist/lib/utils/map.js +6 -13
- package/dist/lib/utils/minimalSourceFile.js +5 -7
- package/dist/lib/utils/options/declaration.d.ts +35 -7
- package/dist/lib/utils/options/declaration.js +20 -22
- package/dist/lib/utils/options/defaults.d.ts +3 -2
- package/dist/lib/utils/options/defaults.js +18 -38
- package/dist/lib/utils/options/help.d.ts +2 -2
- package/dist/lib/utils/options/help.js +7 -10
- package/dist/lib/utils/options/index.d.ts +6 -6
- package/dist/lib/utils/options/index.js +4 -18
- package/dist/lib/utils/options/options.d.ts +8 -5
- package/dist/lib/utils/options/options.js +47 -71
- package/dist/lib/utils/options/readers/arguments.d.ts +2 -2
- package/dist/lib/utils/options/readers/arguments.js +15 -17
- package/dist/lib/utils/options/readers/index.d.ts +4 -4
- package/dist/lib/utils/options/readers/index.js +4 -11
- package/dist/lib/utils/options/readers/package-json.d.ts +3 -3
- package/dist/lib/utils/options/readers/package-json.js +15 -21
- package/dist/lib/utils/options/readers/tsconfig.d.ts +2 -2
- package/dist/lib/utils/options/readers/tsconfig.js +54 -63
- package/dist/lib/utils/options/readers/typedoc.d.ts +3 -3
- package/dist/lib/utils/options/readers/typedoc.js +44 -76
- package/dist/lib/utils/options/sources/index.d.ts +1 -1
- package/dist/lib/utils/options/sources/index.js +1 -5
- package/dist/lib/utils/options/sources/typedoc.d.ts +1 -1
- package/dist/lib/utils/options/sources/typedoc.js +232 -196
- package/dist/lib/utils/options/tsdoc-defaults.d.ts +3 -3
- package/dist/lib/utils/options/tsdoc-defaults.js +16 -12
- package/dist/lib/utils/package-manifest.d.ts +1 -1
- package/dist/lib/utils/package-manifest.js +15 -19
- package/dist/lib/utils/paths.js +9 -15
- package/dist/lib/utils/perf.js +6 -11
- package/dist/lib/utils/plugins.d.ts +1 -1
- package/dist/lib/utils/plugins.js +7 -10
- package/dist/lib/utils/reflections.d.ts +1 -1
- package/dist/lib/utils/reflections.js +9 -12
- package/dist/lib/utils/set.js +2 -6
- package/dist/lib/utils/sort.d.ts +3 -3
- package/dist/lib/utils/sort.js +20 -24
- package/dist/lib/utils/tsconfig.d.ts +1 -1
- package/dist/lib/utils/tsconfig.js +13 -21
- package/dist/lib/utils/tsutils.d.ts +1 -1
- package/dist/lib/utils/tsutils.js +3 -30
- package/dist/lib/utils/validation.js +6 -12
- package/dist/lib/validation/documentation.d.ts +2 -2
- package/dist/lib/validation/documentation.js +26 -29
- package/dist/lib/validation/exports.d.ts +2 -2
- package/dist/lib/validation/exports.js +9 -11
- package/dist/lib/validation/links.d.ts +2 -2
- package/dist/lib/validation/links.js +4 -7
- package/dist/lib/validation/unusedMergeModuleWith.d.ts +3 -0
- package/dist/lib/validation/unusedMergeModuleWith.js +11 -0
- package/package.json +17 -14
- package/static/main.js +4 -4
- package/static/style.css +109 -17
- package/tsdoc.json +30 -0
- package/dist/lib/output/themes/default/partials/member.reference.d.ts +0 -4
- package/dist/lib/output/themes/default/partials/member.reference.js +0 -30
- package/dist/lib/output/themes/default/partials/parameter.d.ts +0 -4
- package/dist/lib/output/themes/default/partials/parameter.js +0 -79
- package/dist/lib/utils/html-entities.json +0 -2326
|
@@ -1,2 +1,343 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
declare const _default: {
|
|
2
|
+
readonly loaded_multiple_times_0: "TypeDoc has been loaded multiple times. This is commonly caused by plugins which have their own installation of TypeDoc. The loaded paths are:\n\t{0}";
|
|
3
|
+
readonly unsupported_ts_version_0: "You are running with an unsupported TypeScript version! If TypeDoc crashes, this is why. TypeDoc supports {0}";
|
|
4
|
+
readonly no_compiler_options_set: "No compiler options set. This likely means that TypeDoc did not find your tsconfig.json. Generated documentation will probably be empty";
|
|
5
|
+
readonly loaded_plugin_0: "Loaded plugin {0}";
|
|
6
|
+
readonly solution_not_supported_in_watch_mode: "The provided tsconfig file looks like a solution style tsconfig, which is not supported in watch mode";
|
|
7
|
+
readonly strategy_not_supported_in_watch_mode: "entryPointStrategy must be set to either resolve or expand for watch mode";
|
|
8
|
+
readonly found_0_errors_and_1_warnings: "Found {0} errors and {1} warnings";
|
|
9
|
+
readonly output_0_could_not_be_generated: "{0} output could not be generated due to the errors above";
|
|
10
|
+
readonly output_0_generated_at_1: "{0} generated at {1}";
|
|
11
|
+
readonly no_entry_points_for_packages: "No entry points provided to packages mode, documentation cannot be generated";
|
|
12
|
+
readonly failed_to_find_packages: "Failed to find any packages, ensure you have provided at least one directory as an entry point containing package.json";
|
|
13
|
+
readonly nested_packages_unsupported_0: "Project at {0} has entryPointStrategy set to packages, but nested packages are not supported";
|
|
14
|
+
readonly previous_error_occurred_when_reading_options_for_0: "The previous error occurred when reading options for the package at {0}";
|
|
15
|
+
readonly converting_project_at_0: "Converting project at {0}";
|
|
16
|
+
readonly failed_to_convert_packages: "Failed to convert one or more packages, result will not be merged together";
|
|
17
|
+
readonly merging_converted_projects: "Merging converted projects";
|
|
18
|
+
readonly no_entry_points_to_merge: "No entry points provided to merge";
|
|
19
|
+
readonly entrypoint_did_not_match_files_0: "The entrypoint glob {0} did not match any files";
|
|
20
|
+
readonly failed_to_parse_json_0: "Failed to parse file at {0} as json";
|
|
21
|
+
readonly failed_to_read_0_when_processing_document_tag_in_1: "Failed to read file {0} when processing @document tag for comment in {1}";
|
|
22
|
+
readonly failed_to_read_0_when_processing_project_document: "Failed to read file {0} when adding project document";
|
|
23
|
+
readonly failed_to_read_0_when_processing_document_child_in_1: "Failed to read file {0} when processing document children in {1}";
|
|
24
|
+
readonly frontmatter_children_0_should_be_an_array_of_strings_or_object_with_string_values: "Frontmatter children in {0} should be an array of strings or an object with string values";
|
|
25
|
+
readonly converting_union_as_interface: "Using @interface on a union type will discard properties not present on all branches of the union. TypeDoc's output may not accurately describe your source code";
|
|
26
|
+
readonly converting_0_as_class_requires_value_declaration: "Converting {0} as a class requires a declaration which represents a non-type value";
|
|
27
|
+
readonly converting_0_as_class_without_construct_signatures: "{0} is being converted as a class, but does not have any construct signatures";
|
|
28
|
+
readonly comment_for_0_should_not_contain_block_or_modifier_tags: "The comment for {0} should not contain any block or modifier tags";
|
|
29
|
+
readonly symbol_0_has_multiple_declarations_with_comment: "{0} has multiple declarations with a comment. An arbitrary comment will be used";
|
|
30
|
+
readonly comments_for_0_are_declared_at_1: "The comments for {0} are declared at:\n\t{1}";
|
|
31
|
+
readonly multiple_type_parameters_on_template_tag_unsupported: "TypeDoc does not support multiple type parameters defined in a single @template tag with a comment";
|
|
32
|
+
readonly failed_to_find_jsdoc_tag_for_name_0: "Failed to find JSDoc tag for {0} after parsing comment, please file a bug report";
|
|
33
|
+
readonly relative_path_0_is_not_a_file_and_will_not_be_copied_to_output: "The relative path {0} is not a file and will not be copied to the output directory";
|
|
34
|
+
readonly inline_inheritdoc_should_not_appear_in_block_tag_in_comment_at_0: "An inline @inheritDoc tag should not appear within a block tag as it will not be processed in comment at {0}";
|
|
35
|
+
readonly at_most_one_remarks_tag_expected_in_comment_at_0: "At most one @remarks tag is expected in a comment, ignoring all but the first in comment at {0}";
|
|
36
|
+
readonly at_most_one_returns_tag_expected_in_comment_at_0: "At most one @returns tag is expected in a comment, ignoring all but the first in comment at {0}";
|
|
37
|
+
readonly at_most_one_inheritdoc_tag_expected_in_comment_at_0: "At most one @inheritDoc tag is expected in a comment, ignoring all but the first in comment at {0}";
|
|
38
|
+
readonly content_in_summary_overwritten_by_inheritdoc_in_comment_at_0: "Content in the summary section will be overwritten by the @inheritDoc tag in comment at {0}";
|
|
39
|
+
readonly content_in_remarks_block_overwritten_by_inheritdoc_in_comment_at_0: "Content in the @remarks block will be overwritten by the @inheritDoc tag in comment at {0}";
|
|
40
|
+
readonly example_tag_literal_name: "The first line of an example tag will be taken literally as the example name, and should only contain text";
|
|
41
|
+
readonly inheritdoc_tag_properly_capitalized: "The @inheritDoc tag should be properly capitalized";
|
|
42
|
+
readonly treating_unrecognized_tag_0_as_modifier: "Treating unrecognized tag {0} as a modifier tag";
|
|
43
|
+
readonly unmatched_closing_brace: "Unmatched closing brace";
|
|
44
|
+
readonly unescaped_open_brace_without_inline_tag: "Encountered an unescaped open brace without an inline tag";
|
|
45
|
+
readonly unknown_block_tag_0: "Encountered an unknown block tag {0}";
|
|
46
|
+
readonly unknown_inline_tag_0: "Encountered an unknown inline tag {0}";
|
|
47
|
+
readonly open_brace_within_inline_tag: "Encountered an open brace within an inline tag, this is likely a mistake";
|
|
48
|
+
readonly inline_tag_not_closed: "Inline tag is not closed";
|
|
49
|
+
readonly failed_to_resolve_link_to_0_in_comment_for_1: "Failed to resolve link to \"{0}\" in comment for {1}";
|
|
50
|
+
readonly failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2: "Failed to resolve link to \"{0}\" in comment for {1}. You may have wanted \"{2}\"";
|
|
51
|
+
readonly failed_to_resolve_link_to_0_in_readme_for_1: "Failed to resolve link to \"{0}\" in readme for {1}";
|
|
52
|
+
readonly failed_to_resolve_link_to_0_in_readme_for_1_may_have_meant_2: "Failed to resolve link to \"{0}\" in readme for {1}. You may have wanted \"{2}\"";
|
|
53
|
+
readonly failed_to_resolve_link_to_0_in_document_1: "Failed to resolve link to \"{0}\" in document {1}";
|
|
54
|
+
readonly failed_to_resolve_link_to_0_in_document_1_may_have_meant_2: "Failed to resolve link to \"{0}\" in document {1}. You may have wanted \"{2}\"";
|
|
55
|
+
readonly type_0_defined_in_1_is_referenced_by_2_but_not_included_in_docs: "{0}, defined in {1}, is referenced by {2} but not included in the documentation";
|
|
56
|
+
readonly reflection_0_kind_1_defined_in_2_does_not_have_any_documentation: "{0} ({1}), defined in {2}, does not have any documentation";
|
|
57
|
+
readonly invalid_intentionally_not_exported_symbols_0: "The following symbols were marked as intentionally not exported, but were either not referenced in the documentation, or were exported:\n\t{0}";
|
|
58
|
+
readonly reflection_0_has_unused_mergeModuleWith_tag: "{0} has a @mergeModuleWith tag which could not be resolved";
|
|
59
|
+
readonly not_all_search_category_boosts_used_0: "Not all categories specified in searchCategoryBoosts were used in the documentation. The unused categories were:\n\t{0}";
|
|
60
|
+
readonly not_all_search_group_boosts_used_0: "Not all groups specified in searchGroupBoosts were used in the documentation. The unused groups were:\n\t{0}";
|
|
61
|
+
readonly comment_for_0_includes_categoryDescription_for_1_but_no_child_in_group: "Comment for {0} includes @categoryDescription for \"{1}\", but no child is placed in that category";
|
|
62
|
+
readonly comment_for_0_includes_groupDescription_for_1_but_no_child_in_group: "Comment for {0} includes @groupDescription for \"{1}\", but no child is placed in that group";
|
|
63
|
+
readonly label_0_for_1_cannot_be_referenced: "The label \"{0}\" for {1} cannot be referenced with a declaration reference. Labels may only contain A-Z, 0-9, and _, and may not start with a number";
|
|
64
|
+
readonly modifier_tag_0_is_mutually_exclusive_with_1_in_comment_for_2: "The modifier tag {0} is mutually exclusive with {1} in the comment for {2}";
|
|
65
|
+
readonly signature_0_has_unused_param_with_name_1: "The signature {0} has an @param with name \"{1}\", which was not used";
|
|
66
|
+
readonly declaration_reference_in_inheritdoc_for_0_not_fully_parsed: "Declaration reference in @inheritDoc for {0} was not fully parsed and may resolve incorrectly";
|
|
67
|
+
readonly failed_to_find_0_to_inherit_comment_from_in_1: "Failed to find \"{0}\" to inherit the comment from in the comment for {1}";
|
|
68
|
+
readonly reflection_0_tried_to_copy_comment_from_1_but_source_had_no_comment: "{0} tried to copy a comment from {1} with @inheritDoc, but the source has no associated comment";
|
|
69
|
+
readonly inheritdoc_circular_inheritance_chain_0: "@inheritDoc specifies a circular inheritance chain: {0}";
|
|
70
|
+
readonly provided_readme_at_0_could_not_be_read: "Provided README path, {0} could not be read";
|
|
71
|
+
readonly defaulting_project_name: "The --name option was not specified, and no package.json was found. Defaulting project name to \"Documentation\"";
|
|
72
|
+
readonly disable_git_set_but_not_source_link_template: "disableGit is set, but sourceLinkTemplate is not, so source links cannot be produced. Set a sourceLinkTemplate or disableSources to prevent source tracking";
|
|
73
|
+
readonly disable_git_set_and_git_revision_used: "disableGit is set and sourceLinkTemplate contains {gitRevision}, which will be replaced with an empty string as no revision was provided";
|
|
74
|
+
readonly git_remote_0_not_valid: "The provided git remote \"{0}\" was not valid. Source links will be broken";
|
|
75
|
+
readonly reflection_0_tried_to_merge_into_child_1: "The reflection {0} tried to use @mergeModuleWith to merge into one of its children: {1}";
|
|
76
|
+
readonly include_0_in_1_specified_2_resolved_to_3_does_not_exist: "{0} tag in comment for {1} specified \"{2}\" to include, which was resolved to \"{3}\" and does not exist or is not a file.";
|
|
77
|
+
readonly include_0_in_1_specified_2_circular_include_3: "{0} tag in comment for {1} specified \"{2}\" to include, which resulted in a circular include:\n\t{3}";
|
|
78
|
+
readonly custom_css_file_0_does_not_exist: "Custom CSS file at {0} does not exist";
|
|
79
|
+
readonly custom_js_file_0_does_not_exist: "Custom JavaScript file at {0} does not exist";
|
|
80
|
+
readonly unsupported_highlight_language_0_not_highlighted_in_comment_for_1: "Unsupported highlight language {0} will not be highlighted in comment for {1}";
|
|
81
|
+
readonly unloaded_language_0_not_highlighted_in_comment_for_1: "Code block with language {0} will not be highlighted in comment for {1} as it was not included in the highlightLanguages option";
|
|
82
|
+
readonly yaml_frontmatter_not_an_object: "Expected YAML frontmatter to be an object";
|
|
83
|
+
readonly could_not_write_0: "Could not write {0}";
|
|
84
|
+
readonly could_not_empty_output_directory_0: "Could not empty the output directory {0}";
|
|
85
|
+
readonly could_not_create_output_directory_0: "Could not create the output directory {0}";
|
|
86
|
+
readonly theme_0_is_not_defined_available_are_1: "The theme '{0}' is not defined. The available themes are: {1}";
|
|
87
|
+
readonly reflection_0_links_to_1_but_anchor_does_not_exist_try_2: "{0} links to {1}, but the anchor does not exist. You may have meant:\n\t{2}";
|
|
88
|
+
readonly no_entry_points_provided: "No entry points were provided or discovered from package.json exports, this is likely a misconfiguration";
|
|
89
|
+
readonly unable_to_find_any_entry_points: "Unable to find any entry points. See previous warnings";
|
|
90
|
+
readonly watch_does_not_support_packages_mode: "Watch mode does not support 'packages' style entry points";
|
|
91
|
+
readonly watch_does_not_support_merge_mode: "Watch mode does not support 'merge' style entry points";
|
|
92
|
+
readonly entry_point_0_not_in_program: "The entry point {0} is not referenced by the 'files' or 'include' option in your tsconfig";
|
|
93
|
+
readonly failed_to_resolve_0_to_ts_path: "Failed to resolve entry point path {0} from package.json to a TypeScript source file";
|
|
94
|
+
readonly use_expand_or_glob_for_files_in_dir: "If you wanted to include files inside this directory, set --entryPointStrategy to expand or specify a glob";
|
|
95
|
+
readonly glob_0_did_not_match_any_files: "The glob {0} did not match any files";
|
|
96
|
+
readonly entry_point_0_did_not_match_any_files_after_exclude: "The glob {0} did not match any files after applying exclude patterns";
|
|
97
|
+
readonly entry_point_0_did_not_exist: "Provided entry point {0} does not exist";
|
|
98
|
+
readonly entry_point_0_did_not_match_any_packages: "The entry point glob {0} did not match any directories containing package.json";
|
|
99
|
+
readonly file_0_not_an_object: "The file {0} is not an object";
|
|
100
|
+
readonly serialized_project_referenced_0_not_part_of_project: "Serialized project referenced reflection {0}, which was not a part of the project";
|
|
101
|
+
readonly saved_relative_path_0_resolved_from_1_is_not_a_file: "Serialized project referenced {0}, which does not exist relative to {1}";
|
|
102
|
+
readonly circular_reference_extends_0: "Circular reference encountered for \"extends\" field of {0}";
|
|
103
|
+
readonly failed_resolve_0_to_file_in_1: "Failed to resolve {0} to a file in {1}";
|
|
104
|
+
readonly option_0_can_only_be_specified_by_config_file: "The '{0}' option can only be specified via a config file";
|
|
105
|
+
readonly option_0_expected_a_value_but_none_provided: "--{0} expected a value, but none was given as an argument";
|
|
106
|
+
readonly unknown_option_0_may_have_meant_1: "Unknown option: {0}, you may have meant:\n\t{1}";
|
|
107
|
+
readonly typedoc_key_in_0_ignored: "The 'typedoc' key in {0} was used by the legacy-packages entryPointStrategy and will be ignored";
|
|
108
|
+
readonly typedoc_options_must_be_object_in_0: "Failed to parse the \"typedocOptions\" field in {0}, ensure it exists and contains an object";
|
|
109
|
+
readonly tsconfig_file_0_does_not_exist: "The tsconfig file {0} does not exist";
|
|
110
|
+
readonly tsconfig_file_specifies_options_file: "\"typedocOptions\" in tsconfig file specifies an option file to read but the option file has already been read. This is likely a misconfiguration";
|
|
111
|
+
readonly tsconfig_file_specifies_tsconfig_file: "\"typedocOptions\" in tsconfig file may not specify a tsconfig file to read";
|
|
112
|
+
readonly tags_0_defined_in_typedoc_json_overwritten_by_tsdoc_json: "The {0} defined in typedoc.json will be overwritten by configuration in tsdoc.json";
|
|
113
|
+
readonly failed_read_tsdoc_json_0: "Failed to read tsdoc.json file at {0}";
|
|
114
|
+
readonly invalid_tsdoc_json_0: "The file {0} is not a valid tsdoc.json file";
|
|
115
|
+
readonly options_file_0_does_not_exist: "The options file {0} does not exist";
|
|
116
|
+
readonly failed_read_options_file_0: "Failed to parse {0}, ensure it exists and exports an object";
|
|
117
|
+
readonly invalid_plugin_0_missing_load_function: "Invalid structure in plugin {0}, no load function found";
|
|
118
|
+
readonly plugin_0_could_not_be_loaded: "The plugin {0} could not be loaded";
|
|
119
|
+
readonly help_options: "Specify a json option file that should be loaded. If not specified TypeDoc will look for 'typedoc.json' in the current directory";
|
|
120
|
+
readonly help_tsconfig: "Specify a TypeScript config file that should be loaded. If not specified TypeDoc will look for 'tsconfig.json' in the current directory";
|
|
121
|
+
readonly help_compilerOptions: "Selectively override the TypeScript compiler options used by TypeDoc";
|
|
122
|
+
readonly help_lang: "Sets the language to be used in generation and in TypeDoc's messages";
|
|
123
|
+
readonly help_locales: "Add translations for a specified locale. This option is primarily intended to be used as a stopgap while waiting for official locale support to be added to TypeDoc";
|
|
124
|
+
readonly help_packageOptions: "Set options which will be set within each package when entryPointStrategy is set to packages";
|
|
125
|
+
readonly help_entryPoints: "The entry points of your documentation";
|
|
126
|
+
readonly help_entryPointStrategy: "The strategy to be used to convert entry points into documentation modules";
|
|
127
|
+
readonly help_alwaysCreateEntryPointModule: "When set, TypeDoc will always create a `Module` for entry points, even if only one is provided";
|
|
128
|
+
readonly help_projectDocuments: "Documents which should be added as children to the root of the generated documentation. Supports globs to match multiple files";
|
|
129
|
+
readonly help_exclude: "Define patterns to be excluded when expanding a directory that was specified as an entry point";
|
|
130
|
+
readonly help_externalPattern: "Define patterns for files that should be considered being external";
|
|
131
|
+
readonly help_excludeExternals: "Prevent externally resolved symbols from being documented";
|
|
132
|
+
readonly help_excludeNotDocumented: "Prevent symbols that are not explicitly documented from appearing in the results";
|
|
133
|
+
readonly help_excludeNotDocumentedKinds: "Specify the type of reflections that can be removed by excludeNotDocumented";
|
|
134
|
+
readonly help_excludeInternal: "Prevent symbols that are marked with @internal from being documented";
|
|
135
|
+
readonly help_excludeCategories: "Exclude symbols within this category from the documentation";
|
|
136
|
+
readonly help_excludePrivate: "Ignore private variables and methods, defaults to true.";
|
|
137
|
+
readonly help_excludeProtected: "Ignore protected variables and methods";
|
|
138
|
+
readonly help_excludeReferences: "If a symbol is exported multiple times, ignore all but the first export";
|
|
139
|
+
readonly help_externalSymbolLinkMappings: "Define custom links for symbols not included in the documentation";
|
|
140
|
+
readonly help_out: "Specify the location the documentation for the default output should be written to. The default output type may be changed by plugins.";
|
|
141
|
+
readonly help_html: "Specify the location where html documentation should be written to.";
|
|
142
|
+
readonly help_json: "Specify the location and filename a JSON file describing the project is written to";
|
|
143
|
+
readonly help_pretty: "Specify whether the output JSON should be formatted with tabs";
|
|
144
|
+
readonly help_emit: "Specify what TypeDoc should emit, 'docs', 'both', or 'none'";
|
|
145
|
+
readonly help_theme: "Specify the theme name to render the documentation with";
|
|
146
|
+
readonly help_lightHighlightTheme: "Specify the code highlighting theme in light mode";
|
|
147
|
+
readonly help_darkHighlightTheme: "Specify the code highlighting theme in dark mode";
|
|
148
|
+
readonly help_highlightLanguages: "Specify the languages which will be loaded to highlight code when rendering";
|
|
149
|
+
readonly help_typePrintWidth: "Width at which to wrap code to a new line when rendering a type";
|
|
150
|
+
readonly help_customCss: "Path to a custom CSS file to for the theme to import";
|
|
151
|
+
readonly help_customJs: "Path to a custom JS file to import";
|
|
152
|
+
readonly help_markdownItOptions: "Specify the options passed to markdown-it, the Markdown parser used by TypeDoc";
|
|
153
|
+
readonly help_markdownItLoader: "Specify a callback to be called when loading the markdown-it instance. Will be passed the instance of the parser which TypeDoc will use";
|
|
154
|
+
readonly help_maxTypeConversionDepth: "Set the maximum depth of types to be converted";
|
|
155
|
+
readonly help_name: "Set the name of the project that will be used in the header of the template";
|
|
156
|
+
readonly help_includeVersion: "Add the package version to the project name";
|
|
157
|
+
readonly help_disableSources: "Disable setting the source of a reflection when documenting it";
|
|
158
|
+
readonly help_sourceLinkTemplate: "Specify a link template to be used when generating source urls. If not set, will be automatically created using the git remote. Supports {path}, {line}, {gitRevision} placeholders";
|
|
159
|
+
readonly help_gitRevision: "Use specified revision instead of the last revision for linking to GitHub/Bitbucket source files. Has no effect if disableSources is set";
|
|
160
|
+
readonly help_gitRemote: "Use the specified remote for linking to GitHub/Bitbucket source files. Has no effect if disableGit or disableSources is set";
|
|
161
|
+
readonly help_disableGit: "Assume that all can be linked to with the sourceLinkTemplate, sourceLinkTemplate must be set if this is enabled. {path} will be rooted at basePath";
|
|
162
|
+
readonly help_basePath: "Specifies the base path to be used when displaying file paths";
|
|
163
|
+
readonly help_excludeTags: "Remove the listed block/modifier tags from doc comments";
|
|
164
|
+
readonly help_notRenderedTags: "Tags which will be preserved in doc comments, but not rendered when creating output";
|
|
165
|
+
readonly help_readme: "Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page and start the documentation on the globals page";
|
|
166
|
+
readonly help_cname: "Set the CNAME file text, it's useful for custom domains on GitHub Pages";
|
|
167
|
+
readonly help_favicon: "Path to a favicon.ico or favicon.svg to include as the site icon";
|
|
168
|
+
readonly help_sourceLinkExternal: "Specifies that source links should be treated as external links to be opened in a new tab";
|
|
169
|
+
readonly help_markdownLinkExternal: "Specifies that http[s]:// links in comments and markdown files should be treated as external links to be opened in a new tab";
|
|
170
|
+
readonly help_githubPages: "Generate a .nojekyll file to prevent 404 errors in GitHub Pages. Defaults to `true`";
|
|
171
|
+
readonly help_hostedBaseUrl: "Specify a base URL to be used in generating a sitemap.xml in our output folder and canonical links. If not specified, no sitemap will be generated";
|
|
172
|
+
readonly help_useHostedBaseUrlForAbsoluteLinks: "If set, TypeDoc will produce absolute links to pages on your site using the hostedBaseUrl option";
|
|
173
|
+
readonly help_hideGenerator: "Do not print the TypeDoc link at the end of the page";
|
|
174
|
+
readonly help_customFooterHtml: "Custom footer after the TypeDoc link";
|
|
175
|
+
readonly help_customFooterHtmlDisableWrapper: "If set, disables the wrapper element for customFooterHtml";
|
|
176
|
+
readonly help_cacheBust: "Include the generation time in links to static assets";
|
|
177
|
+
readonly help_searchInComments: "If set, the search index will also include comments. This will greatly increase the size of the search index";
|
|
178
|
+
readonly help_searchInDocuments: "If set, the search index will also include documents. This will greatly increase the size of the search index";
|
|
179
|
+
readonly help_cleanOutputDir: "If set, TypeDoc will remove the output directory before writing output";
|
|
180
|
+
readonly help_titleLink: "Set the link the title in the header points to. Defaults to the documentation homepage";
|
|
181
|
+
readonly help_navigationLinks: "Defines links to be included in the header";
|
|
182
|
+
readonly help_sidebarLinks: "Defines links to be included in the sidebar";
|
|
183
|
+
readonly help_navigationLeaves: "Branches of the navigation tree which should not be expanded";
|
|
184
|
+
readonly help_headings: "Determines which optional headings are rendered";
|
|
185
|
+
readonly help_sluggerConfiguration: "Determines how anchors within rendered HTML are determined.";
|
|
186
|
+
readonly help_navigation: "Determines how the navigation sidebar is organized";
|
|
187
|
+
readonly help_includeHierarchySummary: "If set, a reflections hierarchy summary will be rendered to a summary page. Defaults to `true`";
|
|
188
|
+
readonly help_visibilityFilters: "Specify the default visibility for builtin filters and additional filters according to modifier tags";
|
|
189
|
+
readonly help_searchCategoryBoosts: "Configure search to give a relevance boost to selected categories";
|
|
190
|
+
readonly help_searchGroupBoosts: "Configure search to give a relevance boost to selected kinds (eg \"class\")";
|
|
191
|
+
readonly help_useFirstParagraphOfCommentAsSummary: "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";
|
|
192
|
+
readonly help_jsDocCompatibility: "Sets compatibility options for comment parsing that increase similarity with JSDoc comments";
|
|
193
|
+
readonly help_commentStyle: "Determines how TypeDoc searches for comments";
|
|
194
|
+
readonly help_useTsLinkResolution: "Use TypeScript's link resolution when determining where @link tags point. This only applies to JSDoc style comments";
|
|
195
|
+
readonly help_preserveLinkText: "If set, @link tags without link text will use the text content as the link. If not set, will use the target reflection name";
|
|
196
|
+
readonly help_blockTags: "Block tags which TypeDoc should recognize when parsing comments";
|
|
197
|
+
readonly help_inlineTags: "Inline tags which TypeDoc should recognize when parsing comments";
|
|
198
|
+
readonly help_modifierTags: "Modifier tags which TypeDoc should recognize when parsing comments";
|
|
199
|
+
readonly help_categorizeByGroup: "Specify whether categorization will be done at the group level";
|
|
200
|
+
readonly help_groupReferencesByType: "If set, references will be grouped with the type they refer to rather than in a 'References' group";
|
|
201
|
+
readonly help_defaultCategory: "Specify the default category for reflections without a category";
|
|
202
|
+
readonly help_categoryOrder: "Specify the order in which categories appear. * indicates the relative order for categories not in the list";
|
|
203
|
+
readonly help_groupOrder: "Specify the order in which groups appear. * indicates the relative order for groups not in the list";
|
|
204
|
+
readonly help_sort: "Specify the sort strategy for documented values";
|
|
205
|
+
readonly help_sortEntryPoints: "If set, entry points will be subject to the same sorting rules as other reflections";
|
|
206
|
+
readonly help_kindSortOrder: "Specify the sort order for reflections when 'kind' is specified";
|
|
207
|
+
readonly help_watch: "Watch files for changes and rebuild docs on change";
|
|
208
|
+
readonly help_preserveWatchOutput: "If set, TypeDoc will not clear the screen between compilation runs";
|
|
209
|
+
readonly help_skipErrorChecking: "Do not run TypeScript's type checking before generating docs";
|
|
210
|
+
readonly help_help: "Print this message";
|
|
211
|
+
readonly help_version: "Print TypeDoc's version";
|
|
212
|
+
readonly help_showConfig: "Print the resolved configuration and exit";
|
|
213
|
+
readonly help_plugin: "Specify the npm plugins that should be loaded. Omit to load all installed plugins";
|
|
214
|
+
readonly help_logLevel: "Specify what level of logging should be used";
|
|
215
|
+
readonly help_treatWarningsAsErrors: "If set, all warnings will be treated as errors";
|
|
216
|
+
readonly help_treatValidationWarningsAsErrors: "If set, warnings emitted during validation will be treated as errors. This option cannot be used to disable treatWarningsAsErrors for validation warnings";
|
|
217
|
+
readonly help_intentionallyNotExported: "A list of types which should not produce 'referenced but not documented' warnings";
|
|
218
|
+
readonly help_requiredToBeDocumented: "A list of reflection kinds that must be documented";
|
|
219
|
+
readonly help_validation: "Specify which validation steps TypeDoc should perform on your generated documentation";
|
|
220
|
+
readonly unknown_option_0_you_may_have_meant_1: "Unknown option '{0}' You may have meant:\n\t{1}";
|
|
221
|
+
readonly option_0_must_be_between_1_and_2: "{0} must be between {1} and {2}";
|
|
222
|
+
readonly option_0_must_be_equal_to_or_greater_than_1: "{0} must be equal to or greater than {1}";
|
|
223
|
+
readonly option_0_must_be_less_than_or_equal_to_1: "{0} must be less than or equal to {1}";
|
|
224
|
+
readonly option_0_must_be_one_of_1: "{0} must be one of {1}";
|
|
225
|
+
readonly flag_0_is_not_valid_for_1_expected_2: "The flag '{0}' is not valid for {1}, expected one of {2}";
|
|
226
|
+
readonly expected_object_with_flag_values_for_0: "Expected an object with flag values for {0} or true/false";
|
|
227
|
+
readonly flag_values_for_0_must_be_booleans: "Flag values for {0} must be a boolean";
|
|
228
|
+
readonly locales_must_be_an_object: "The 'locales' option must be set to an object which resembles: { en: { theme_implements: \"Implements\" }}";
|
|
229
|
+
readonly exclude_not_documented_specified_0_valid_values_are_1: "excludeNotDocumentedKinds may only specify known values, and invalid values were provided ({0}). The valid kinds are:\n{1}";
|
|
230
|
+
readonly external_symbol_link_mappings_must_be_object: "externalSymbolLinkMappings must be a Record<package name, Record<symbol name, link>>";
|
|
231
|
+
readonly highlight_theme_0_must_be_one_of_1: "{0} must be one of the following: {1}";
|
|
232
|
+
readonly highlightLanguages_contains_invalid_languages_0: "highlightLanguages contains invalid languages: {0}, run typedoc --help for a list of supported languages";
|
|
233
|
+
readonly hostedBaseUrl_must_start_with_http: "hostedBaseUrl must start with http:// or https://";
|
|
234
|
+
readonly useHostedBaseUrlForAbsoluteLinks_requires_hostedBaseUrl: "The useHostedBaseUrlForAbsoluteLinks option requires that hostedBaseUrl be set";
|
|
235
|
+
readonly favicon_must_be_ico_or_svg: "Favicon file must be either a .ico or .svg";
|
|
236
|
+
readonly option_0_must_be_an_object: "The '{0}' option must be a non-array object";
|
|
237
|
+
readonly option_0_must_be_a_function: "The '{0}' option must be a function";
|
|
238
|
+
readonly option_0_must_be_object_with_urls: "{0} must be an object with string labels as keys and URL values";
|
|
239
|
+
readonly visibility_filters_only_include_0: "visibilityFilters can only include the following non-@ keys: {0}";
|
|
240
|
+
readonly visibility_filters_must_be_booleans: "All values of visibilityFilters must be booleans";
|
|
241
|
+
readonly option_0_values_must_be_numbers: "All values of {0} must be numbers";
|
|
242
|
+
readonly option_0_values_must_be_array_of_tags: "{0} must be an array of valid tag names";
|
|
243
|
+
readonly option_0_specified_1_but_only_2_is_valid: "{0} may only specify known values, and invalid values were provided ({1}). The valid sort strategies are:\n{2}";
|
|
244
|
+
readonly option_outputs_must_be_array: "\"outputs\" option must be an array of { name: string, path: string, options?: TypeDocOptions } values.";
|
|
245
|
+
readonly specified_output_0_has_not_been_defined: "Specified output \"{0}\" has not been defined.";
|
|
246
|
+
readonly alert_note: "Note";
|
|
247
|
+
readonly alert_tip: "Tip";
|
|
248
|
+
readonly alert_important: "Important";
|
|
249
|
+
readonly alert_warning: "Warning";
|
|
250
|
+
readonly alert_caution: "Caution";
|
|
251
|
+
readonly kind_project: "Project";
|
|
252
|
+
readonly kind_module: "Module";
|
|
253
|
+
readonly kind_namespace: "Namespace";
|
|
254
|
+
readonly kind_enum: "Enumeration";
|
|
255
|
+
readonly kind_enum_member: "Enumeration Member";
|
|
256
|
+
readonly kind_variable: "Variable";
|
|
257
|
+
readonly kind_function: "Function";
|
|
258
|
+
readonly kind_class: "Class";
|
|
259
|
+
readonly kind_interface: "Interface";
|
|
260
|
+
readonly kind_constructor: "Constructor";
|
|
261
|
+
readonly kind_property: "Property";
|
|
262
|
+
readonly kind_method: "Method";
|
|
263
|
+
readonly kind_call_signature: "Call Signature";
|
|
264
|
+
readonly kind_index_signature: "Index Signature";
|
|
265
|
+
readonly kind_constructor_signature: "Constructor Signature";
|
|
266
|
+
readonly kind_parameter: "Parameter";
|
|
267
|
+
readonly kind_type_literal: "Type Literal";
|
|
268
|
+
readonly kind_type_parameter: "Type Parameter";
|
|
269
|
+
readonly kind_accessor: "Accessor";
|
|
270
|
+
readonly kind_get_signature: "Get Signature";
|
|
271
|
+
readonly kind_set_signature: "Set Signature";
|
|
272
|
+
readonly kind_type_alias: "Type Alias";
|
|
273
|
+
readonly kind_reference: "Reference";
|
|
274
|
+
readonly kind_document: "Document";
|
|
275
|
+
readonly kind_plural_project: "Projects";
|
|
276
|
+
readonly kind_plural_module: "Modules";
|
|
277
|
+
readonly kind_plural_namespace: "Namespaces";
|
|
278
|
+
readonly kind_plural_enum: "Enumerations";
|
|
279
|
+
readonly kind_plural_enum_member: "Enumeration Members";
|
|
280
|
+
readonly kind_plural_variable: "Variables";
|
|
281
|
+
readonly kind_plural_function: "Functions";
|
|
282
|
+
readonly kind_plural_class: "Classes";
|
|
283
|
+
readonly kind_plural_interface: "Interfaces";
|
|
284
|
+
readonly kind_plural_constructor: "Constructors";
|
|
285
|
+
readonly kind_plural_property: "Properties";
|
|
286
|
+
readonly kind_plural_method: "Methods";
|
|
287
|
+
readonly kind_plural_call_signature: "Call Signatures";
|
|
288
|
+
readonly kind_plural_index_signature: "Index Signatures";
|
|
289
|
+
readonly kind_plural_constructor_signature: "Constructor Signatures";
|
|
290
|
+
readonly kind_plural_parameter: "Parameters";
|
|
291
|
+
readonly kind_plural_type_literal: "Type Literals";
|
|
292
|
+
readonly kind_plural_type_parameter: "Type Parameters";
|
|
293
|
+
readonly kind_plural_accessor: "Accessors";
|
|
294
|
+
readonly kind_plural_get_signature: "Get Signatures";
|
|
295
|
+
readonly kind_plural_set_signature: "Set Signatures";
|
|
296
|
+
readonly kind_plural_type_alias: "Type Aliases";
|
|
297
|
+
readonly kind_plural_reference: "References";
|
|
298
|
+
readonly kind_plural_document: "Documents";
|
|
299
|
+
readonly flag_private: "Private";
|
|
300
|
+
readonly flag_protected: "Protected";
|
|
301
|
+
readonly flag_public: "Public";
|
|
302
|
+
readonly flag_static: "Static";
|
|
303
|
+
readonly flag_external: "External";
|
|
304
|
+
readonly flag_optional: "Optional";
|
|
305
|
+
readonly flag_rest: "Rest";
|
|
306
|
+
readonly flag_abstract: "Abstract";
|
|
307
|
+
readonly flag_const: "Const";
|
|
308
|
+
readonly flag_readonly: "Readonly";
|
|
309
|
+
readonly flag_inherited: "Inherited";
|
|
310
|
+
readonly theme_implements: "Implements";
|
|
311
|
+
readonly theme_indexable: "Indexable";
|
|
312
|
+
readonly theme_type_declaration: "Type declaration";
|
|
313
|
+
readonly theme_index: "Index";
|
|
314
|
+
readonly theme_hierarchy: "Hierarchy";
|
|
315
|
+
readonly theme_hierarchy_summary: "Hierarchy Summary";
|
|
316
|
+
readonly theme_hierarchy_view_summary: "View Summary";
|
|
317
|
+
readonly theme_implemented_by: "Implemented by";
|
|
318
|
+
readonly theme_defined_in: "Defined in";
|
|
319
|
+
readonly theme_implementation_of: "Implementation of";
|
|
320
|
+
readonly theme_inherited_from: "Inherited from";
|
|
321
|
+
readonly theme_overrides: "Overrides";
|
|
322
|
+
readonly theme_returns: "Returns";
|
|
323
|
+
readonly theme_generated_using_typedoc: "Generated using TypeDoc";
|
|
324
|
+
readonly theme_preparing_search_index: "Preparing search index...";
|
|
325
|
+
readonly theme_search_index_not_available: "The search index is not available";
|
|
326
|
+
readonly theme_loading: "Loading...";
|
|
327
|
+
readonly theme_settings: "Settings";
|
|
328
|
+
readonly theme_member_visibility: "Member Visibility";
|
|
329
|
+
readonly theme_theme: "Theme";
|
|
330
|
+
readonly theme_os: "OS";
|
|
331
|
+
readonly theme_light: "Light";
|
|
332
|
+
readonly theme_dark: "Dark";
|
|
333
|
+
readonly theme_on_this_page: "On This Page";
|
|
334
|
+
readonly theme_search: "Search";
|
|
335
|
+
readonly theme_menu: "Menu";
|
|
336
|
+
readonly theme_permalink: "Permalink";
|
|
337
|
+
readonly theme_copy: "Copy";
|
|
338
|
+
readonly theme_copied: "Copied!";
|
|
339
|
+
readonly theme_normally_hidden: "This member is normally hidden due to your filter settings.";
|
|
340
|
+
readonly theme_hierarchy_expand: "Expand";
|
|
341
|
+
readonly theme_hierarchy_collapse: "Collapse";
|
|
342
|
+
};
|
|
343
|
+
export = _default;
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
|
|
3
|
-
|
|
2
|
+
// Please DO NOT include machine generated translations here.
|
|
3
|
+
// If adding a new key, leave it commented out for a native speaker
|
|
4
|
+
// to update.
|
|
5
|
+
const localeUtils = require("../locale-utils.cjs");
|
|
6
|
+
module.exports = localeUtils.buildIncompleteTranslation({
|
|
4
7
|
loaded_multiple_times_0: "TypeDoc が複数回読み込まれました。これは通常、TypeDoc を独自にインストールしたプラグインによって発生します。読み込まれたパスは次のとおりです:\n{0}",
|
|
5
8
|
unsupported_ts_version_0: "サポートされていない TypeScript バージョンで実行されています。TypeDoc がクラッシュした場合は、これが原因です。TypeDoc は {0} をサポートしています。",
|
|
6
9
|
no_compiler_options_set: "コンパイラオプションが設定されていません。これは、TypeDoc が tsconfig.json を見つけられなかったことを意味します。生成されたドキュメントはおそらく空になります。",
|
|
@@ -8,9 +11,8 @@ module.exports = (0, translatable_1.buildIncompleteTranslation)({
|
|
|
8
11
|
solution_not_supported_in_watch_mode: "提供された tsconfig ファイルはソリューション スタイルの tsconfig のように見えますが、これはウォッチ モードではサポートされていません。",
|
|
9
12
|
strategy_not_supported_in_watch_mode: "ウォッチモードの場合、entryPointStrategy は、resolve または expand のいずれかに設定する必要があります。",
|
|
10
13
|
found_0_errors_and_1_warnings: "{0} 件のエラーと {1} 件の警告が見つかりました",
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
json_written_to_0: "JSON が {0} に書き込まれました",
|
|
14
|
+
// output_0_could_not_be_generated
|
|
15
|
+
// output_0_generated_at_1
|
|
14
16
|
no_entry_points_for_packages: "パッケージ モードにエントリ ポイントが提供されていないため、ドキュメントを生成できません",
|
|
15
17
|
failed_to_find_packages: "パッケージが見つかりませんでした。package.json を含むエントリ ポイントとして少なくとも 1 つのディレクトリを指定していることを確認してください。",
|
|
16
18
|
nested_packages_unsupported_0: "{0} のプロジェクトでは entryPointStrategy がパッケージに設定されていますが、ネストされたパッケージはサポートされていません",
|
|
@@ -55,7 +57,7 @@ module.exports = (0, translatable_1.buildIncompleteTranslation)({
|
|
|
55
57
|
invalid_intentionally_not_exported_symbols_0: "次のシンボルは意図的にエクスポートされないものとしてマークされていますが、ドキュメントで参照されていないか、エクスポートされています:\n{0}",
|
|
56
58
|
not_all_search_category_boosts_used_0: "searchCategoryBoosts で指定されたすべてのカテゴリがドキュメントで使用されているわけではありません。使用されていないカテゴリは次のとおりです:\n{0}",
|
|
57
59
|
not_all_search_group_boosts_used_0: "searchGroupBoosts で指定されたすべてのグループがドキュメントで使用されているわけではありません。使用されていないグループは次のとおりです:\n{0}",
|
|
58
|
-
comment_for_0_includes_categoryDescription_for_1_but_no_child_in_group: "{0} のコメントに「{1}」の @
|
|
60
|
+
comment_for_0_includes_categoryDescription_for_1_but_no_child_in_group: "{0} のコメントに「{1}」の @categoryDescription が含まれていますが、そのカテゴリに子が配置されていません",
|
|
59
61
|
comment_for_0_includes_groupDescription_for_1_but_no_child_in_group: '{0} のコメントに "{1}" の @groupDescription が含まれていますが、そのグループには子が配置されていません',
|
|
60
62
|
label_0_for_1_cannot_be_referenced: '{1} のラベル "{0}" は宣言参照では参照できません。ラベルには A ~ Z、0 ~ 9、_ のみを含めることができ、数字で始まることはできません。',
|
|
61
63
|
failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2: `{1} のコメント内の "{0}" へのリンクを解決できません。"{2}" を意味していた可能性があります。`,
|
|
@@ -80,8 +82,7 @@ module.exports = (0, translatable_1.buildIncompleteTranslation)({
|
|
|
80
82
|
could_not_empty_output_directory_0: "出力ディレクトリ {0} を空にできませんでした",
|
|
81
83
|
could_not_create_output_directory_0: "出力ディレクトリ {0} を作成できませんでした",
|
|
82
84
|
theme_0_is_not_defined_available_are_1: "テーマ '{0}' は定義されていません。使用可能なテーマは次のとおりです: {1}",
|
|
83
|
-
|
|
84
|
-
no_entry_points_provided: "エントリポイントが提供されていません。これは設定ミスである可能性があります。",
|
|
85
|
+
// no_entry_points_provided:
|
|
85
86
|
unable_to_find_any_entry_points: "エントリ ポイントが見つかりません。以前の警告を参照してください",
|
|
86
87
|
watch_does_not_support_packages_mode: "ウォッチモードは「パッケージ」スタイルのエントリポイントをサポートしていません",
|
|
87
88
|
watch_does_not_support_merge_mode: "ウォッチモードでは「マージ」スタイルのエントリポイントはサポートされません",
|
|
@@ -132,7 +133,8 @@ module.exports = (0, translatable_1.buildIncompleteTranslation)({
|
|
|
132
133
|
help_excludeProtected: "保護された変数とメソッドを無視する",
|
|
133
134
|
help_excludeReferences: "シンボルが複数回エクスポートされた場合、最初のエクスポート以外はすべて無視されます。",
|
|
134
135
|
help_externalSymbolLinkMappings: "ドキュメントに含まれていないシンボルのカスタムリンクを定義する",
|
|
135
|
-
help_out
|
|
136
|
+
// help_out
|
|
137
|
+
// help_html
|
|
136
138
|
help_json: "プロジェクトを説明するJSONファイルが書き込まれる場所とファイル名を指定します",
|
|
137
139
|
help_pretty: "出力JSONをタブでフォーマットするかどうかを指定します",
|
|
138
140
|
help_emit: "TypeDoc が発行する内容を指定します (「docs」、「both」、または「none」)",
|
|
@@ -153,6 +155,7 @@ module.exports = (0, translatable_1.buildIncompleteTranslation)({
|
|
|
153
155
|
help_disableGit: "すべてが sourceLinkTemplate でリンクできると仮定します。これが有効な場合は、sourceLinkTemplate を設定する必要があります。{path} は basePath をルートとします。",
|
|
154
156
|
help_basePath: "ファイルパスを表示するときに使用するベースパスを指定します",
|
|
155
157
|
help_excludeTags: "ドキュメントコメントからリストされたブロック/修飾子タグを削除します",
|
|
158
|
+
// help_notRenderedTags
|
|
156
159
|
help_readme: "インデックス ページに表示される Readme ファイルへのパス。インデックス ページを無効にしてグローバル ページでドキュメントを開始するには、`none` を渡します。",
|
|
157
160
|
help_cname: "CNAMEファイルのテキストを設定します。これはGitHub Pagesのカスタムドメインに便利です。",
|
|
158
161
|
help_sourceLinkExternal: "ソースリンクを外部リンクとして扱い、新しいタブで開くように指定します。",
|
|
@@ -162,7 +165,7 @@ module.exports = (0, translatable_1.buildIncompleteTranslation)({
|
|
|
162
165
|
help_hideGenerator: "ページの最後にある TypeDoc リンクを印刷しないでください",
|
|
163
166
|
help_customFooterHtml: "TypeDoc リンクの後のカスタム フッター",
|
|
164
167
|
help_customFooterHtmlDisableWrapper: "設定されている場合、customFooterHtml のラッパー要素が無効になります。",
|
|
165
|
-
|
|
168
|
+
// help_hideTypesInSignatureTitle
|
|
166
169
|
help_cacheBust: "静的アセットへのリンクに生成時間を含める",
|
|
167
170
|
help_searchInComments: "設定すると、検索インデックスにコメントも含まれます。これにより、検索インデックスのサイズが大幅に増加します。",
|
|
168
171
|
help_searchInDocuments: "設定すると、検索インデックスにドキュメントも含まれます。これにより、検索インデックスのサイズが大幅に増加します。",
|
|
@@ -289,15 +292,12 @@ module.exports = (0, translatable_1.buildIncompleteTranslation)({
|
|
|
289
292
|
theme_type_declaration: "型宣言",
|
|
290
293
|
theme_index: "インデックス",
|
|
291
294
|
theme_hierarchy: "階層",
|
|
292
|
-
theme_hierarchy_view_full: "完全な階層を表示",
|
|
293
295
|
theme_implemented_by: "実装者",
|
|
294
296
|
theme_defined_in: "定義",
|
|
295
297
|
theme_implementation_of: "の実装",
|
|
296
298
|
theme_inherited_from: "継承元",
|
|
297
299
|
theme_overrides: "上書き",
|
|
298
300
|
theme_returns: "戻り値",
|
|
299
|
-
theme_re_exports: "再エクスポート",
|
|
300
|
-
theme_renames_and_re_exports: "リネームと再エクスポート",
|
|
301
301
|
theme_generated_using_typedoc: "TypeDocを使用して生成",
|
|
302
302
|
theme_preparing_search_index: "検索インデックスを準備しています...",
|
|
303
303
|
theme_search_index_not_available: "検索インデックスは利用できません",
|
|
@@ -317,6 +317,5 @@ module.exports = (0, translatable_1.buildIncompleteTranslation)({
|
|
|
317
317
|
theme_copy: "コピー",
|
|
318
318
|
theme_copied: "コピー完了!",
|
|
319
319
|
theme_normally_hidden: "このメンバーは、フィルター設定のため、通常は非表示になっています。",
|
|
320
|
-
theme_class_hierarchy_title: "クラス継承図",
|
|
321
320
|
theme_loading: "読み込み中...",
|
|
322
321
|
});
|