typedoc 0.24.0-beta.1 → 0.24.0-beta.2
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/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +4 -13
- package/dist/index.js.map +1 -0
- package/dist/lib/application-events.d.ts +1 -0
- package/dist/lib/application-events.d.ts.map +1 -0
- package/dist/lib/application-events.js +1 -0
- package/dist/lib/application-events.js.map +1 -0
- package/dist/lib/application.d.ts +6 -2
- package/dist/lib/application.d.ts.map +1 -0
- package/dist/lib/application.js +21 -13
- package/dist/lib/application.js.map +1 -0
- package/dist/lib/cli.d.ts.map +1 -0
- package/dist/lib/cli.js.map +1 -0
- package/dist/lib/converter/comments/blockLexer.d.ts.map +1 -0
- package/dist/lib/converter/comments/blockLexer.js.map +1 -0
- package/dist/lib/converter/comments/declarationReference.d.ts +1 -1
- package/dist/lib/converter/comments/declarationReference.d.ts.map +1 -0
- package/dist/lib/converter/comments/declarationReference.js.map +1 -0
- package/dist/lib/converter/comments/declarationReferenceResolver.d.ts.map +1 -0
- package/dist/lib/converter/comments/declarationReferenceResolver.js.map +1 -0
- package/dist/lib/converter/comments/discovery.d.ts +1 -1
- package/dist/lib/converter/comments/discovery.d.ts.map +1 -0
- package/dist/lib/converter/comments/discovery.js +76 -96
- package/dist/lib/converter/comments/discovery.js.map +1 -0
- package/dist/lib/converter/comments/index.d.ts +1 -1
- package/dist/lib/converter/comments/index.d.ts.map +1 -0
- package/dist/lib/converter/comments/index.js +21 -41
- package/dist/lib/converter/comments/index.js.map +1 -0
- package/dist/lib/converter/comments/lexer.d.ts.map +1 -0
- package/dist/lib/converter/comments/lexer.js.map +1 -0
- package/dist/lib/converter/comments/lineLexer.d.ts.map +1 -0
- package/dist/lib/converter/comments/lineLexer.js.map +1 -0
- package/dist/lib/converter/comments/linkResolver.d.ts +7 -2
- package/dist/lib/converter/comments/linkResolver.d.ts.map +1 -0
- package/dist/lib/converter/comments/linkResolver.js +27 -39
- package/dist/lib/converter/comments/linkResolver.js.map +1 -0
- package/dist/lib/converter/comments/parser.d.ts.map +1 -0
- package/dist/lib/converter/comments/parser.js.map +1 -0
- package/dist/lib/converter/comments/rawLexer.d.ts.map +1 -0
- package/dist/lib/converter/comments/rawLexer.js.map +1 -0
- package/dist/lib/converter/components.d.ts.map +1 -0
- package/dist/lib/converter/components.js.map +1 -0
- package/dist/lib/converter/context.d.ts +1 -1
- package/dist/lib/converter/context.d.ts.map +1 -0
- package/dist/lib/converter/context.js +5 -25
- package/dist/lib/converter/context.js.map +1 -0
- package/dist/lib/converter/convert-expression.d.ts +1 -1
- package/dist/lib/converter/convert-expression.d.ts.map +1 -0
- package/dist/lib/converter/convert-expression.js +15 -35
- package/dist/lib/converter/convert-expression.js.map +1 -0
- package/dist/lib/converter/converter-events.d.ts.map +1 -0
- package/dist/lib/converter/converter-events.js.map +1 -0
- package/dist/lib/converter/converter.d.ts +6 -4
- package/dist/lib/converter/converter.d.ts.map +1 -0
- package/dist/lib/converter/converter.js +17 -36
- package/dist/lib/converter/converter.js.map +1 -0
- package/dist/lib/converter/factories/index-signature.d.ts +1 -1
- package/dist/lib/converter/factories/index-signature.d.ts.map +1 -0
- package/dist/lib/converter/factories/index-signature.js +3 -26
- package/dist/lib/converter/factories/index-signature.js.map +1 -0
- package/dist/lib/converter/factories/signature.d.ts +1 -1
- package/dist/lib/converter/factories/signature.d.ts.map +1 -0
- package/dist/lib/converter/factories/signature.js +36 -53
- package/dist/lib/converter/factories/signature.js.map +1 -0
- package/dist/lib/converter/index.d.ts +1 -0
- package/dist/lib/converter/index.d.ts.map +1 -0
- package/dist/lib/converter/index.js.map +1 -0
- package/dist/lib/converter/jsdoc.d.ts +1 -1
- package/dist/lib/converter/jsdoc.d.ts.map +1 -0
- package/dist/lib/converter/jsdoc.js +17 -37
- package/dist/lib/converter/jsdoc.js.map +1 -0
- package/dist/lib/converter/plugins/CategoryPlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/CategoryPlugin.js.map +1 -0
- package/dist/lib/converter/plugins/CommentPlugin.d.ts +2 -0
- package/dist/lib/converter/plugins/CommentPlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/CommentPlugin.js +19 -4
- package/dist/lib/converter/plugins/CommentPlugin.js.map +1 -0
- package/dist/lib/converter/plugins/GroupPlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/GroupPlugin.js.map +1 -0
- package/dist/lib/converter/plugins/ImplementsPlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/ImplementsPlugin.js +9 -29
- package/dist/lib/converter/plugins/ImplementsPlugin.js.map +1 -0
- package/dist/lib/converter/plugins/InheritDocPlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/InheritDocPlugin.js.map +1 -0
- package/dist/lib/converter/plugins/LinkResolverPlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/LinkResolverPlugin.js +10 -2
- package/dist/lib/converter/plugins/LinkResolverPlugin.js.map +1 -0
- package/dist/lib/converter/plugins/PackagePlugin.d.ts +1 -0
- package/dist/lib/converter/plugins/PackagePlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/PackagePlugin.js +6 -1
- package/dist/lib/converter/plugins/PackagePlugin.js.map +1 -0
- package/dist/lib/converter/plugins/SourcePlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/SourcePlugin.js +6 -26
- package/dist/lib/converter/plugins/SourcePlugin.js.map +1 -0
- package/dist/lib/converter/plugins/TypePlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/TypePlugin.js.map +1 -0
- package/dist/lib/converter/plugins/index.d.ts.map +1 -0
- package/dist/lib/converter/plugins/index.js.map +1 -0
- package/dist/lib/converter/symbols.d.ts +1 -1
- package/dist/lib/converter/symbols.d.ts.map +1 -0
- package/dist/lib/converter/symbols.js +120 -142
- package/dist/lib/converter/symbols.js.map +1 -0
- package/dist/lib/converter/types.d.ts +1 -1
- package/dist/lib/converter/types.d.ts.map +1 -0
- package/dist/lib/converter/types.js +89 -112
- package/dist/lib/converter/types.js.map +1 -0
- package/dist/lib/converter/utils/base-path.d.ts.map +1 -0
- package/dist/lib/converter/utils/base-path.js.map +1 -0
- package/dist/lib/converter/utils/nodes.d.ts +1 -1
- package/dist/lib/converter/utils/nodes.d.ts.map +1 -0
- package/dist/lib/converter/utils/nodes.js +4 -24
- package/dist/lib/converter/utils/nodes.js.map +1 -0
- package/dist/lib/converter/utils/reflections.d.ts.map +1 -0
- package/dist/lib/converter/utils/reflections.js.map +1 -0
- package/dist/lib/converter/utils/repository.d.ts.map +1 -0
- package/dist/lib/converter/utils/repository.js.map +1 -0
- package/dist/lib/converter/utils/symbols.d.ts +1 -1
- package/dist/lib/converter/utils/symbols.d.ts.map +1 -0
- package/dist/lib/converter/utils/symbols.js +4 -24
- package/dist/lib/converter/utils/symbols.js.map +1 -0
- package/dist/lib/models/ReflectionCategory.d.ts.map +1 -0
- package/dist/lib/models/ReflectionCategory.js.map +1 -0
- package/dist/lib/models/ReflectionGroup.d.ts.map +1 -0
- package/dist/lib/models/ReflectionGroup.js.map +1 -0
- package/dist/lib/models/comments/comment.d.ts +6 -0
- package/dist/lib/models/comments/comment.d.ts.map +1 -0
- package/dist/lib/models/comments/comment.js +50 -0
- package/dist/lib/models/comments/comment.js.map +1 -0
- package/dist/lib/models/comments/index.d.ts.map +1 -0
- package/dist/lib/models/comments/index.js.map +1 -0
- package/dist/lib/models/index.d.ts.map +1 -0
- package/dist/lib/models/index.js.map +1 -0
- package/dist/lib/models/reflections/ReflectionSymbolId.d.ts.map +1 -0
- package/dist/lib/models/reflections/ReflectionSymbolId.js.map +1 -0
- package/dist/lib/models/reflections/abstract.d.ts.map +1 -0
- package/dist/lib/models/reflections/abstract.js.map +1 -0
- package/dist/lib/models/reflections/container.d.ts.map +1 -0
- package/dist/lib/models/reflections/container.js.map +1 -0
- package/dist/lib/models/reflections/declaration.d.ts +2 -2
- package/dist/lib/models/reflections/declaration.d.ts.map +1 -0
- package/dist/lib/models/reflections/declaration.js +1 -1
- package/dist/lib/models/reflections/declaration.js.map +1 -0
- package/dist/lib/models/reflections/id.d.ts +30 -0
- package/dist/lib/models/reflections/id.d.ts.map +1 -0
- package/dist/lib/models/reflections/id.js +52 -0
- package/dist/lib/models/reflections/id.js.map +1 -0
- package/dist/lib/models/reflections/index.d.ts.map +1 -0
- package/dist/lib/models/reflections/index.js.map +1 -0
- package/dist/lib/models/reflections/kind.d.ts.map +1 -0
- package/dist/lib/models/reflections/kind.js.map +1 -0
- package/dist/lib/models/reflections/parameter.d.ts.map +1 -0
- package/dist/lib/models/reflections/parameter.js.map +1 -0
- package/dist/lib/models/reflections/project.d.ts.map +1 -0
- package/dist/lib/models/reflections/project.js.map +1 -0
- package/dist/lib/models/reflections/reference.d.ts.map +1 -0
- package/dist/lib/models/reflections/reference.js.map +1 -0
- package/dist/lib/models/reflections/signature.d.ts.map +1 -0
- package/dist/lib/models/reflections/signature.js.map +1 -0
- package/dist/lib/models/reflections/type-parameter.d.ts +1 -1
- package/dist/lib/models/reflections/type-parameter.d.ts.map +1 -0
- package/dist/lib/models/reflections/type-parameter.js.map +1 -0
- package/dist/lib/models/reflections/utils.d.ts.map +1 -0
- package/dist/lib/models/reflections/utils.js.map +1 -0
- package/dist/lib/models/reflections/variant.d.ts.map +1 -0
- package/dist/lib/models/reflections/variant.js.map +1 -0
- package/dist/lib/models/sources/file.d.ts.map +1 -0
- package/dist/lib/models/sources/file.js.map +1 -0
- package/dist/lib/models/sources/index.d.ts.map +1 -0
- package/dist/lib/models/sources/index.js.map +1 -0
- package/dist/lib/models/types.d.ts +1 -1
- package/dist/lib/models/types.d.ts.map +1 -0
- package/dist/lib/models/types.js.map +1 -0
- package/dist/lib/output/components.d.ts.map +1 -0
- package/dist/lib/output/components.js.map +1 -0
- package/dist/lib/output/events.d.ts.map +1 -0
- package/dist/lib/output/events.js.map +1 -0
- package/dist/lib/output/index.d.ts.map +1 -0
- package/dist/lib/output/index.js.map +1 -0
- package/dist/lib/output/models/UrlMapping.d.ts.map +1 -0
- package/dist/lib/output/models/UrlMapping.js.map +1 -0
- package/dist/lib/output/plugins/AssetsPlugin.d.ts.map +1 -0
- package/dist/lib/output/plugins/AssetsPlugin.js.map +1 -0
- package/dist/lib/output/plugins/JavascriptIndexPlugin.d.ts.map +1 -0
- package/dist/lib/output/plugins/JavascriptIndexPlugin.js.map +1 -0
- package/dist/lib/output/plugins/index.d.ts.map +1 -0
- package/dist/lib/output/plugins/index.js.map +1 -0
- package/dist/lib/output/renderer.d.ts.map +1 -0
- package/dist/lib/output/renderer.js.map +1 -0
- package/dist/lib/output/theme.d.ts.map +1 -0
- package/dist/lib/output/theme.js.map +1 -0
- package/dist/lib/output/themes/MarkedPlugin.d.ts.map +1 -0
- package/dist/lib/output/themes/MarkedPlugin.js.map +1 -0
- package/dist/lib/output/themes/default/DefaultTheme.d.ts.map +1 -0
- package/dist/lib/output/themes/default/DefaultTheme.js.map +1 -0
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts +1 -1
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts.map +1 -0
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.js +1 -2
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.js.map +1 -0
- package/dist/lib/output/themes/default/layouts/default.d.ts.map +1 -0
- package/dist/lib/output/themes/default/layouts/default.js.map +1 -0
- package/dist/lib/output/themes/default/partials/analytics.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/analytics.js.map +1 -0
- package/dist/lib/output/themes/default/partials/anchor-icon.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/anchor-icon.js.map +1 -0
- package/dist/lib/output/themes/default/partials/breadcrumb.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/breadcrumb.js.map +1 -0
- package/dist/lib/output/themes/default/partials/comment.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/comment.js.map +1 -0
- package/dist/lib/output/themes/default/partials/footer.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/footer.js.map +1 -0
- package/dist/lib/output/themes/default/partials/header.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/header.js +1 -1
- package/dist/lib/output/themes/default/partials/header.js.map +1 -0
- package/dist/lib/output/themes/default/partials/hierarchy.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/hierarchy.js.map +1 -0
- package/dist/lib/output/themes/default/partials/icon.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/icon.js.map +1 -0
- package/dist/lib/output/themes/default/partials/index.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/index.js.map +1 -0
- package/dist/lib/output/themes/default/partials/member.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/member.declaration.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/member.declaration.js.map +1 -0
- package/dist/lib/output/themes/default/partials/member.getterSetter.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/member.getterSetter.js.map +1 -0
- package/dist/lib/output/themes/default/partials/member.js.map +1 -0
- package/dist/lib/output/themes/default/partials/member.reference.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/member.reference.js.map +1 -0
- package/dist/lib/output/themes/default/partials/member.signature.body.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/member.signature.body.js.map +1 -0
- package/dist/lib/output/themes/default/partials/member.signature.title.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/member.signature.title.js.map +1 -0
- package/dist/lib/output/themes/default/partials/member.signatures.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/member.signatures.js.map +1 -0
- package/dist/lib/output/themes/default/partials/member.sources.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/member.sources.js.map +1 -0
- package/dist/lib/output/themes/default/partials/members.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/members.group.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/members.group.js.map +1 -0
- package/dist/lib/output/themes/default/partials/members.js.map +1 -0
- package/dist/lib/output/themes/default/partials/navigation.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/navigation.js +1 -1
- package/dist/lib/output/themes/default/partials/navigation.js.map +1 -0
- package/dist/lib/output/themes/default/partials/parameter.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/parameter.js.map +1 -0
- package/dist/lib/output/themes/default/partials/toolbar.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/toolbar.js.map +1 -0
- package/dist/lib/output/themes/default/partials/type.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/type.js.map +1 -0
- package/dist/lib/output/themes/default/partials/typeAndParent.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/typeAndParent.js.map +1 -0
- package/dist/lib/output/themes/default/partials/typeParameters.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/typeParameters.js.map +1 -0
- package/dist/lib/output/themes/default/templates/index.d.ts.map +1 -0
- package/dist/lib/output/themes/default/templates/index.js.map +1 -0
- package/dist/lib/output/themes/default/templates/reflection.d.ts.map +1 -0
- package/dist/lib/output/themes/default/templates/reflection.js.map +1 -0
- package/dist/lib/output/themes/lib.d.ts +2 -4
- package/dist/lib/output/themes/lib.d.ts.map +1 -0
- package/dist/lib/output/themes/lib.js +3 -45
- package/dist/lib/output/themes/lib.js.map +1 -0
- package/dist/lib/serialization/components.d.ts.map +1 -0
- package/dist/lib/serialization/components.js.map +1 -0
- package/dist/lib/serialization/deserializer.d.ts.map +1 -0
- package/dist/lib/serialization/deserializer.js.map +1 -0
- package/dist/lib/serialization/events.d.ts.map +1 -0
- package/dist/lib/serialization/events.js.map +1 -0
- package/dist/lib/serialization/index.d.ts.map +1 -0
- package/dist/lib/serialization/index.js.map +1 -0
- package/dist/lib/serialization/schema.d.ts.map +1 -0
- package/dist/lib/serialization/schema.js.map +1 -0
- package/dist/lib/serialization/serializer.d.ts.map +1 -0
- package/dist/lib/serialization/serializer.js.map +1 -0
- package/dist/lib/utils/array.d.ts.map +1 -0
- package/dist/lib/utils/array.js.map +1 -0
- package/dist/lib/utils/component.d.ts.map +1 -0
- package/dist/lib/utils/component.js.map +1 -0
- package/dist/lib/utils/entry-point.d.ts +2 -2
- package/dist/lib/utils/entry-point.d.ts.map +1 -0
- package/dist/lib/utils/entry-point.js +11 -8
- package/dist/lib/utils/entry-point.js.map +1 -0
- package/dist/lib/utils/enum.d.ts.map +1 -0
- package/dist/lib/utils/enum.js.map +1 -0
- package/dist/lib/utils/events.d.ts.map +1 -0
- package/dist/lib/utils/events.js.map +1 -0
- package/dist/lib/utils/fs.d.ts +1 -0
- package/dist/lib/utils/fs.d.ts.map +1 -0
- package/dist/lib/utils/fs.js +72 -13
- package/dist/lib/utils/fs.js.map +1 -0
- package/dist/lib/utils/general.d.ts.map +1 -0
- package/dist/lib/utils/general.js.map +1 -0
- package/dist/lib/utils/highlighter.d.ts.map +1 -0
- package/dist/lib/utils/highlighter.js.map +1 -0
- package/dist/lib/utils/hooks.d.ts.map +1 -0
- package/dist/lib/utils/hooks.js.map +1 -0
- package/dist/lib/utils/index.d.ts.map +1 -0
- package/dist/lib/utils/index.js.map +1 -0
- package/dist/lib/utils/jsx.d.ts.map +1 -0
- package/dist/lib/utils/jsx.elements.d.ts.map +1 -0
- package/dist/lib/utils/jsx.elements.js.map +1 -0
- package/dist/lib/utils/jsx.js.map +1 -0
- package/dist/lib/utils/loggers.d.ts +1 -1
- package/dist/lib/utils/loggers.d.ts.map +1 -0
- package/dist/lib/utils/loggers.js +8 -28
- package/dist/lib/utils/loggers.js.map +1 -0
- package/dist/lib/utils/map.d.ts.map +1 -0
- package/dist/lib/utils/map.js.map +1 -0
- package/dist/lib/utils/minimalSourceFile.d.ts.map +1 -0
- package/dist/lib/utils/minimalSourceFile.js.map +1 -0
- package/dist/lib/utils/options/declaration.d.ts +3 -2
- package/dist/lib/utils/options/declaration.d.ts.map +1 -0
- package/dist/lib/utils/options/declaration.js.map +1 -0
- package/dist/lib/utils/options/help.d.ts.map +1 -0
- package/dist/lib/utils/options/help.js.map +1 -0
- package/dist/lib/utils/options/index.d.ts.map +1 -0
- package/dist/lib/utils/options/index.js.map +1 -0
- package/dist/lib/utils/options/options.d.ts.map +1 -0
- package/dist/lib/utils/options/options.js.map +1 -0
- package/dist/lib/utils/options/readers/arguments.d.ts.map +1 -0
- package/dist/lib/utils/options/readers/arguments.js.map +1 -0
- package/dist/lib/utils/options/readers/index.d.ts.map +1 -0
- package/dist/lib/utils/options/readers/index.js.map +1 -0
- package/dist/lib/utils/options/readers/tsconfig.d.ts.map +1 -0
- package/dist/lib/utils/options/readers/tsconfig.js +4 -24
- package/dist/lib/utils/options/readers/tsconfig.js.map +1 -0
- package/dist/lib/utils/options/readers/typedoc.d.ts +1 -1
- package/dist/lib/utils/options/readers/typedoc.d.ts.map +1 -0
- package/dist/lib/utils/options/readers/typedoc.js +15 -4
- package/dist/lib/utils/options/readers/typedoc.js.map +1 -0
- package/dist/lib/utils/options/sources/index.d.ts.map +1 -0
- package/dist/lib/utils/options/sources/index.js.map +1 -0
- package/dist/lib/utils/options/sources/typedoc.d.ts.map +1 -0
- package/dist/lib/utils/options/sources/typedoc.js +55 -10
- package/dist/lib/utils/options/sources/typedoc.js.map +1 -0
- package/dist/lib/utils/options/tsdoc-defaults.d.ts.map +1 -0
- package/dist/lib/utils/options/tsdoc-defaults.js.map +1 -0
- package/dist/lib/utils/package-manifest.d.ts.map +1 -0
- package/dist/lib/utils/package-manifest.js.map +1 -0
- package/dist/lib/utils/package.d.ts +13 -0
- package/dist/lib/utils/package.d.ts.map +1 -0
- package/dist/lib/utils/package.js +154 -0
- package/dist/lib/utils/package.js.map +1 -0
- package/dist/lib/utils/paths.d.ts.map +1 -0
- package/dist/lib/utils/paths.js.map +1 -0
- package/dist/lib/utils/perf.d.ts.map +1 -0
- package/dist/lib/utils/perf.js.map +1 -0
- package/dist/lib/utils/plugins.d.ts.map +1 -0
- package/dist/lib/utils/plugins.js.map +1 -0
- package/dist/lib/utils/reflections.d.ts.map +1 -0
- package/dist/lib/utils/reflections.js.map +1 -0
- package/dist/lib/utils/sort.d.ts +1 -1
- package/dist/lib/utils/sort.d.ts.map +1 -0
- package/dist/lib/utils/sort.js.map +1 -0
- package/dist/lib/utils/tsconfig.d.ts.map +1 -0
- package/dist/lib/utils/tsconfig.js.map +1 -0
- package/dist/lib/utils/tsutils.d.ts.map +1 -0
- package/dist/lib/utils/tsutils.js.map +1 -0
- package/dist/lib/utils/validation.d.ts.map +1 -0
- package/dist/lib/utils/validation.js.map +1 -0
- package/dist/lib/validation/documentation.d.ts.map +1 -0
- package/dist/lib/validation/documentation.js +13 -1
- package/dist/lib/validation/documentation.js.map +1 -0
- package/dist/lib/validation/exports.d.ts.map +1 -0
- package/dist/lib/validation/exports.js.map +1 -0
- package/dist/lib/validation/links.d.ts.map +1 -0
- package/dist/lib/validation/links.js.map +1 -0
- package/package.json +16 -16
- package/static/main.js +55 -1
|
@@ -1,30 +1,10 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
var
|
|
3
|
-
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
-
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
-
}) : function(o, v) {
|
|
16
|
-
o["default"] = v;
|
|
17
|
-
});
|
|
18
|
-
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
-
if (mod && mod.__esModule) return mod;
|
|
20
|
-
var result = {};
|
|
21
|
-
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
-
__setModuleDefault(result, mod);
|
|
23
|
-
return result;
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
24
4
|
};
|
|
25
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
6
|
exports.discoverSignatureComment = exports.discoverComment = void 0;
|
|
27
|
-
const
|
|
7
|
+
const typescript_1 = __importDefault(require("typescript"));
|
|
28
8
|
const models_1 = require("../../models");
|
|
29
9
|
const utils_1 = require("../../utils");
|
|
30
10
|
const declaration_1 = require("../../utils/options/declaration");
|
|
@@ -34,84 +14,84 @@ const paths_1 = require("../../utils/paths");
|
|
|
34
14
|
// the JSDoc converter because we only want part of the comment when
|
|
35
15
|
// getting them.
|
|
36
16
|
const wantedKinds = {
|
|
37
|
-
[models_1.ReflectionKind.Project]: [
|
|
38
|
-
[models_1.ReflectionKind.Module]: [
|
|
17
|
+
[models_1.ReflectionKind.Project]: [typescript_1.default.SyntaxKind.SourceFile],
|
|
18
|
+
[models_1.ReflectionKind.Module]: [typescript_1.default.SyntaxKind.SourceFile],
|
|
39
19
|
[models_1.ReflectionKind.Namespace]: [
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
20
|
+
typescript_1.default.SyntaxKind.ModuleDeclaration,
|
|
21
|
+
typescript_1.default.SyntaxKind.SourceFile,
|
|
22
|
+
typescript_1.default.SyntaxKind.BindingElement,
|
|
23
|
+
typescript_1.default.SyntaxKind.ExportSpecifier,
|
|
24
|
+
typescript_1.default.SyntaxKind.NamespaceExport,
|
|
45
25
|
],
|
|
46
26
|
[models_1.ReflectionKind.Enum]: [
|
|
47
|
-
|
|
48
|
-
|
|
27
|
+
typescript_1.default.SyntaxKind.EnumDeclaration,
|
|
28
|
+
typescript_1.default.SyntaxKind.VariableDeclaration,
|
|
49
29
|
],
|
|
50
30
|
[models_1.ReflectionKind.EnumMember]: [
|
|
51
|
-
|
|
31
|
+
typescript_1.default.SyntaxKind.EnumMember,
|
|
52
32
|
// These here so that @enum gets comments
|
|
53
|
-
|
|
54
|
-
|
|
33
|
+
typescript_1.default.SyntaxKind.PropertyAssignment,
|
|
34
|
+
typescript_1.default.SyntaxKind.PropertySignature,
|
|
55
35
|
],
|
|
56
36
|
[models_1.ReflectionKind.Variable]: [
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
37
|
+
typescript_1.default.SyntaxKind.VariableDeclaration,
|
|
38
|
+
typescript_1.default.SyntaxKind.BindingElement,
|
|
39
|
+
typescript_1.default.SyntaxKind.ExportAssignment,
|
|
40
|
+
typescript_1.default.SyntaxKind.PropertyAccessExpression,
|
|
61
41
|
],
|
|
62
42
|
[models_1.ReflectionKind.Function]: [
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
43
|
+
typescript_1.default.SyntaxKind.FunctionDeclaration,
|
|
44
|
+
typescript_1.default.SyntaxKind.BindingElement,
|
|
45
|
+
typescript_1.default.SyntaxKind.VariableDeclaration,
|
|
46
|
+
typescript_1.default.SyntaxKind.ExportAssignment,
|
|
47
|
+
typescript_1.default.SyntaxKind.PropertyAccessExpression,
|
|
68
48
|
],
|
|
69
49
|
[models_1.ReflectionKind.Class]: [
|
|
70
|
-
|
|
71
|
-
|
|
50
|
+
typescript_1.default.SyntaxKind.ClassDeclaration,
|
|
51
|
+
typescript_1.default.SyntaxKind.BindingElement,
|
|
72
52
|
],
|
|
73
|
-
[models_1.ReflectionKind.Interface]: [
|
|
74
|
-
[models_1.ReflectionKind.Constructor]: [
|
|
53
|
+
[models_1.ReflectionKind.Interface]: [typescript_1.default.SyntaxKind.InterfaceDeclaration],
|
|
54
|
+
[models_1.ReflectionKind.Constructor]: [typescript_1.default.SyntaxKind.Constructor],
|
|
75
55
|
[models_1.ReflectionKind.Property]: [
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
56
|
+
typescript_1.default.SyntaxKind.PropertyDeclaration,
|
|
57
|
+
typescript_1.default.SyntaxKind.PropertySignature,
|
|
58
|
+
typescript_1.default.SyntaxKind.BinaryExpression,
|
|
59
|
+
typescript_1.default.SyntaxKind.PropertyAssignment,
|
|
80
60
|
// class X { constructor(/** Comment */ readonly z: string) }
|
|
81
|
-
|
|
61
|
+
typescript_1.default.SyntaxKind.Parameter,
|
|
82
62
|
],
|
|
83
63
|
[models_1.ReflectionKind.Method]: [
|
|
84
|
-
|
|
85
|
-
|
|
64
|
+
typescript_1.default.SyntaxKind.FunctionDeclaration,
|
|
65
|
+
typescript_1.default.SyntaxKind.MethodDeclaration,
|
|
86
66
|
],
|
|
87
67
|
[models_1.ReflectionKind.CallSignature]: [
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
68
|
+
typescript_1.default.SyntaxKind.FunctionDeclaration,
|
|
69
|
+
typescript_1.default.SyntaxKind.VariableDeclaration,
|
|
70
|
+
typescript_1.default.SyntaxKind.MethodDeclaration,
|
|
71
|
+
typescript_1.default.SyntaxKind.MethodDeclaration,
|
|
72
|
+
typescript_1.default.SyntaxKind.PropertyDeclaration,
|
|
73
|
+
typescript_1.default.SyntaxKind.PropertySignature,
|
|
74
|
+
typescript_1.default.SyntaxKind.CallSignature,
|
|
95
75
|
],
|
|
96
|
-
[models_1.ReflectionKind.IndexSignature]: [
|
|
97
|
-
[models_1.ReflectionKind.ConstructorSignature]: [
|
|
98
|
-
[models_1.ReflectionKind.Parameter]: [
|
|
99
|
-
[models_1.ReflectionKind.TypeLiteral]: [
|
|
100
|
-
[models_1.ReflectionKind.TypeParameter]: [
|
|
101
|
-
[models_1.ReflectionKind.Accessor]: [
|
|
102
|
-
[models_1.ReflectionKind.GetSignature]: [
|
|
103
|
-
[models_1.ReflectionKind.SetSignature]: [
|
|
104
|
-
[models_1.ReflectionKind.ObjectLiteral]: [
|
|
105
|
-
[models_1.ReflectionKind.TypeAlias]: [
|
|
76
|
+
[models_1.ReflectionKind.IndexSignature]: [typescript_1.default.SyntaxKind.IndexSignature],
|
|
77
|
+
[models_1.ReflectionKind.ConstructorSignature]: [typescript_1.default.SyntaxKind.ConstructSignature],
|
|
78
|
+
[models_1.ReflectionKind.Parameter]: [typescript_1.default.SyntaxKind.Parameter],
|
|
79
|
+
[models_1.ReflectionKind.TypeLiteral]: [typescript_1.default.SyntaxKind.TypeLiteral],
|
|
80
|
+
[models_1.ReflectionKind.TypeParameter]: [typescript_1.default.SyntaxKind.TypeParameter],
|
|
81
|
+
[models_1.ReflectionKind.Accessor]: [typescript_1.default.SyntaxKind.PropertyDeclaration],
|
|
82
|
+
[models_1.ReflectionKind.GetSignature]: [typescript_1.default.SyntaxKind.GetAccessor],
|
|
83
|
+
[models_1.ReflectionKind.SetSignature]: [typescript_1.default.SyntaxKind.SetAccessor],
|
|
84
|
+
[models_1.ReflectionKind.ObjectLiteral]: [typescript_1.default.SyntaxKind.ObjectLiteralExpression],
|
|
85
|
+
[models_1.ReflectionKind.TypeAlias]: [typescript_1.default.SyntaxKind.TypeAliasDeclaration],
|
|
106
86
|
[models_1.ReflectionKind.Reference]: [
|
|
107
|
-
|
|
108
|
-
|
|
87
|
+
typescript_1.default.SyntaxKind.NamespaceExport,
|
|
88
|
+
typescript_1.default.SyntaxKind.ExportSpecifier,
|
|
109
89
|
],
|
|
110
90
|
};
|
|
111
91
|
function discoverComment(symbol, kind, logger, commentStyle) {
|
|
112
92
|
// For a module comment, we want the first one defined in the file,
|
|
113
93
|
// not the last one, since that will apply to the import or declaration.
|
|
114
|
-
const reverse = !symbol.declarations?.some(
|
|
94
|
+
const reverse = !symbol.declarations?.some(typescript_1.default.isSourceFile);
|
|
115
95
|
const discovered = [];
|
|
116
96
|
for (const decl of symbol.declarations || []) {
|
|
117
97
|
const text = decl.getSourceFile().text;
|
|
@@ -127,14 +107,14 @@ function discoverComment(symbol, kind, logger, commentStyle) {
|
|
|
127
107
|
// See the gh1770 test for an example.
|
|
128
108
|
if (kind & models_1.ReflectionKind.ContainsCallSignatures &&
|
|
129
109
|
[
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
110
|
+
typescript_1.default.SyntaxKind.FunctionDeclaration,
|
|
111
|
+
typescript_1.default.SyntaxKind.MethodDeclaration,
|
|
112
|
+
typescript_1.default.SyntaxKind.Constructor,
|
|
133
113
|
].includes(node.kind) &&
|
|
134
114
|
!node.body) {
|
|
135
115
|
continue;
|
|
136
116
|
}
|
|
137
|
-
const comments = collectCommentRanges(
|
|
117
|
+
const comments = collectCommentRanges(typescript_1.default.getLeadingCommentRanges(text, node.pos));
|
|
138
118
|
if (reverse) {
|
|
139
119
|
comments.reverse();
|
|
140
120
|
}
|
|
@@ -153,7 +133,7 @@ function discoverComment(symbol, kind, logger, commentStyle) {
|
|
|
153
133
|
logger.warn(`${symbol.name} has multiple declarations with a comment. An arbitrary comment will be used.`);
|
|
154
134
|
const locations = discovered.map(([sf, [{ pos }]]) => {
|
|
155
135
|
const path = (0, paths_1.nicePath)(sf.fileName);
|
|
156
|
-
const line =
|
|
136
|
+
const line = typescript_1.default.getLineAndCharacterOfPosition(sf, pos).line + 1;
|
|
157
137
|
return `${path}:${line}`;
|
|
158
138
|
});
|
|
159
139
|
logger.info(`The comments for ${symbol.name} are declared at:\n\t${locations.join("\n\t")}`);
|
|
@@ -168,7 +148,7 @@ function discoverSignatureComment(declaration, commentStyle) {
|
|
|
168
148
|
return;
|
|
169
149
|
}
|
|
170
150
|
const text = node.getSourceFile().text;
|
|
171
|
-
const comments = collectCommentRanges(
|
|
151
|
+
const comments = collectCommentRanges(typescript_1.default.getLeadingCommentRanges(text, node.pos));
|
|
172
152
|
comments.reverse();
|
|
173
153
|
const comment = comments.find((ranges) => permittedRange(text, ranges, commentStyle));
|
|
174
154
|
if (comment) {
|
|
@@ -190,7 +170,7 @@ exports.discoverSignatureComment = discoverSignatureComment;
|
|
|
190
170
|
* @return TRUE if the given node is the topmost module declaration, FALSE otherwise.
|
|
191
171
|
*/
|
|
192
172
|
function isTopmostModuleDeclaration(node) {
|
|
193
|
-
return node.getChildren().some(
|
|
173
|
+
return node.getChildren().some(typescript_1.default.isModuleBlock);
|
|
194
174
|
}
|
|
195
175
|
/**
|
|
196
176
|
* Return the root module declaration of the given module declaration.
|
|
@@ -204,7 +184,7 @@ function isTopmostModuleDeclaration(node) {
|
|
|
204
184
|
*/
|
|
205
185
|
function getRootModuleDeclaration(node) {
|
|
206
186
|
while (node.parent &&
|
|
207
|
-
node.parent.kind ===
|
|
187
|
+
node.parent.kind === typescript_1.default.SyntaxKind.ModuleDeclaration) {
|
|
208
188
|
const parent = node.parent;
|
|
209
189
|
if (node.name.pos === parent.name.end + 1) {
|
|
210
190
|
node = parent;
|
|
@@ -220,12 +200,12 @@ function declarationToCommentNode(node) {
|
|
|
220
200
|
return node;
|
|
221
201
|
// const abc = 123
|
|
222
202
|
// ^^^
|
|
223
|
-
if (node.parent.kind ===
|
|
203
|
+
if (node.parent.kind === typescript_1.default.SyntaxKind.VariableDeclarationList) {
|
|
224
204
|
return node.parent.parent;
|
|
225
205
|
}
|
|
226
206
|
// const a = () => {}
|
|
227
207
|
// ^^^^^^^^
|
|
228
|
-
if (node.parent.kind ===
|
|
208
|
+
if (node.parent.kind === typescript_1.default.SyntaxKind.VariableDeclaration) {
|
|
229
209
|
return node.parent.parent.parent;
|
|
230
210
|
}
|
|
231
211
|
// class X { y = () => {} }
|
|
@@ -236,13 +216,13 @@ function declarationToCommentNode(node) {
|
|
|
236
216
|
// export default () => {}
|
|
237
217
|
// ^^^^^^^^
|
|
238
218
|
if ([
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
219
|
+
typescript_1.default.SyntaxKind.PropertyDeclaration,
|
|
220
|
+
typescript_1.default.SyntaxKind.BinaryExpression,
|
|
221
|
+
typescript_1.default.SyntaxKind.ExportAssignment,
|
|
242
222
|
].includes(node.parent.kind)) {
|
|
243
223
|
return node.parent;
|
|
244
224
|
}
|
|
245
|
-
if (
|
|
225
|
+
if (typescript_1.default.isModuleDeclaration(node)) {
|
|
246
226
|
if (!isTopmostModuleDeclaration(node)) {
|
|
247
227
|
return;
|
|
248
228
|
}
|
|
@@ -250,10 +230,10 @@ function declarationToCommentNode(node) {
|
|
|
250
230
|
return getRootModuleDeclaration(node);
|
|
251
231
|
}
|
|
252
232
|
}
|
|
253
|
-
if (node.kind ===
|
|
233
|
+
if (node.kind === typescript_1.default.SyntaxKind.ExportSpecifier) {
|
|
254
234
|
return node.parent.parent;
|
|
255
235
|
}
|
|
256
|
-
if ([
|
|
236
|
+
if ([typescript_1.default.SyntaxKind.NamespaceExport, typescript_1.default.SyntaxKind.FunctionType].includes(node.kind)) {
|
|
257
237
|
return node.parent;
|
|
258
238
|
}
|
|
259
239
|
return node;
|
|
@@ -268,14 +248,14 @@ function collectCommentRanges(ranges) {
|
|
|
268
248
|
for (const range of ranges || []) {
|
|
269
249
|
collect.push(range);
|
|
270
250
|
switch (range.kind) {
|
|
271
|
-
case
|
|
251
|
+
case typescript_1.default.SyntaxKind.MultiLineCommentTrivia:
|
|
272
252
|
if (collect.length) {
|
|
273
253
|
result.push(collect);
|
|
274
254
|
collect = [];
|
|
275
255
|
}
|
|
276
256
|
result.push([range]);
|
|
277
257
|
break;
|
|
278
|
-
case
|
|
258
|
+
case typescript_1.default.SyntaxKind.SingleLineCommentTrivia:
|
|
279
259
|
collect.push(range);
|
|
280
260
|
break;
|
|
281
261
|
/* istanbul ignore next */
|
|
@@ -293,11 +273,11 @@ function permittedRange(text, ranges, commentStyle) {
|
|
|
293
273
|
case declaration_1.CommentStyle.All:
|
|
294
274
|
return true;
|
|
295
275
|
case declaration_1.CommentStyle.Block:
|
|
296
|
-
return ranges[0].kind ===
|
|
276
|
+
return ranges[0].kind === typescript_1.default.SyntaxKind.MultiLineCommentTrivia;
|
|
297
277
|
case declaration_1.CommentStyle.Line:
|
|
298
|
-
return ranges[0].kind ===
|
|
278
|
+
return ranges[0].kind === typescript_1.default.SyntaxKind.SingleLineCommentTrivia;
|
|
299
279
|
case declaration_1.CommentStyle.JSDoc:
|
|
300
|
-
return (ranges[0].kind ===
|
|
280
|
+
return (ranges[0].kind === typescript_1.default.SyntaxKind.MultiLineCommentTrivia &&
|
|
301
281
|
text[ranges[0].pos] === "/" &&
|
|
302
282
|
text[ranges[0].pos + 1] === "*" &&
|
|
303
283
|
text[ranges[0].pos + 2] === "*");
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"discovery.js","sourceRoot":"","sources":["../../../../src/lib/converter/comments/discovery.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAiC;AACjC,yCAA8C;AAC9C,uCAAkD;AAClD,iEAA+D;AAC/D,6CAA6C;AAE7C,qEAAqE;AACrE,qEAAqE;AACrE,oEAAoE;AACpE,gBAAgB;AAChB,MAAM,WAAW,GAA4C;IACzD,CAAC,uBAAc,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC;IACpD,CAAC,uBAAc,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC;IACnD,CAAC,uBAAc,CAAC,SAAS,CAAC,EAAE;QACxB,EAAE,CAAC,UAAU,CAAC,iBAAiB;QAC/B,EAAE,CAAC,UAAU,CAAC,UAAU;QACxB,EAAE,CAAC,UAAU,CAAC,cAAc;QAC5B,EAAE,CAAC,UAAU,CAAC,eAAe;QAC7B,EAAE,CAAC,UAAU,CAAC,eAAe;KAChC;IACD,CAAC,uBAAc,CAAC,IAAI,CAAC,EAAE;QACnB,EAAE,CAAC,UAAU,CAAC,eAAe;QAC7B,EAAE,CAAC,UAAU,CAAC,mBAAmB;KACpC;IACD,CAAC,uBAAc,CAAC,UAAU,CAAC,EAAE;QACzB,EAAE,CAAC,UAAU,CAAC,UAAU;QACxB,yCAAyC;QACzC,EAAE,CAAC,UAAU,CAAC,kBAAkB;QAChC,EAAE,CAAC,UAAU,CAAC,iBAAiB;KAClC;IACD,CAAC,uBAAc,CAAC,QAAQ,CAAC,EAAE;QACvB,EAAE,CAAC,UAAU,CAAC,mBAAmB;QACjC,EAAE,CAAC,UAAU,CAAC,cAAc;QAC5B,EAAE,CAAC,UAAU,CAAC,gBAAgB;QAC9B,EAAE,CAAC,UAAU,CAAC,wBAAwB;KACzC;IACD,CAAC,uBAAc,CAAC,QAAQ,CAAC,EAAE;QACvB,EAAE,CAAC,UAAU,CAAC,mBAAmB;QACjC,EAAE,CAAC,UAAU,CAAC,cAAc;QAC5B,EAAE,CAAC,UAAU,CAAC,mBAAmB;QACjC,EAAE,CAAC,UAAU,CAAC,gBAAgB;QAC9B,EAAE,CAAC,UAAU,CAAC,wBAAwB;KACzC;IACD,CAAC,uBAAc,CAAC,KAAK,CAAC,EAAE;QACpB,EAAE,CAAC,UAAU,CAAC,gBAAgB;QAC9B,EAAE,CAAC,UAAU,CAAC,cAAc;KAC/B;IACD,CAAC,uBAAc,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAChE,CAAC,uBAAc,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC;IACzD,CAAC,uBAAc,CAAC,QAAQ,CAAC,EAAE;QACvB,EAAE,CAAC,UAAU,CAAC,mBAAmB;QACjC,EAAE,CAAC,UAAU,CAAC,iBAAiB;QAC/B,EAAE,CAAC,UAAU,CAAC,gBAAgB;QAC9B,EAAE,CAAC,UAAU,CAAC,kBAAkB;QAChC,6DAA6D;QAC7D,EAAE,CAAC,UAAU,CAAC,SAAS;KAC1B;IACD,CAAC,uBAAc,CAAC,MAAM,CAAC,EAAE;QACrB,EAAE,CAAC,UAAU,CAAC,mBAAmB;QACjC,EAAE,CAAC,UAAU,CAAC,iBAAiB;KAClC;IACD,CAAC,uBAAc,CAAC,aAAa,CAAC,EAAE;QAC5B,EAAE,CAAC,UAAU,CAAC,mBAAmB;QACjC,EAAE,CAAC,UAAU,CAAC,mBAAmB;QACjC,EAAE,CAAC,UAAU,CAAC,iBAAiB;QAC/B,EAAE,CAAC,UAAU,CAAC,iBAAiB;QAC/B,EAAE,CAAC,UAAU,CAAC,mBAAmB;QACjC,EAAE,CAAC,UAAU,CAAC,iBAAiB;QAC/B,EAAE,CAAC,UAAU,CAAC,aAAa;KAC9B;IACD,CAAC,uBAAc,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC;IAC/D,CAAC,uBAAc,CAAC,oBAAoB,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC;IACzE,CAAC,uBAAc,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC;IACrD,CAAC,uBAAc,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC;IACzD,CAAC,uBAAc,CAAC,aAAa,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC;IAC7D,CAAC,uBAAc,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAC9D,CAAC,uBAAc,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC;IAC1D,CAAC,uBAAc,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC;IAC1D,CAAC,uBAAc,CAAC,aAAa,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,uBAAuB,CAAC;IACvE,CAAC,uBAAc,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAChE,CAAC,uBAAc,CAAC,SAAS,CAAC,EAAE;QACxB,EAAE,CAAC,UAAU,CAAC,eAAe;QAC7B,EAAE,CAAC,UAAU,CAAC,eAAe;KAChC;CACJ,CAAC;AAEF,SAAgB,eAAe,CAC3B,MAAiB,EACjB,IAAoB,EACpB,MAAc,EACd,YAA0B;IAE1B,mEAAmE;IACnE,wEAAwE;IACxE,MAAM,OAAO,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC;IAE5D,MAAM,UAAU,GAAyC,EAAE,CAAC;IAE5D,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,YAAY,IAAI,EAAE,EAAE;QAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC;QACvC,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YACvC,MAAM,IAAI,GAAG,wBAAwB,CAAC,IAAI,CAAC,CAAC;YAC5C,IAAI,CAAC,IAAI,EAAE;gBACP,SAAS;aACZ;YAED,uEAAuE;YACvE,yEAAyE;YACzE,+EAA+E;YAC/E,6EAA6E;YAC7E,sCAAsC;YACtC,IACI,IAAI,GAAG,uBAAc,CAAC,sBAAsB;gBAC5C;oBACI,EAAE,CAAC,UAAU,CAAC,mBAAmB;oBACjC,EAAE,CAAC,UAAU,CAAC,iBAAiB;oBAC/B,EAAE,CAAC,UAAU,CAAC,WAAW;iBAC5B,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;gBACrB,CAAE,IAA+B,CAAC,IAAI,EACxC;gBACE,SAAS;aACZ;YAED,MAAM,QAAQ,GAAG,oBAAoB,CACjC,EAAE,CAAC,uBAAuB,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAC7C,CAAC;YAEF,IAAI,OAAO,EAAE;gBACT,QAAQ,CAAC,OAAO,EAAE,CAAC;aACtB;YAED,MAAM,kBAAkB,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAChD,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,CAC7C,CAAC;YAEF,IAAI,kBAAkB,EAAE;gBACpB,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,kBAAkB,CAAC,CAAC,CAAC;aAC/D;SACJ;KACJ;IAED,QAAQ,UAAU,CAAC,MAAM,EAAE;QACvB,KAAK,CAAC;YACF,OAAO,SAAS,CAAC;QACrB,KAAK,CAAC;YACF,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;QACzB,OAAO,CAAC,CAAC;YACL,MAAM,CAAC,IAAI,CACP,GAAG,MAAM,CAAC,IAAI,+EAA+E,CAChG,CAAC;YACF,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE;gBACjD,MAAM,IAAI,GAAG,IAAA,gBAAQ,EAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;gBACnC,MAAM,IAAI,GAAG,EAAE,CAAC,6BAA6B,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC;gBAChE,OAAO,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC;YAC7B,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,IAAI,CACP,oBACI,MAAM,CAAC,IACX,wBAAwB,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CACnD,CAAC;YACF,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;SACxB;KACJ;AACL,CAAC;AA7ED,0CA6EC;AAED,SAAgB,wBAAwB,CACpC,WAAwD,EACxD,YAA0B;IAE1B,MAAM,IAAI,GAAG,wBAAwB,CAAC,WAAW,CAAC,CAAC;IACnD,IAAI,CAAC,IAAI,EAAE;QACP,OAAO;KACV;IAED,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC;IAEvC,MAAM,QAAQ,GAAG,oBAAoB,CACjC,EAAE,CAAC,uBAAuB,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAC7C,CAAC;IACF,QAAQ,CAAC,OAAO,EAAE,CAAC;IAEnB,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CACrC,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,CAC7C,CAAC;IACF,IAAI,OAAO,EAAE;QACT,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;KAC1C;AACL,CAAC;AAtBD,4DAsBC;AAED;;;;;;;;;;;;GAYG;AACH,SAAS,0BAA0B,CAAC,IAA0B;IAC1D,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC;AACrD,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,wBAAwB,CAAC,IAA0B;IACxD,OACI,IAAI,CAAC,MAAM;QACX,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,iBAAiB,EACtD;QACE,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,EAAE;YACvC,IAAI,GAAG,MAAM,CAAC;SACjB;aAAM;YACH,MAAM;SACT;KACJ;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAS,wBAAwB,CAAC,IAAoB;IAClD,IAAI,CAAC,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IAE9B,kBAAkB;IAClB,YAAY;IACZ,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,uBAAuB,EAAE;QAC5D,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;KAC7B;IAED,qBAAqB;IACrB,qBAAqB;IACrB,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,mBAAmB,EAAE;QACxD,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;KACpC;IAED,2BAA2B;IAC3B,yBAAyB;IACzB,kBAAkB;IAClB,sBAAsB;IACtB,sBAAsB;IACtB,0BAA0B;IAC1B,0BAA0B;IAC1B,IACI;QACI,EAAE,CAAC,UAAU,CAAC,mBAAmB;QACjC,EAAE,CAAC,UAAU,CAAC,gBAAgB;QAC9B,EAAE,CAAC,UAAU,CAAC,gBAAgB;KACjC,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAC9B;QACE,OAAO,IAAI,CAAC,MAAM,CAAC;KACtB;IAED,IAAI,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE;QAC9B,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,EAAE;YACnC,OAAO;SACV;aAAM;YACH,OAAO,wBAAwB,CAAC,IAAI,CAAC,CAAC;SACzC;KACJ;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,eAAe,EAAE;QAC7C,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;KAC7B;IAED,IACI,CAAC,EAAE,CAAC,UAAU,CAAC,eAAe,EAAE,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,QAAQ,CAChE,IAAI,CAAC,IAAI,CACZ,EACH;QACE,OAAO,IAAI,CAAC,MAAM,CAAC;KACtB;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,SAAS,oBAAoB,CACzB,MAAqC;IAErC,MAAM,MAAM,GAAwB,EAAE,CAAC;IAEvC,IAAI,OAAO,GAAsB,EAAE,CAAC;IACpC,KAAK,MAAM,KAAK,IAAI,MAAM,IAAI,EAAE,EAAE;QAC9B,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEpB,QAAQ,KAAK,CAAC,IAAI,EAAE;YAChB,KAAK,EAAE,CAAC,UAAU,CAAC,sBAAsB;gBACrC,IAAI,OAAO,CAAC,MAAM,EAAE;oBAChB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBACrB,OAAO,GAAG,EAAE,CAAC;iBAChB;gBACD,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrB,MAAM;YACV,KAAK,EAAE,CAAC,UAAU,CAAC,uBAAuB;gBACtC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACpB,MAAM;YACV,0BAA0B;YAC1B;gBACI,IAAA,mBAAW,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SAC/B;KACJ;IAED,IAAI,OAAO,CAAC,MAAM,EAAE;QAChB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;KACxB;IAED,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,SAAS,cAAc,CACnB,IAAY,EACZ,MAAyB,EACzB,YAA0B;IAE1B,QAAQ,YAAY,EAAE;QAClB,KAAK,0BAAY,CAAC,GAAG;YACjB,OAAO,IAAI,CAAC;QAChB,KAAK,0BAAY,CAAC,KAAK;YACnB,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,sBAAsB,CAAC;QACnE,KAAK,0BAAY,CAAC,IAAI;YAClB,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,uBAAuB,CAAC;QACpE,KAAK,0BAAY,CAAC,KAAK;YACnB,OAAO,CACH,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,sBAAsB;gBACvD,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,GAAG;gBAC3B,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,GAAG;gBAC/B,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,GAAG,CAClC,CAAC;KACT;AACL,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/converter/comments/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AACjC,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EAAe,MAAM,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAMpE,MAAM,WAAW,mBAAmB;IAChC,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACvB,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACxB,YAAY,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CAC7B;AAqFD,wBAAgB,UAAU,CACtB,MAAM,EAAE,EAAE,CAAC,MAAM,EACjB,IAAI,EAAE,cAAc,EACpB,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,YAAY,GAC3B,OAAO,GAAG,SAAS,CA8BrB;AAoBD,wBAAgB,mBAAmB,CAC/B,WAAW,EAAE,EAAE,CAAC,oBAAoB,GAAG,EAAE,CAAC,cAAc,EACxD,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,YAAY,GAC3B,OAAO,GAAG,SAAS,CAOrB;AAED,wBAAgB,eAAe,CAC3B,WAAW,EACL,EAAE,CAAC,oBAAoB,GACvB,EAAE,CAAC,gBAAgB,GACnB,EAAE,CAAC,eAAe,GAClB,EAAE,CAAC,gBAAgB,GACnB,EAAE,CAAC,YAAY,EACrB,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,MAAM,GACf,OAAO,GAAG,SAAS,CAmErB"}
|
|
@@ -1,30 +1,10 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
var
|
|
3
|
-
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
-
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
-
}) : function(o, v) {
|
|
16
|
-
o["default"] = v;
|
|
17
|
-
});
|
|
18
|
-
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
-
if (mod && mod.__esModule) return mod;
|
|
20
|
-
var result = {};
|
|
21
|
-
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
-
__setModuleDefault(result, mod);
|
|
23
|
-
return result;
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
24
4
|
};
|
|
25
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
6
|
exports.getJsDocComment = exports.getSignatureComment = exports.getComment = void 0;
|
|
27
|
-
const
|
|
7
|
+
const typescript_1 = __importDefault(require("typescript"));
|
|
28
8
|
const models_1 = require("../../models");
|
|
29
9
|
const utils_1 = require("../../utils");
|
|
30
10
|
const blockLexer_1 = require("./blockLexer");
|
|
@@ -32,11 +12,11 @@ const discovery_1 = require("./discovery");
|
|
|
32
12
|
const lineLexer_1 = require("./lineLexer");
|
|
33
13
|
const parser_1 = require("./parser");
|
|
34
14
|
const jsDocCommentKinds = [
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
15
|
+
typescript_1.default.SyntaxKind.JSDocPropertyTag,
|
|
16
|
+
typescript_1.default.SyntaxKind.JSDocCallbackTag,
|
|
17
|
+
typescript_1.default.SyntaxKind.JSDocTypedefTag,
|
|
18
|
+
typescript_1.default.SyntaxKind.JSDocTemplateTag,
|
|
19
|
+
typescript_1.default.SyntaxKind.JSDocEnumTag,
|
|
40
20
|
];
|
|
41
21
|
const commentCache = new WeakMap();
|
|
42
22
|
function getCommentWithCache(discovered, config, logger) {
|
|
@@ -49,10 +29,10 @@ function getCommentWithCache(discovered, config, logger) {
|
|
|
49
29
|
}
|
|
50
30
|
let comment;
|
|
51
31
|
switch (ranges[0].kind) {
|
|
52
|
-
case
|
|
32
|
+
case typescript_1.default.SyntaxKind.MultiLineCommentTrivia:
|
|
53
33
|
comment = (0, parser_1.parseComment)((0, blockLexer_1.lexBlockComment)(file.text, ranges[0].pos, ranges[0].end), config, file, logger);
|
|
54
34
|
break;
|
|
55
|
-
case
|
|
35
|
+
case typescript_1.default.SyntaxKind.SingleLineCommentTrivia:
|
|
56
36
|
comment = (0, parser_1.parseComment)((0, lineLexer_1.lexLineComments)(file.text, ranges), config, file, logger);
|
|
57
37
|
break;
|
|
58
38
|
default:
|
|
@@ -82,12 +62,12 @@ function getCommentImpl(commentSource, config, logger, moduleComment) {
|
|
|
82
62
|
return comment;
|
|
83
63
|
}
|
|
84
64
|
function getComment(symbol, kind, config, logger, commentStyle) {
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
return getJsDocComment(
|
|
65
|
+
const declarations = symbol.declarations || [];
|
|
66
|
+
if (declarations.length &&
|
|
67
|
+
declarations.every((d) => jsDocCommentKinds.includes(d.kind))) {
|
|
68
|
+
return getJsDocComment(declarations[0], config, logger);
|
|
89
69
|
}
|
|
90
|
-
const comment = getCommentImpl((0, discovery_1.discoverComment)(symbol, kind, logger, commentStyle), config, logger,
|
|
70
|
+
const comment = getCommentImpl((0, discovery_1.discoverComment)(symbol, kind, logger, commentStyle), config, logger, declarations.some(typescript_1.default.isSourceFile));
|
|
91
71
|
if (!comment && kind === models_1.ReflectionKind.Property) {
|
|
92
72
|
return getConstructorParamPropertyComment(symbol, config, logger, commentStyle);
|
|
93
73
|
}
|
|
@@ -95,7 +75,7 @@ function getComment(symbol, kind, config, logger, commentStyle) {
|
|
|
95
75
|
}
|
|
96
76
|
exports.getComment = getComment;
|
|
97
77
|
function getConstructorParamPropertyComment(symbol, config, logger, commentStyle) {
|
|
98
|
-
const decl = symbol.declarations?.find(
|
|
78
|
+
const decl = symbol.declarations?.find(typescript_1.default.isParameter);
|
|
99
79
|
if (!decl)
|
|
100
80
|
return;
|
|
101
81
|
const ctor = decl.parent;
|
|
@@ -113,7 +93,7 @@ function getJsDocComment(declaration, config, logger) {
|
|
|
113
93
|
const file = declaration.getSourceFile();
|
|
114
94
|
// First, get the whole comment. We know we'll need all of it.
|
|
115
95
|
let parent = declaration.parent;
|
|
116
|
-
while (!
|
|
96
|
+
while (!typescript_1.default.isJSDoc(parent)) {
|
|
117
97
|
parent = parent.parent;
|
|
118
98
|
}
|
|
119
99
|
// Then parse it.
|
|
@@ -121,17 +101,17 @@ function getJsDocComment(declaration, config, logger) {
|
|
|
121
101
|
file,
|
|
122
102
|
[
|
|
123
103
|
{
|
|
124
|
-
kind:
|
|
104
|
+
kind: typescript_1.default.SyntaxKind.MultiLineCommentTrivia,
|
|
125
105
|
pos: parent.pos,
|
|
126
106
|
end: parent.end,
|
|
127
107
|
},
|
|
128
108
|
],
|
|
129
109
|
], config, logger);
|
|
130
110
|
// And pull out the tag we actually care about.
|
|
131
|
-
if (
|
|
111
|
+
if (typescript_1.default.isJSDocEnumTag(declaration)) {
|
|
132
112
|
return new models_1.Comment(comment.getTag("@enum")?.content);
|
|
133
113
|
}
|
|
134
|
-
if (
|
|
114
|
+
if (typescript_1.default.isJSDocTemplateTag(declaration) &&
|
|
135
115
|
declaration.comment &&
|
|
136
116
|
declaration.typeParameters.length > 1) {
|
|
137
117
|
// We could just put the same comment on everything, but due to how comment parsing works,
|
|
@@ -141,7 +121,7 @@ function getJsDocComment(declaration, config, logger) {
|
|
|
141
121
|
return;
|
|
142
122
|
}
|
|
143
123
|
let name;
|
|
144
|
-
if (
|
|
124
|
+
if (typescript_1.default.isJSDocTemplateTag(declaration)) {
|
|
145
125
|
// This isn't really ideal.
|
|
146
126
|
name = declaration.typeParameters[0].name.text;
|
|
147
127
|
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/converter/comments/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAiC;AACjC,yCAAuD;AACvD,uCAAkD;AAElD,6CAA+C;AAC/C,2CAAwE;AACxE,2CAA8C;AAC9C,qCAAwC;AAQxC,MAAM,iBAAiB,GAAG;IACtB,EAAE,CAAC,UAAU,CAAC,gBAAgB;IAC9B,EAAE,CAAC,UAAU,CAAC,gBAAgB;IAC9B,EAAE,CAAC,UAAU,CAAC,eAAe;IAC7B,EAAE,CAAC,UAAU,CAAC,gBAAgB;IAC9B,EAAE,CAAC,UAAU,CAAC,YAAY;CAC7B,CAAC;AAEF,MAAM,YAAY,GAAG,IAAI,OAAO,EAAuC,CAAC;AAExE,SAAS,mBAAmB,CACxB,UAA0D,EAC1D,MAA2B,EAC3B,MAAc;IAEd,IAAI,CAAC,UAAU;QAAE,OAAO;IAExB,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,UAAU,CAAC;IAClC,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,EAAmB,CAAC;IACnE,IAAI,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE;QAC3B,OAAO,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAE,CAAC,KAAK,EAAE,CAAC;KAC5C;IAED,IAAI,OAAgB,CAAC;IACrB,QAAQ,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;QACpB,KAAK,EAAE,CAAC,UAAU,CAAC,sBAAsB;YACrC,OAAO,GAAG,IAAA,qBAAY,EAClB,IAAA,4BAAe,EAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EACxD,MAAM,EACN,IAAI,EACJ,MAAM,CACT,CAAC;YACF,MAAM;QACV,KAAK,EAAE,CAAC,UAAU,CAAC,uBAAuB;YACtC,OAAO,GAAG,IAAA,qBAAY,EAClB,IAAA,2BAAe,EAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,EAClC,MAAM,EACN,IAAI,EACJ,MAAM,CACT,CAAC;YACF,MAAM;QACV;YACI,IAAA,mBAAW,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;KACnC;IAED,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAClC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAE9B,OAAO,OAAO,CAAC,KAAK,EAAE,CAAC;AAC3B,CAAC;AAED,SAAS,cAAc,CACnB,aAA6D,EAC7D,MAA2B,EAC3B,MAAc,EACd,aAAsB;IAEtB,MAAM,OAAO,GAAG,mBAAmB,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAEnE,IAAI,aAAa,IAAI,OAAO,EAAE;QAC1B,gFAAgF;QAChF,6FAA6F;QAC7F,IACI,CAAC,OAAO,CAAC,WAAW,CAAC,uBAAuB,CAAC;YAC7C,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAC5B;YACE,OAAO;SACV;KACJ;IAED,IAAI,CAAC,aAAa,IAAI,OAAO,EAAE;QAC3B,qEAAqE;QACrE,IACI,OAAO,CAAC,WAAW,CAAC,uBAAuB,CAAC;YAC5C,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAC3B;YACE,OAAO;SACV;KACJ;IAED,OAAO,OAAO,CAAC;AACnB,CAAC;AAED,SAAgB,UAAU,CACtB,MAAiB,EACjB,IAAoB,EACpB,MAA2B,EAC3B,MAAc,EACd,YAA0B;IAE1B,IACI,MAAM;SACD,eAAe,EAAE;QAClB,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EACxD;QACE,OAAO,eAAe,CAClB,MAAM,CAAC,YAAa,CAAC,CAAC,CAA4B,EAClD,MAAM,EACN,MAAM,CACT,CAAC;KACL;IAED,MAAM,OAAO,GAAG,cAAc,CAC1B,IAAA,2BAAe,EAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,EACnD,MAAM,EACN,MAAM,EACN,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,KAAK,CACtD,CAAC;IAEF,IAAI,CAAC,OAAO,IAAI,IAAI,KAAK,uBAAc,CAAC,QAAQ,EAAE;QAC9C,OAAO,kCAAkC,CACrC,MAAM,EACN,MAAM,EACN,MAAM,EACN,YAAY,CACf,CAAC;KACL;IAED,OAAO,OAAO,CAAC;AACnB,CAAC;AApCD,gCAoCC;AAED,SAAS,kCAAkC,CACvC,MAAiB,EACjB,MAA2B,EAC3B,MAAc,EACd,YAA0B;IAE1B,MAAM,IAAI,GAAG,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;IACvD,IAAI,CAAC,IAAI;QAAE,OAAO;IAElB,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;IACzB,MAAM,OAAO,GAAG,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;IAExE,MAAM,QAAQ,GAAG,OAAO,EAAE,gBAAgB,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAClE,IAAI,QAAQ,EAAE;QACV,OAAO,IAAI,gBAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;KACxC;AACL,CAAC;AAED,SAAgB,mBAAmB,CAC/B,WAAwD,EACxD,MAA2B,EAC3B,MAAc,EACd,YAA0B;IAE1B,OAAO,cAAc,CACjB,IAAA,oCAAwB,EAAC,WAAW,EAAE,YAAY,CAAC,EACnD,MAAM,EACN,MAAM,EACN,KAAK,CACR,CAAC;AACN,CAAC;AAZD,kDAYC;AAED,SAAgB,eAAe,CAC3B,WAKqB,EACrB,MAA2B,EAC3B,MAAc;IAEd,MAAM,IAAI,GAAG,WAAW,CAAC,aAAa,EAAE,CAAC;IAEzC,8DAA8D;IAC9D,IAAI,MAAM,GAAY,WAAW,CAAC,MAAM,CAAC;IACzC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACxB,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;KAC1B;IAED,iBAAiB;IACjB,MAAM,OAAO,GAAG,mBAAmB,CAC/B;QACI,IAAI;QACJ;YACI;gBACI,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,sBAAsB;gBAC1C,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,GAAG,EAAE,MAAM,CAAC,GAAG;aAClB;SACJ;KACJ,EACD,MAAM,EACN,MAAM,CACR,CAAC;IAEH,+CAA+C;IAC/C,IAAI,EAAE,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE;QAChC,OAAO,IAAI,gBAAO,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;KACxD;IAED,IACI,EAAE,CAAC,kBAAkB,CAAC,WAAW,CAAC;QAClC,WAAW,CAAC,OAAO;QACnB,WAAW,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EACvC;QACE,0FAA0F;QAC1F,kGAAkG;QAClG,8BAA8B;QAC9B,MAAM,CAAC,IAAI,CACP,qGAAqG,EACrG,WAAW,CACd,CAAC;QACF,OAAO;KACV;IAED,IAAI,IAAwB,CAAC;IAC7B,IAAI,EAAE,CAAC,kBAAkB,CAAC,WAAW,CAAC,EAAE;QACpC,2BAA2B;QAC3B,IAAI,GAAG,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;KAClD;SAAM;QACH,IAAI,GAAG,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC;KACtC;IAED,IAAI,CAAC,IAAI,EAAE;QACP,OAAO;KACV;IAED,MAAM,GAAG,GAAG,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,IAAI,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAE3E,IAAI,CAAC,GAAG,EAAE;QACN,MAAM,CAAC,KAAK,CACR,gCAAgC,IAAI,mDAAmD,EACvF,WAAW,CACd,CAAC;KACL;SAAM;QACH,OAAO,IAAI,gBAAO,CAAC,gBAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;KAC9D;AACL,CAAC;AA5ED,0CA4EC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"lexer.d.ts","sourceRoot":"","sources":["../../../../src/lib/converter/comments/lexer.ts"],"names":[],"mappings":"AAAA,oBAAY,eAAe;IACvB,IAAI,SAAS;IACb,OAAO,aAAa;IACpB,SAAS,eAAe;IACxB,UAAU,gBAAgB;IAC1B,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,cAAc,SAAS;CAC1B;AAED,MAAM,WAAW,KAAK;IAClB,IAAI,EAAE,eAAe,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IAEb,GAAG,EAAE,MAAM,CAAC;CACf"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"lexer.js","sourceRoot":"","sources":["../../../../src/lib/converter/comments/lexer.ts"],"names":[],"mappings":";;;AAAA,IAAY,eAQX;AARD,WAAY,eAAe;IACvB,gCAAa,CAAA;IACb,uCAAoB,CAAA;IACpB,2CAAwB,CAAA;IACxB,6CAA0B,CAAA;IAC1B,8BAAW,CAAA;IACX,gCAAa,CAAA;IACb,0CAAuB,CAAA;AAC3B,CAAC,EARW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAQ1B"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"lineLexer.d.ts","sourceRoot":"","sources":["../../../../src/lib/converter/comments/lineLexer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,KAAK,EAAmB,MAAM,SAAS,CAAC;AAEjD,wBAAiB,eAAe,CAC5B,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,EAAE,CAAC,YAAY,EAAE,GAC1B,SAAS,CAAC,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,CA2BxC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"lineLexer.js","sourceRoot":"","sources":["../../../../src/lib/converter/comments/lineLexer.ts"],"names":[],"mappings":";;;AACA,mCAAiD;AAEjD,QAAe,CAAC,CAAC,eAAe,CAC5B,IAAY,EACZ,MAAyB;IAEzB,yEAAyE;IACzE,IAAI,SAA4B,CAAC;IACjC,KAAK,MAAM,KAAK,IAAI,gBAAgB,CAChC,IAAI,EACJ,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,EACb,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,CAChC,EAAE;QACC,IAAI,KAAK,CAAC,IAAI,KAAK,uBAAe,CAAC,IAAI,EAAE;YACrC,IAAI,SAAS,EAAE;gBACX,SAAS,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC;aAChC;iBAAM;gBACH,SAAS,GAAG,KAAK,CAAC;aACrB;SACJ;aAAM;YACH,IAAI,SAAS,EAAE;gBACX,MAAM,SAAS,CAAC;gBAChB,SAAS,GAAG,KAAK,CAAC,CAAC;aACtB;YACD,MAAM,KAAK,CAAC;SACf;KACJ;IAED,IAAI,SAAS,EAAE;QACX,MAAM,SAAS,CAAC;KACnB;IACD,OAAO;AACX,CAAC;AA9BD,0CA8BC;AAED,QAAQ,CAAC,CAAC,gBAAgB,CACtB,IAAY,EACZ,GAAW,EACX,GAAW;IAEX,sBAAsB;IACtB,OAAO,GAAG,GAAG,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE;QAC1C,GAAG,EAAE,CAAC;KACT;IAED,IAAI,SAAS,GAAG,IAAI,CAAC;IACrB,IAAI,eAAe,GAAG,KAAK,CAAC;IAE5B,SAAS;QACL,IAAI,SAAS,EAAE;YACX,GAAG,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAC;YACjC,SAAS,GAAG,KAAK,CAAC;SACrB;QAED,IAAI,GAAG,IAAI,GAAG,EAAE;YACZ,OAAO;SACV;QAED,QAAQ,IAAI,CAAC,GAAG,CAAC,EAAE;YACf,KAAK,IAAI;gBACL,MAAM,SAAS,CAAC,uBAAe,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;gBAC5C,SAAS,GAAG,IAAI,CAAC;gBACjB,MAAM;YAEV,KAAK,GAAG;gBACJ,IAAI,eAAe,IAAI,SAAS,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;oBAC/C,MAAM,SAAS,CACX,uBAAe,CAAC,cAAc,EAC9B,aAAa,CAAC,GAAG,CAAC,GAAG,GAAG,CAC3B,CAAC;oBACF,eAAe,GAAG,KAAK,CAAC;iBAC3B;qBAAM;oBACH,MAAM,SAAS,CAAC,uBAAe,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;iBACjD;gBACD,MAAM;YAEV,KAAK,GAAG;gBACJ,MAAM,SAAS,CAAC,uBAAe,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;gBAC/C,eAAe,GAAG,KAAK,CAAC;gBACxB,MAAM;YAEV,KAAK,GAAG,CAAC,CAAC;gBACN,+EAA+E;gBAC/E,0DAA0D;gBAC1D,oEAAoE;gBACpE,yDAAyD;gBACzD,sDAAsD;gBACtD,eAAe,GAAG,KAAK,CAAC;gBACxB,IAAI,SAAS,GAAG,CAAC,CAAC;gBAClB,IAAI,SAAS,GAAG,GAAG,CAAC;gBAEpB,OAAO,SAAS,GAAG,CAAC,GAAG,GAAG,IAAI,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;oBACvD,SAAS,EAAE,CAAC;oBACZ,SAAS,EAAE,CAAC;iBACf;gBACD,IAAI,cAAc,GAAG,GAAG,CAAC;gBACzB,MAAM,QAAQ,GAAa,EAAE,CAAC;gBAE9B,SAAS,EAAE,CAAC;gBACZ,OAAO,SAAS,GAAG,GAAG,EAAE;oBACpB,IAAI,sBAAsB,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE;wBAC9C,SAAS,IAAI,SAAS,CAAC;wBACvB,QAAQ,CAAC,IAAI,CACT,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,SAAS,CAAC,CAC5C,CAAC;wBACF,MAAM;4BACF,IAAI,EAAE,uBAAe,CAAC,IAAI;4BAC1B,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;4BACvB,GAAG;yBACN,CAAC;wBACF,GAAG,GAAG,SAAS,CAAC;wBAChB,MAAM;qBACT;yBAAM,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,GAAG,EAAE;wBAChC,OAAO,SAAS,GAAG,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,GAAG,EAAE;4BAC/C,SAAS,EAAE,CAAC;yBACf;qBACJ;yBAAM,IACH,IAAI,CAAC,SAAS,CAAC,KAAK,IAAI;wBACxB,SAAS,GAAG,CAAC,GAAG,GAAG;wBACnB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,KAAK,IAAI,EAC9B;wBACE,SAAS,IAAI,CAAC,CAAC;qBAClB;yBAAM,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,IAAI,EAAE;wBACjC,SAAS,EAAE,CAAC;wBACZ,QAAQ,CAAC,IAAI,CACT,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,SAAS,CAAC,CAC5C,CAAC;wBACF,SAAS,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;wBAC7C,cAAc,GAAG,SAAS,CAAC;qBAC9B;yBAAM;wBACH,SAAS,EAAE,CAAC;qBACf;iBACJ;gBAED,IAAI,SAAS,IAAI,GAAG,IAAI,GAAG,KAAK,SAAS,EAAE;oBACvC,IACI,SAAS,KAAK,CAAC;wBACf,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EACzC;wBACE,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC,CAAC;wBACnD,MAAM;4BACF,IAAI,EAAE,uBAAe,CAAC,IAAI;4BAC1B,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;4BACvB,GAAG;yBACN,CAAC;wBACF,GAAG,GAAG,SAAS,CAAC;qBACnB;yBAAM;wBACH,MAAM,SAAS,CAAC,uBAAe,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;qBACpD;iBACJ;gBAED,MAAM;aACT;YAED,KAAK,GAAG,CAAC,CAAC;gBACN,IAAI,SAAS,GAAG,GAAG,GAAG,CAAC,CAAC;gBACxB,OAAO,SAAS,GAAG,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE;oBACtD,SAAS,EAAE,CAAC;iBACf;gBAED,IAAI,SAAS,KAAK,GAAG,GAAG,CAAC,EAAE;oBACvB,OACI,SAAS,GAAG,GAAG;wBACf,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EACnC;wBACE,SAAS,EAAE,CAAC;qBACf;iBACJ;gBAED,IACI,SAAS,KAAK,GAAG,GAAG,CAAC;oBACrB,CAAC,SAAS,KAAK,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EACnD;oBACE,eAAe,GAAG,IAAI,CAAC;oBACvB,MAAM,SAAS,CAAC,uBAAe,CAAC,GAAG,EAAE,SAAS,GAAG,GAAG,CAAC,CAAC;oBACtD,MAAM;iBACT;aACJ;YACD,iEAAiE;YAEjE,OAAO,CAAC,CAAC;gBACL,MAAM,SAAS,GAAa,EAAE,CAAC;gBAE/B,IAAI,cAAc,GAAG,GAAG,CAAC;gBACzB,IAAI,SAAS,GAAG,GAAG,CAAC;gBACpB,OAAO,SAAS,GAAG,GAAG,EAAE;oBACpB,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;wBAAE,MAAM;oBAE7C,IACI,SAAS,KAAK,GAAG;wBACjB,IAAI,CAAC,SAAS,CAAC,KAAK,GAAG;wBACvB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EAChC;wBACE,uCAAuC;wBACvC,MAAM;qBACT;oBAED,IACI,IAAI,CAAC,SAAS,CAAC,KAAK,IAAI;wBACxB,SAAS,GAAG,CAAC,GAAG,GAAG;wBACnB,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EACtC;wBACE,SAAS,CAAC,IAAI,CACV,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,SAAS,CAAC,EACzC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CACtB,CAAC;wBACF,SAAS,EAAE,CAAC;wBACZ,cAAc,GAAG,SAAS,GAAG,CAAC,CAAC;qBAClC;oBAED,SAAS,EAAE,CAAC;iBACf;gBAED,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC,CAAC;gBAE1D,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE;oBAC3C,eAAe,GAAG,KAAK,CAAC;iBAC3B;gBAED,4DAA4D;gBAC5D,MAAM;oBACF,IAAI,EAAE,uBAAe,CAAC,IAAI;oBAC1B,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;oBACxB,GAAG;iBACN,CAAC;gBACF,GAAG,GAAG,SAAS,CAAC;gBAChB,MAAM;aACT;SACJ;KACJ;IAED,SAAS,SAAS,CAAC,IAAqB,EAAE,IAAY;QAClD,MAAM,KAAK,GAAG,GAAG,CAAC;QAClB,GAAG,IAAI,IAAI,CAAC;QAEZ,OAAO;YACH,IAAI;YACJ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC;YAChC,GAAG,EAAE,KAAK;SACb,CAAC;IACN,CAAC;IAED,SAAS,qBAAqB,CAAC,GAAW;QACtC,IAAI,SAAS,GAAG,GAAG,CAAC;QACpB,OAAO,SAAS,GAAG,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE;YAClD,SAAS,EAAE,CAAC;SACf;QACD,OAAO,SAAS,GAAG,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,GAAG,EAAE;YAC/C,SAAS,EAAE,CAAC;SACf;QACD,IAAI,SAAS,GAAG,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,GAAG,EAAE;YAC5C,SAAS,EAAE,CAAC;SACf;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,SAAS,sBAAsB,CAAC,GAAW,EAAE,CAAS;QAClD,IAAI,GAAG,GAAG,CAAC,GAAG,GAAG,EAAE;YACf,OAAO,KAAK,CAAC;SAChB;QAED,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC;IACxE,CAAC;IAED,SAAS,aAAa,CAAC,GAAW;QAC9B,IAAI,UAAU,GAAG,CAAC,CAAC;QAEnB,OAAO,GAAG,GAAG,GAAG,EAAE;YACd,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,EAAE;gBACnB,UAAU,EAAE,CAAC;aAChB;iBAAM,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,EAAE;gBAC1B,IAAI,EAAE,UAAU,KAAK,CAAC,EAAE;oBACpB,MAAM;iBACT;aACJ;iBAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE;gBACnC,GAAG,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;aAC9B;YAED,GAAG,EAAE,CAAC;SACT;QAED,IAAI,GAAG,GAAG,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,EAAE;YAChC,GAAG,EAAE,CAAC;SACT;QAED,OAAO,GAAG,CAAC;IACf,CAAC;IAED,SAAS,eAAe,CAAC,GAAW;QAChC,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9B,GAAG,EAAE,CAAC;QACN,OAAO,GAAG,GAAG,GAAG,EAAE;YACd,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE;gBAC3B,MAAM;aACT;iBAAM,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;gBAC3B,GAAG,EAAE,CAAC,CAAC,yBAAyB;aACnC;iBAAM,IACH,WAAW,KAAK,GAAG;gBACnB,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG;gBACjB,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,GAAG,EACvB;gBACE,0CAA0C;gBAC1C,OAAO,GAAG,GAAG,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,EAAE;oBACnC,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE;wBAC5B,GAAG,GAAG,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;qBAClC;yBAAM;wBACH,GAAG,EAAE,CAAC;qBACT;iBACJ;aACJ;YAED,GAAG,EAAE,CAAC;SACT;QAED,OAAO,GAAG,CAAC;IACf,CAAC;IAED,SAAS,SAAS,CAAC,GAAW;QAC1B,OAAO,GAAG,GAAG,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE;YACtC,GAAG,EAAE,CAAC;SACT;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;IACrB,CAAC;AACL,CAAC"}
|
|
@@ -1,4 +1,9 @@
|
|
|
1
1
|
import { Comment, CommentDisplayPart, Reflection } from "../../models";
|
|
2
2
|
import { DeclarationReference } from "./declarationReference";
|
|
3
|
-
export
|
|
4
|
-
|
|
3
|
+
export type ExternalResolveResult = {
|
|
4
|
+
target: string;
|
|
5
|
+
caption?: string;
|
|
6
|
+
};
|
|
7
|
+
export type ExternalSymbolResolver = (ref: DeclarationReference, refl: Reflection, part: Readonly<CommentDisplayPart> | undefined) => ExternalResolveResult | string | undefined;
|
|
8
|
+
export declare function resolveLinks(comment: Comment, reflection: Reflection, externalResolver: ExternalSymbolResolver): void;
|
|
9
|
+
export declare function resolvePartLinks(reflection: Reflection, parts: readonly CommentDisplayPart[], externalResolver: ExternalSymbolResolver): CommentDisplayPart[];
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"linkResolver.d.ts","sourceRoot":"","sources":["../../../../src/lib/converter/comments/linkResolver.ts"],"names":[],"mappings":"AACA,OAAO,EACH,OAAO,EACP,kBAAkB,EAGlB,UAAU,EACb,MAAM,cAAc,CAAC;AACtB,OAAO,EACH,oBAAoB,EAEvB,MAAM,wBAAwB,CAAC;AAKhC,wBAAgB,YAAY,CACxB,OAAO,EAAE,OAAO,EAChB,UAAU,EAAE,UAAU,EACtB,sBAAsB,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS,QAsB5E;AAED,wBAAgB,gBAAgB,CAC5B,UAAU,EAAE,UAAU,EACtB,KAAK,EAAE,SAAS,kBAAkB,EAAE,EACpC,sBAAsB,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS,GAC1E,kBAAkB,EAAE,CAItB"}
|