From 5e95bba29052dd9e6829107191d102efb3540170 Mon Sep 17 00:00:00 2001 From: tgreyuk Date: Tue, 26 Nov 2024 00:38:25 +0000 Subject: [PATCH] chore(core): updated docs --- .changeset/big-teachers-shave.md | 2 +- .changeset/chatty-cheetahs-love.md | 2 +- .github/workflows/ci.yml | 8 +- .gitignore | 2 +- devtools/packages/fixtures/README.md | 3 - devtools/packages/fixtures/models.ts | 7 - devtools/packages/fixtures/package.json | 12 - .../prebuild-options/tasks/generate-models.ts | 19 +- ...t-values.js => typedoc-default-values.mjs} | 9 +- devtools/typedoc-plugins/typedoc-symbols.mjs | 48 +- .../api-docs/Class.MarkdownPageEvent.mdx | 8 + .../api-docs/Class.MarkdownThemeContext.mdx | 113 +- .../pages/api-docs/Document.Local-Plugins.mdx | 2 +- .../Interface.MarkdownApplication.mdx | 4 +- .../api-docs/Interface.MarkdownRenderer.mdx | 6 +- .../api-docs/Interface.PluginOptions.mdx | 62 +- docs/pages/api-docs/Interface.UrlMapping.mdx | 6 + docs/pages/api-docs/index.mdx | 4 +- docs/pages/docs/CHANGELOG.md | 20 + docs/pages/docs/options.mdx | 6 +- docs/pages/docs/options/display-options.mdx | 48 +- docs/pages/docs/options/file-options.mdx | 39 +- docs/pages/docs/options/utility-options.mdx | 59 +- docs/pages/docs/typedoc-usage.mdx | 47 +- docs/pages/docs/versioning.mdx | 17 +- docs/public/schema.json | 153 +- package-lock.json | 169 +- package.json | 8 +- .../docusaurus-plugin-typedoc/OVERVIEW.md | 10 +- .../test/out/default/index.md | 7 + .../default/links/enumerations/CommentEnum.md | 13 + .../test/out/default/links/index.md | 12 + .../links/interfaces/CommentInterface.md | 31 + .../interfaces/CommentInterfaceExtended.md | 39 + .../out/default/module-1/classes/ClassA.md | 11 + .../out/default/module-1/classes/ClassB.md | 11 + .../test/out/default/module-1/index.md | 13 + .../default/module-1/interfaces/InterfaceA.md | 1 + .../default/module-1/interfaces/InterfaceB.md | 1 + .../out/default/module-2/classes/ClassA.md | 11 + .../out/default/module-2/classes/ClassB.md | 11 + .../test/out/default/module-2/index.md | 13 + .../default/module-2/interfaces/InterfaceA.md | 1 + .../default/module-2/interfaces/InterfaceB.md | 1 + .../test/out/default/typedoc-sidebar.cjs | 4 + .../out/global-members/classes/ClassA.mdx | 11 + .../out/global-members/classes/ClassB.mdx | 11 + .../test/out/global-members/index.mdx | 11 + .../global-members/interfaces/InterfaceA.mdx | 1 + .../global-members/interfaces/InterfaceB.mdx | 1 + .../out/global-members/typedoc-sidebar.cjs | 37 + .../test/out/links/index.md | 85 + .../test/out/links/typedoc-sidebar.cjs | 4 + .../__snapshots__/docusaurus.spec.ts.snap | 4 +- .../__snapshots__/github-wiki.spec.ts.snap | 2 +- .../test/out/default/_sidebar.md | 4 + .../test/out/default/home.md | 6 + .../out/default/module-1/classes/ClassA.md | 13 + .../out/default/module-1/classes/ClassB.md | 13 + .../test/out/default/module-1/home.md | 19 + .../default/module-1/interfaces/InterfaceA.md | 3 + .../default/module-1/interfaces/InterfaceB.md | 3 + .../module-1/namespaces/Validation/home.md | 9 + .../interfaces/NamespaceInterface.md | 9 + .../out/default/module-2/classes/ClassA.md | 13 + .../out/default/module-2/classes/ClassB.md | 13 + .../test/out/default/module-2/home.md | 15 + .../default/module-2/interfaces/InterfaceA.md | 3 + .../default/module-2/interfaces/InterfaceB.md | 3 + .../test/out/globals/_sidebar.md | 11 + .../test/out/globals/classes/ClassA.md | 13 + .../test/out/globals/classes/ClassB.md | 13 + .../test/out/globals/home.md | 11 + .../test/out/globals/interfaces/InterfaceA.md | 3 + .../test/out/globals/interfaces/InterfaceB.md | 3 + .../test/out/single-modules/_sidebar.md | 4 + .../test/out/single-modules/home.md | 6 + .../test/out/single-modules/module-1/home.md | 45 + .../module-1/namespaces/Validation.md | 13 + .../test/out/single-modules/module-2.md | 39 + .../test/out/single-page/home.md | 37 + .../__snapshots__/gitlab-wiki.spec.ts.snap | 2 +- .../test/out/no-data/README.md | 1 + .../test/out/no-data/globals.md | 5 + .../out/no-data/interfaces/SomeInterface.md | 9 + .../test/out/options-2/README.md | 9 + .../test/out/options-2/globals.md | 13 + .../out/options-2/interfaces/SomeInterface.md | 18 + .../test/out/options/README.md | 8 + .../test/out/options/globals.md | 12 + .../out/options/interfaces/SomeInterface.md | 10 + packages/typedoc-plugin-markdown/.gitignore | 3 +- .../.scripts/schema/generate-schema.ts | 5 + packages/typedoc-plugin-markdown/CHANGELOG.md | 23 + .../barrelsby.config.json | 15 - packages/typedoc-plugin-markdown/package.json | 14 +- .../typedoc-plugin-markdown/src/_typedoc.d.ts | 12 +- .../src/events/markdown-page-event.ts | 2 +- packages/typedoc-plugin-markdown/src/index.ts | 7 +- .../src/internationalization/locales/en.ts | 1 - .../src/internationalization/locales/jp.ts | 1 - .../src/internationalization/locales/ko.ts | 1 - .../src/internationalization/locales/zh.ts | 1 - .../src/options/constants.ts | 6 + .../src/options/declarations.ts | 154 +- .../src/options/maps.ts | 2 +- .../theme/context/helpers/get-project-name.ts | 5 +- .../context/partials/member.constructors.ts | 5 +- .../context/partials/page.breadcrumbs.ts | 16 +- .../src/theme/context/partials/page.header.ts | 76 +- .../theme/context/partials/page.pageTitle.ts | 16 +- .../src/theme/context/resources.ts | 2 + .../src/types/internationalization.ts | 1 - .../src/types/markdown-application.ts | 2 +- .../src/types/markdown-renderer.ts | 2 +- .../src/types/options.ts | 17 +- .../supporting-docs/public/local-plugins.md | 2 +- .../test/__scripts__/build-fixtures.mjs | 111 +- .../{scripts => __scripts__/lint}/lint.md.mjs | 0 .../lint}/lint.mdx.mjs | 0 .../test/fixtures/{config.ts => config.mjs} | 11 +- .../out/comments/members/opts-1/README.md | 111 + .../members/opts-1/_media/PROJECT_DOC_1.md | 8 + .../comments/members/opts-1/_media/logo.png | Bin 0 -> 1294 bytes .../comments/members/opts-1/_media/logo.svg | 1 + .../opts-1/classes/BaseClassProperties.md | 22 + .../opts-1/classes/ClassPropertiesTable.md | 30 + .../opts-1/enumerations/CommentEnum.md | 8 + .../opts-1/enumerations/EnumMembersTable.md | 7 + .../members/opts-1/functions/constFunction.md | 23 + .../functions/constFunctionWithReturns.md | 25 + .../opts-1/functions/functionWithBlockTags.md | 34 + .../opts-1/functions/multipleExampleTags.md | 30 + .../opts-1/functions/parametersTable.md | 27 + .../opts-1/functions/singleExampleTag.md | 24 + .../interfaces/BaseInterfaceProperties.md | 27 + .../opts-1/interfaces/CommentInterface.md | 25 + .../interfaces/CommentInterfaceExtended.md | 43 + .../interfaces/InterfacePropertiesTable.md | 96 + .../members/opts-1/interfaces/SameName.md | 21 + .../out/comments/members/opts-1/sidebar.json | 147 + .../type-aliases/TypeDeclarationTable.md | 15 + .../opts-1/type-aliases/TypeWithGenerics.md | 14 + .../opts-1/type-aliases/typeWithBlockTags.md | 25 + .../members/opts-1/variables/SameName.md | 7 + .../opts-1/variables/TypeDeclarationTable.md | 14 + .../comments/members/opts-1/variables/prop.md | 7 + .../opts-1/variables/prop_with_underscore.md | 7 + .../members/opts-1/variables/propb.md | 7 + .../opts-2/Class.BaseClassProperties.md | 65 + .../opts-2/Class.ClassPropertiesTable.md | 149 + .../members/opts-2/Enumeration.CommentEnum.md | 59 + .../opts-2/Enumeration.EnumMembersTable.md | 32 + .../members/opts-2/Function.constFunction.md | 48 + .../Function.constFunctionWithReturns.md | 50 + .../opts-2/Function.functionWithBlockTags.md | 64 + .../opts-2/Function.multipleExampleTags.md | 30 + .../opts-2/Function.parametersTable.md | 106 + .../opts-2/Function.singleExampleTag.md | 24 + .../Interface.BaseInterfaceProperties.md | 53 + .../opts-2/Interface.CommentInterface.md | 42 + .../Interface.CommentInterfaceExtended.md | 54 + .../Interface.InterfacePropertiesTable.md | 165 + .../members/opts-2/Interface.SameName.md | 38 + .../out/comments/members/opts-2/README.md | 111 + .../opts-2/TypeAlias.TypeDeclarationTable.md | 74 + .../opts-2/TypeAlias.TypeWithGenerics.md | 33 + .../opts-2/TypeAlias.typeWithBlockTags.md | 44 + .../members/opts-2/Variable.SameName.md | 7 + .../opts-2/Variable.TypeDeclarationTable.md | 55 + .../opts-2/Variable._prop_with_underscore.md | 7 + .../comments/members/opts-2/Variable.prop.md | 7 + .../comments/members/opts-2/Variable.propb.md | 7 + .../members/opts-2/_media/PROJECT_DOC_1.md | 8 + .../comments/members/opts-2/_media/logo.png | Bin 0 -> 1294 bytes .../comments/members/opts-2/_media/logo.svg | 1 + .../out/comments/members/opts-2/sidebar.json | 147 + .../out/comments/modules/opts-1/README.md | 657 ++++ .../modules/opts-1/_media/PROJECT_DOC_1.md | 8 + .../comments/modules/opts-1/_media/logo.png | Bin 0 -> 1294 bytes .../comments/modules/opts-1/_media/logo.svg | 1 + .../out/comments/modules/opts-1/sidebar.json | 1 + .../out/comments/modules/opts-2/README.md | 1398 +++++++ .../modules/opts-2/_media/PROJECT_DOC_1.md | 8 + .../comments/modules/opts-2/_media/logo.png | Bin 0 -> 1294 bytes .../comments/modules/opts-2/_media/logo.svg | 1 + .../out/comments/modules/opts-2/sidebar.json | 1 + .../out/customize/members/opts-1/README.md | 25 + .../members/opts-1/functions/someFunction.md | 23 + .../members/opts-1/post-render-async-job.txt | 1 + .../members/opts-1/pre-render-async-job.txt | 1 + .../members/opts-1/renderer-event-begin.txt | 1 + .../members/opts-1/renderer-event-end.txt | 1 + .../out/customize/members/opts-1/sidebar.json | 12 + .../opts-1/ModuleWithDocuments1/README.md | 36 + .../classes/ClassWithDocuments.md | 11 + .../classes/documents/CLASS_DOC.md | 5 + .../documents/MODULE_DOC.md | 5 + .../enumerations/EnumWithDocuments.md | 13 + .../enumerations/documents/ENUM_DOC.md | 5 + .../functions/documents/FUNCTION_DOC_1.md | 5 + .../functions/documents/FUNCTION_DOC_2.md | 5 + .../functions/documents/FUNCTION_DOC_3.md | 5 + .../functions/functionWithDocuments.md | 13 + .../multipleFunctionWithDocuments.md | 35 + .../interfaces/InterfaceWithDocuments.md | 13 + .../interfaces/documents/INTERFACE_DOC.md | 5 + .../NamespaceWithDocuments/README.md | 11 + .../classes/NamespaceClassWithDocuments.md | 11 + .../classes/documents/CLASS_DOC.md | 5 + .../documents/NAMESPACE_DOC.md | 5 + .../type-aliases/TypeWithDocuments.md | 9 + .../type-aliases/documents/TYPE_DOC.md | 5 + .../variables/documents/VARIABLE_DOC.md | 5 + .../variables/variableWithDocuments.md | 9 + .../opts-1/ModuleWithDocuments2/README.md | 32 + .../classes/ClassWithDocuments.md | 11 + .../classes/documents/CLASS_DOC.md | 5 + .../documents/MODULE_DOC.md | 5 + .../enumerations/EnumWithDocuments.md | 13 + .../enumerations/documents/ENUM_DOC.md | 5 + .../functions/documents/FUNCTION_DOC_1.md | 5 + .../functions/documents/FUNCTION_DOC_2.md | 5 + .../functions/documents/FUNCTION_DOC_3.md | 5 + .../functions/functionWithDocuments.md | 13 + .../multipleFunctionWithDocuments.md | 35 + .../interfaces/InterfaceWithDocuments.md | 13 + .../interfaces/documents/INTERFACE_DOC.md | 5 + .../type-aliases/TypeWithDocuments.md | 9 + .../type-aliases/documents/TYPE_DOC.md | 5 + .../variables/documents/VARIABLE_DOC.md | 5 + .../variables/variableWithDocuments.md | 9 + .../out/documents/members/opts-1/README.md | 12 + .../opts-1/documents/Project-Document-1.md | 5 + .../documents/docs/project/PROJECT_DOC_2.md | 5 + .../documents/docs/project/PROJECT_DOC_3.md | 5 + .../out/documents/members/opts-1/sidebar.json | 308 ++ .../opts-2/Document.Project-Document-1.md | 5 + .../Document.docs.project.PROJECT_DOC_2.md | 5 + .../Document.docs.project.PROJECT_DOC_3.md | 5 + ...WithDocuments1.Class.ClassWithDocuments.md | 32 + ...1.ClassWithDocuments.Document.CLASS_DOC.md | 5 + ...oduleWithDocuments1.Document.MODULE_DOC.md | 5 + ...ts1.EnumWithDocuments.Document.ENUM_DOC.md | 5 + ...ocuments1.Enumeration.EnumWithDocuments.md | 34 + ...cuments1.Function.functionWithDocuments.md | 34 + ....Function.multipleFunctionWithDocuments.md | 78 + ...ments1.Interface.InterfaceWithDocuments.md | 34 + ...aceWithDocuments.Document.INTERFACE_DOC.md | 5 + ...ments1.Namespace.NamespaceWithDocuments.md | 53 + ...ments.Class.NamespaceClassWithDocuments.md | 32 + ...aceWithDocuments.Document.NAMESPACE_DOC.md | 5 + ...ceClassWithDocuments.Document.CLASS_DOC.md | 5 + ...hDocuments1.TypeAlias.TypeWithDocuments.md | 30 + ...ts1.TypeWithDocuments.Document.TYPE_DOC.md | 5 + ...cuments1.Variable.variableWithDocuments.md | 30 + ...onWithDocuments.Document.FUNCTION_DOC_1.md | 5 + .../members/opts-2/ModuleWithDocuments1.md | 215 ++ ...onWithDocuments.Document.FUNCTION_DOC_1.md | 5 + ...onWithDocuments.Document.FUNCTION_DOC_2.md | 5 + ...onWithDocuments.Document.FUNCTION_DOC_3.md | 5 + ...ableWithDocuments.Document.VARIABLE_DOC.md | 5 + ...WithDocuments2.Class.ClassWithDocuments.md | 32 + ...2.ClassWithDocuments.Document.CLASS_DOC.md | 5 + ...oduleWithDocuments2.Document.MODULE_DOC.md | 5 + ...ts2.EnumWithDocuments.Document.ENUM_DOC.md | 5 + ...ocuments2.Enumeration.EnumWithDocuments.md | 34 + ...cuments2.Function.functionWithDocuments.md | 34 + ....Function.multipleFunctionWithDocuments.md | 78 + ...ments2.Interface.InterfaceWithDocuments.md | 34 + ...aceWithDocuments.Document.INTERFACE_DOC.md | 5 + ...hDocuments2.TypeAlias.TypeWithDocuments.md | 30 + ...ts2.TypeWithDocuments.Document.TYPE_DOC.md | 5 + ...cuments2.Variable.variableWithDocuments.md | 30 + ...onWithDocuments.Document.FUNCTION_DOC_1.md | 5 + .../members/opts-2/ModuleWithDocuments2.md | 190 + ...onWithDocuments.Document.FUNCTION_DOC_1.md | 5 + ...onWithDocuments.Document.FUNCTION_DOC_2.md | 5 + ...onWithDocuments.Document.FUNCTION_DOC_3.md | 5 + ...ableWithDocuments.Document.VARIABLE_DOC.md | 5 + .../out/documents/members/opts-2/README.md | 87 + .../out/documents/members/opts-2/sidebar.json | 308 ++ .../opts-1/ModuleWithDocuments1/README.md | 121 + .../documents/Class.CLASS_DOC.md | 5 + .../documents/Enumeration.ENUM_DOC.md | 5 + .../documents/Function.FUNCTION_DOC_1.md | 5 + .../documents/Function.FUNCTION_DOC_2.md | 5 + .../documents/Function.FUNCTION_DOC_3.md | 5 + .../documents/Interface.INTERFACE_DOC.md | 5 + .../documents/MODULE_DOC.md | 5 + .../documents/TypeAlias.TYPE_DOC.md | 5 + .../documents/Variable.VARIABLE_DOC.md | 5 + .../NamespaceWithDocuments/README.md | 19 + .../documents/Class.CLASS_DOC.md | 5 + .../documents/NAMESPACE_DOC.md | 5 + .../opts-1/ModuleWithDocuments2/README.md | 117 + .../documents/Class.CLASS_DOC.md | 5 + .../documents/Enumeration.ENUM_DOC.md | 5 + .../documents/Function.FUNCTION_DOC_1.md | 5 + .../documents/Function.FUNCTION_DOC_2.md | 5 + .../documents/Function.FUNCTION_DOC_3.md | 5 + .../documents/Interface.INTERFACE_DOC.md | 5 + .../documents/MODULE_DOC.md | 5 + .../documents/TypeAlias.TYPE_DOC.md | 5 + .../documents/Variable.VARIABLE_DOC.md | 5 + .../out/documents/modules/opts-1/README.md | 12 + .../opts-1/documents/Project-Document-1.md | 5 + .../documents/docs/project/PROJECT_DOC_2.md | 5 + .../documents/docs/project/PROJECT_DOC_3.md | 5 + .../out/documents/modules/opts-1/sidebar.json | 63 + .../opts-2/Document.Class.CLASS_DOC.md | 5 + .../opts-2/Document.Enumeration.ENUM_DOC.md | 5 + .../Document.Function.FUNCTION_DOC_1.md | 5 + .../Document.Function.FUNCTION_DOC_2.md | 5 + .../Document.Function.FUNCTION_DOC_3.md | 5 + .../Document.Interface.INTERFACE_DOC.md | 5 + .../opts-2/Document.Project-Document-1.md | 5 + .../opts-2/Document.TypeAlias.TYPE_DOC.md | 5 + .../opts-2/Document.Variable.VARIABLE_DOC.md | 5 + .../Document.docs.project.PROJECT_DOC_2.md | 5 + .../Document.docs.project.PROJECT_DOC_3.md | 5 + ...oduleWithDocuments1.Document.MODULE_DOC.md | 5 + ...ments1.Namespace.NamespaceWithDocuments.md | 61 + ...aceWithDocuments.Document.NAMESPACE_DOC.md | 5 + .../modules/opts-2/ModuleWithDocuments1.md | 332 ++ ...oduleWithDocuments2.Document.MODULE_DOC.md | 5 + .../modules/opts-2/ModuleWithDocuments2.md | 307 ++ .../out/documents/modules/opts-2/README.md | 87 + .../out/documents/modules/opts-2/sidebar.json | 63 + .../opts-1/ModuleWithDocuments1/README.md | 36 + .../classes/ClassWithDocuments.md | 11 + .../classes/documents/CLASS_DOC.md | 5 + .../documents/MODULE_DOC.md | 5 + .../enumerations/EnumWithDocuments.md | 13 + .../enumerations/documents/ENUM_DOC.md | 5 + .../functions/documents/FUNCTION_DOC_1.md | 5 + .../functions/documents/FUNCTION_DOC_2.md | 5 + .../functions/documents/FUNCTION_DOC_3.md | 5 + .../functions/functionWithDocuments.md | 13 + .../multipleFunctionWithDocuments.md | 35 + .../interfaces/InterfaceWithDocuments.md | 13 + .../interfaces/documents/INTERFACE_DOC.md | 5 + .../NamespaceWithDocuments/README.md | 11 + .../classes/NamespaceClassWithDocuments.md | 11 + .../classes/documents/CLASS_DOC.md | 5 + .../documents/NAMESPACE_DOC.md | 5 + .../type-aliases/TypeWithDocuments.md | 9 + .../type-aliases/documents/TYPE_DOC.md | 5 + .../variables/documents/VARIABLE_DOC.md | 5 + .../variables/variableWithDocuments.md | 9 + .../members/opts-1/README.md | 9 + .../opts-1/documents/Project-Document-1.md | 5 + .../members/opts-1/sidebar.json | 172 + .../opts-2/ModuleWithDocuments1/README.md | 52 + .../classes/ClassWithDocuments.md | 13 + .../classes/documents/CLASS_DOC.md | 5 + .../documents/MODULE_DOC.md | 5 + .../enumerations/EnumWithDocuments.md | 15 + .../enumerations/documents/ENUM_DOC.md | 5 + .../functions/documents/FUNCTION_DOC_1.md | 5 + .../functions/documents/FUNCTION_DOC_2.md | 5 + .../functions/documents/FUNCTION_DOC_3.md | 5 + .../functions/functionWithDocuments.md | 15 + .../multipleFunctionWithDocuments.md | 37 + .../interfaces/InterfaceWithDocuments.md | 15 + .../interfaces/documents/INTERFACE_DOC.md | 5 + .../NamespaceWithDocuments/README.md | 15 + .../classes/NamespaceClassWithDocuments.md | 13 + .../classes/documents/CLASS_DOC.md | 5 + .../documents/NAMESPACE_DOC.md | 5 + .../type-aliases/TypeWithDocuments.md | 11 + .../type-aliases/documents/TYPE_DOC.md | 5 + .../variables/documents/VARIABLE_DOC.md | 5 + .../variables/variableWithDocuments.md | 11 + .../members/opts-2/README.md | 13 + .../opts-2/documents/Project-Document-1.md | 5 + .../members/opts-2/sidebar.json | 172 + .../opts-1/ModuleWithDocuments1/README.md | 121 + .../documents/Class.CLASS_DOC.md | 5 + .../documents/Enumeration.ENUM_DOC.md | 5 + .../documents/Function.FUNCTION_DOC_1.md | 5 + .../documents/Function.FUNCTION_DOC_2.md | 5 + .../documents/Function.FUNCTION_DOC_3.md | 5 + .../documents/Interface.INTERFACE_DOC.md | 5 + .../documents/MODULE_DOC.md | 5 + .../documents/TypeAlias.TYPE_DOC.md | 5 + .../documents/Variable.VARIABLE_DOC.md | 5 + .../NamespaceWithDocuments/README.md | 19 + .../documents/Class.CLASS_DOC.md | 5 + .../documents/NAMESPACE_DOC.md | 5 + .../modules/opts-1/README.md | 9 + .../opts-1/documents/Project-Document-1.md | 5 + .../modules/opts-1/sidebar.json | 41 + .../opts-2/ModuleWithDocuments1/README.md | 139 + .../documents/Class.CLASS_DOC.md | 5 + .../documents/Enumeration.ENUM_DOC.md | 5 + .../documents/Function.FUNCTION_DOC_1.md | 5 + .../documents/Function.FUNCTION_DOC_2.md | 5 + .../documents/Function.FUNCTION_DOC_3.md | 5 + .../documents/Interface.INTERFACE_DOC.md | 5 + .../documents/MODULE_DOC.md | 5 + .../documents/TypeAlias.TYPE_DOC.md | 5 + .../documents/Variable.VARIABLE_DOC.md | 5 + .../NamespaceWithDocuments/README.md | 23 + .../documents/Class.CLASS_DOC.md | 5 + .../documents/NAMESPACE_DOC.md | 5 + .../modules/opts-2/README.md | 13 + .../opts-2/documents/Project-Document-1.md | 5 + .../modules/opts-2/sidebar.json | 41 + .../out/entryfiles/members/opts-1/.nojekyll | 0 .../members/opts-1/@scope/module-1/README.mdx | 13 + .../@scope/module-1/classes/ModuleClass.mdx | 17 + .../out/entryfiles/members/opts-1/README.mdx | 11 + .../entry-module/classes/ModuleClass.mdx | 17 + .../members/opts-1/module-2/README.mdx | 13 + .../opts-1/module-2/classes/ModuleClass.mdx | 17 + .../out/entryfiles/members/opts-1/readme_.mdx | 15 + .../entryfiles/members/opts-1/sidebar.json | 36 + .../entry-module/classes/ModuleClass.mdx | 17 + .../out/entryfiles/members/opts-2/index.mdx | 11 + .../opts-2/module-1/classes/ModuleClass.mdx | 17 + .../members/opts-2/module-1/index.mdx | 13 + .../opts-2/module-2/classes/ModuleClass.mdx | 17 + .../members/opts-2/module-2/index.mdx | 13 + .../entryfiles/members/opts-2/sidebar.json | 36 + .../out/entryfiles/modules/opts-1/.nojekyll | 0 .../modules/opts-1/@scope/module-1.mdx | 21 + .../out/entryfiles/modules/opts-1/README.mdx | 19 + .../entryfiles/modules/opts-1/module-2.mdx | 21 + .../out/entryfiles/modules/opts-1/readme_.mdx | 15 + .../entryfiles/modules/opts-1/sidebar.json | 12 + .../out/entryfiles/modules/opts-2/index.mdx | 19 + .../entryfiles/modules/opts-2/module-1.mdx | 21 + .../entryfiles/modules/opts-2/module-2.mdx | 21 + .../entryfiles/modules/opts-2/sidebar.json | 12 + .../groups/members/opts-1/-internal-/index.md | 7 + .../members/opts-1/42-module-name/index.md | 7 + .../members/opts-1/basic/classes/ClassA.md | 15 + .../members/opts-1/basic/classes/ClassB.md | 13 + .../opts-1/basic/enumerations/EnumA.md | 9 + .../opts-1/basic/enumerations/EnumB.md | 7 + .../opts-1/basic/functions/functionA.md | 9 + .../out/groups/members/opts-1/basic/index.md | 52 + .../opts-1/basic/interfaces/InterfaceA.md | 32 + .../opts-1/basic/interfaces/InterfaceB.md | 9 + .../opts-1/basic/type-aliases/TypeA.md | 9 + .../opts-1/basic/type-aliases/TypeB.md | 9 + .../opts-1/basic/variables/variableA.md | 9 + .../opts-1/basic/variables/variableB.md | 9 + .../enumerations/CategoryAEnum1.md | 7 + .../enumerations/CategoryAEnum2.md | 7 + .../enumerations/CategoryBEnum1.md | 7 + .../enumerations/CategoryBEnum2.md | 7 + .../enumerations/UnCategorizedEnum.md | 7 + .../members/opts-1/has-categories/index.md | 62 + .../interfaces/CategoryAInterface1.md | 7 + .../interfaces/CategoryAInterface2.md | 7 + .../interfaces/CategoryBInterface1.md | 7 + .../interfaces/CategoryBInterface2.md | 7 + .../interfaces/CategoryCInterface1.md | 7 + .../interfaces/CategoryCInterface2.md | 7 + .../interfaces/UnCategorizedInterace.md | 7 + .../members/opts-1/has-custom-groups/index.md | 30 + .../has-custom-groups/variables/variabelA.md | 9 + .../has-custom-groups/variables/variableB1.md | 9 + .../has-custom-groups/variables/variableB2.md | 9 + .../has-custom-groups/variables/variableC.md | 9 + .../opts-1/has-namespaces/classes/ClassB.md | 13 + .../opts-1/has-namespaces/classes/Class_A.md | 13 + .../has-namespaces/enumerations/EnumB.md | 7 + .../has-namespaces/enumerations/Enum_A.md | 7 + .../has-namespaces/functions/functionB.md | 9 + .../has-namespaces/functions/function_A.md | 9 + .../members/opts-1/has-namespaces/index.md | 60 + .../has-namespaces/interfaces/InterfaceB.md | 7 + .../has-namespaces/interfaces/Interface_A.md | 7 + .../namespaces/NamespaceB/index.md | 7 + .../namespaces/Namespace_A/index.md | 21 + .../interfaces/NamespaceInterface.md | 7 + .../namespaces/NestedNamespace/index.md | 15 + .../interfaces/NamespaceInterface.md | 7 + .../has-namespaces/type-aliases/TypeB.md | 9 + .../has-namespaces/type-aliases/Type_A.md | 9 + .../has-namespaces/variables/variableB.md | 9 + .../has-namespaces/variables/variable_A.md | 9 + .../functions/defaultFunction.md | 9 + .../members/opts-1/has-references/index.md | 35 + .../has-same-exports/classes/SomeClass-1.md | 13 + .../has-same-exports/classes/someClass.md | 13 + .../functions/someFunction.md | 9 + .../members/opts-1/has-same-exports/index.md | 28 + .../out/groups/members/opts-1/index.md | 13 + .../members/opts-1/index/classes/SomeClass.md | 13 + .../out/groups/members/opts-1/index/index.md | 17 + .../out/groups/members/opts-1/modules.md | 19 + .../out/groups/members/opts-1/sidebar.json | 310 ++ .../groups/members/opts-2/-internal-/index.md | 7 + .../members/opts-2/42-module-name/index.md | 7 + .../members/opts-2/basic/classes/ClassA.md | 17 + .../members/opts-2/basic/classes/ClassB.md | 15 + .../opts-2/basic/enumerations/EnumA.md | 9 + .../opts-2/basic/enumerations/EnumB.md | 7 + .../opts-2/basic/functions/functionA.md | 9 + .../out/groups/members/opts-2/basic/index.md | 211 ++ .../opts-2/basic/interfaces/InterfaceA.md | 36 + .../opts-2/basic/interfaces/InterfaceB.md | 9 + .../opts-2/basic/type-aliases/TypeA.md | 9 + .../opts-2/basic/type-aliases/TypeB.md | 9 + .../enumerations/CategoryAEnum1.md | 7 + .../enumerations/CategoryAEnum2.md | 7 + .../enumerations/CategoryBEnum1.md | 7 + .../enumerations/CategoryBEnum2.md | 7 + .../enumerations/UnCategorizedEnum.md | 7 + .../members/opts-2/has-categories/index.md | 207 + .../interfaces/CategoryAInterface1.md | 7 + .../interfaces/CategoryAInterface2.md | 7 + .../interfaces/CategoryBInterface1.md | 7 + .../interfaces/CategoryBInterface2.md | 7 + .../interfaces/CategoryCInterface1.md | 7 + .../interfaces/CategoryCInterface2.md | 7 + .../interfaces/UnCategorizedInterace.md | 7 + .../members/opts-2/has-custom-groups/index.md | 39 + .../opts-2/has-namespaces/classes/ClassB.md | 15 + .../opts-2/has-namespaces/classes/Class_A.md | 15 + .../has-namespaces/enumerations/EnumB.md | 7 + .../has-namespaces/enumerations/Enum_A.md | 7 + .../has-namespaces/functions/functionB.md | 9 + .../has-namespaces/functions/function_A.md | 9 + .../members/opts-2/has-namespaces/index.md | 247 ++ .../has-namespaces/interfaces/InterfaceB.md | 7 + .../has-namespaces/interfaces/Interface_A.md | 7 + .../namespaces/NamespaceB/index.md | 7 + .../namespaces/Namespace_A/index.md | 59 + .../interfaces/NamespaceInterface.md | 7 + .../namespaces/NestedNamespace/index.md | 34 + .../interfaces/NamespaceInterface.md | 7 + .../has-namespaces/type-aliases/TypeB.md | 9 + .../has-namespaces/type-aliases/Type_A.md | 9 + .../functions/defaultFunction.md | 9 + .../members/opts-2/has-references/index.md | 58 + .../has-same-exports/classes/SomeClass-1.md | 15 + .../has-same-exports/classes/someClass.md | 15 + .../functions/someFunction.md | 9 + .../members/opts-2/has-same-exports/index.md | 96 + .../out/groups/members/opts-2/index.md | 126 + .../members/opts-2/index/classes/SomeClass.md | 15 + .../out/groups/members/opts-2/index/index.md | 36 + .../out/groups/members/opts-2/sidebar.json | 388 ++ .../out/groups/modules/opts-1/-internal-.md | 7 + .../groups/modules/opts-1/42-module-name.md | 7 + .../out/groups/modules/opts-1/basic.md | 104 + .../groups/modules/opts-1/has-categories.md | 61 + .../modules/opts-1/has-custom-groups.md | 33 + .../modules/opts-1/has-namespaces/index.md | 90 + .../has-namespaces/namespaces/NamespaceB.md | 7 + .../namespaces/Namespace_A/index.md | 19 + .../Namespace_A/namespaces/NestedNamespace.md | 11 + .../groups/modules/opts-1/has-references.md | 29 + .../groups/modules/opts-1/has-same-exports.md | 39 + .../out/groups/modules/opts-1/index.md | 13 + .../out/groups/modules/opts-1/module_index.md | 19 + .../out/groups/modules/opts-1/modules.md | 19 + .../out/groups/modules/opts-1/sidebar.json | 66 + .../out/groups/modules/opts-2/-internal-.md | 7 + .../groups/modules/opts-2/42-module-name.md | 7 + .../out/groups/modules/opts-2/basic.md | 132 + .../groups/modules/opts-2/has-categories.md | 81 + .../modules/opts-2/has-custom-groups.md | 39 + .../modules/opts-2/has-namespaces/index.md | 146 + .../has-namespaces/namespaces/NamespaceB.md | 7 + .../namespaces/Namespace_A/index.md | 38 + .../Namespace_A/namespaces/NestedNamespace.md | 11 + .../groups/modules/opts-2/has-references.md | 35 + .../groups/modules/opts-2/has-same-exports.md | 49 + .../out/groups/modules/opts-2/index.md | 126 + .../out/groups/modules/opts-2/module_index.md | 21 + .../out/groups/modules/opts-2/sidebar.json | 76 + .../out/modules/members/opts-1/README.md | 9 + .../members/opts-1/Test_Module_Name/README.md | 7 + .../Test_Module_Name/interfaces/InterfaceA.md | 1 + .../module-1/submodules/submodule-1/README.md | 23 + .../submodules/submodule-1/classes/ClassA.md | 11 + .../submodules/submodule-1/classes/ClassB.md | 11 + .../submodule-1/enumerations/EnumA.md | 1 + .../submodule-1/enumerations/EnumB.md | 1 + .../submodule-1/interfaces/InterfaceA.md | 13 + .../submodule-1/interfaces/InterfaceB.md | 1 + .../submodule-1/type-aliases/TypeA.md | 3 + .../submodule-1/type-aliases/TypeB.md | 3 + .../module-1/submodules/submodule-2/README.md | 23 + .../submodules/submodule-2/classes/ClassA.md | 11 + .../submodules/submodule-2/classes/ClassB.md | 11 + .../submodule-2/enumerations/EnumA.md | 1 + .../submodule-2/enumerations/EnumB.md | 1 + .../submodule-2/interfaces/InterfaceA.md | 13 + .../submodule-2/interfaces/InterfaceB.md | 1 + .../submodule-2/type-aliases/TypeA.md | 3 + .../submodule-2/type-aliases/TypeB.md | 3 + .../nested-submodule-1/README.md | 23 + .../nested-submodule-1/classes/ClassA.md | 11 + .../nested-submodule-1/classes/ClassB.md | 11 + .../nested-submodule-1/enumerations/EnumA.md | 1 + .../nested-submodule-1/enumerations/EnumB.md | 1 + .../interfaces/InterfaceA.md | 13 + .../interfaces/InterfaceB.md | 1 + .../nested-submodule-1/type-aliases/TypeA.md | 3 + .../nested-submodule-1/type-aliases/TypeB.md | 3 + .../nested-submodule-2/README.md | 23 + .../nested-submodule-2/classes/ClassA.md | 11 + .../nested-submodule-2/classes/ClassB.md | 11 + .../nested-submodule-2/enumerations/EnumA.md | 1 + .../nested-submodule-2/enumerations/EnumB.md | 1 + .../interfaces/InterfaceA.md | 13 + .../interfaces/InterfaceB.md | 1 + .../nested-submodule-2/type-aliases/TypeA.md | 3 + .../nested-submodule-2/type-aliases/TypeB.md | 3 + .../modules/members/opts-1/module-2/README.md | 23 + .../members/opts-1/module-2/classes/ClassA.md | 11 + .../members/opts-1/module-2/classes/ClassB.md | 11 + .../opts-1/module-2/enumerations/EnumA.md | 1 + .../opts-1/module-2/enumerations/EnumB.md | 1 + .../opts-1/module-2/interfaces/InterfaceA.md | 13 + .../opts-1/module-2/interfaces/InterfaceB.md | 1 + .../opts-1/module-2/type-aliases/TypeA.md | 3 + .../opts-1/module-2/type-aliases/TypeB.md | 3 + .../out/modules/members/opts-1/modules.md | 11 + .../members/opts-1/namespace/README.md | 23 + .../opts-1/namespace/classes/ClassA.md | 11 + .../opts-1/namespace/classes/ClassB.md | 11 + .../opts-1/namespace/enumerations/EnumA.md | 1 + .../opts-1/namespace/enumerations/EnumB.md | 1 + .../opts-1/namespace/interfaces/InterfaceA.md | 13 + .../opts-1/namespace/interfaces/InterfaceB.md | 1 + .../opts-1/namespace/type-aliases/TypeA.md | 3 + .../opts-1/namespace/type-aliases/TypeB.md | 3 + .../out/modules/members/opts-1/sidebar.json | 436 +++ .../opts-2/@scope.namespace.Class.ClassA.md | 11 + .../opts-2/@scope.namespace.Class.ClassB.md | 11 + .../@scope.namespace.Enumeration.EnumA.md | 1 + .../@scope.namespace.Enumeration.EnumB.md | 1 + .../@scope.namespace.Interface.InterfaceA.md | 13 + .../@scope.namespace.Interface.InterfaceB.md | 1 + .../@scope.namespace.TypeAlias.TypeA.md | 3 + .../@scope.namespace.TypeAlias.TypeB.md | 3 + .../members/opts-2/@scope.namespace.md | 23 + .../out/modules/members/opts-2/README.md | 9 + .../Test.Module.Name.Interface.InterfaceA.md | 1 + .../members/opts-2/Test.Module.Name.md | 7 + .../modules/members/opts-2/documentation.md | 11 + ...e-1.submodules.submodule-1.Class.ClassA.md | 11 + ...e-1.submodules.submodule-1.Class.ClassB.md | 11 + ...ubmodules.submodule-1.Enumeration.EnumA.md | 1 + ...ubmodules.submodule-1.Enumeration.EnumB.md | 1 + ...odules.submodule-1.Interface.InterfaceA.md | 13 + ...odules.submodule-1.Interface.InterfaceB.md | 1 + ....submodules.submodule-1.TypeAlias.TypeA.md | 3 + ....submodules.submodule-1.TypeAlias.TypeB.md | 3 + .../opts-2/module-1.submodules.submodule-1.md | 23 + ...e-1.submodules.submodule-2.Class.ClassA.md | 11 + ...e-1.submodules.submodule-2.Class.ClassB.md | 11 + ...ubmodules.submodule-2.Enumeration.EnumA.md | 1 + ...ubmodules.submodule-2.Enumeration.EnumB.md | 1 + ...odules.submodule-2.Interface.InterfaceA.md | 13 + ...odules.submodule-2.Interface.InterfaceB.md | 1 + ....submodules.submodule-2.TypeAlias.TypeA.md | 3 + ....submodules.submodule-2.TypeAlias.TypeB.md | 3 + .../opts-2/module-1.submodules.submodule-2.md | 23 + ...modules.nested-submodule-1.Class.ClassA.md | 11 + ...modules.nested-submodule-1.Class.ClassB.md | 11 + ...es.nested-submodule-1.Enumeration.EnumA.md | 1 + ...es.nested-submodule-1.Enumeration.EnumB.md | 1 + ...nested-submodule-1.Interface.InterfaceA.md | 13 + ...nested-submodule-1.Interface.InterfaceB.md | 1 + ...ules.nested-submodule-1.TypeAlias.TypeA.md | 3 + ...ules.nested-submodule-1.TypeAlias.TypeB.md | 3 + ...odule-3-with-modules.nested-submodule-1.md | 23 + ...modules.nested-submodule-2.Class.ClassA.md | 11 + ...modules.nested-submodule-2.Class.ClassB.md | 11 + ...es.nested-submodule-2.Enumeration.EnumA.md | 1 + ...es.nested-submodule-2.Enumeration.EnumB.md | 1 + ...nested-submodule-2.Interface.InterfaceA.md | 13 + ...nested-submodule-2.Interface.InterfaceB.md | 1 + ...ules.nested-submodule-2.TypeAlias.TypeA.md | 3 + ...ules.nested-submodule-2.TypeAlias.TypeB.md | 3 + ...odule-3-with-modules.nested-submodule-2.md | 23 + .../members/opts-2/module-2.Class.ClassA.md | 11 + .../members/opts-2/module-2.Class.ClassB.md | 11 + .../opts-2/module-2.Enumeration.EnumA.md | 1 + .../opts-2/module-2.Enumeration.EnumB.md | 1 + .../opts-2/module-2.Interface.InterfaceA.md | 13 + .../opts-2/module-2.Interface.InterfaceB.md | 1 + .../opts-2/module-2.TypeAlias.TypeA.md | 3 + .../opts-2/module-2.TypeAlias.TypeB.md | 3 + .../out/modules/members/opts-2/module-2.md | 23 + .../out/modules/members/opts-2/sidebar.json | 421 +++ .../out/modules/modules/opts-1/README.md | 9 + .../modules/opts-1/Test_Module_Name.md | 5 + .../opts-1/module-1/submodules/submodule-1.md | 67 + .../opts-1/module-1/submodules/submodule-2.md | 67 + .../nested-submodule-1.md | 67 + .../nested-submodule-2.md | 67 + .../out/modules/modules/opts-1/module-2.md | 67 + .../out/modules/modules/opts-1/modules.md | 11 + .../out/modules/modules/opts-1/namespace.md | 67 + .../out/modules/modules/opts-1/sidebar.json | 52 + .../modules/opts-2/@scope.namespace.md | 67 + .../out/modules/modules/opts-2/README.md | 9 + .../modules/opts-2/Test.Module.Name.md | 5 + .../modules/modules/opts-2/documentation.md | 11 + .../opts-2/module-1.submodules.submodule-1.md | 67 + .../opts-2/module-1.submodules.submodule-2.md | 67 + ...odule-3-with-modules.nested-submodule-1.md | 67 + ...odule-3-with-modules.nested-submodule-2.md | 67 + .../out/modules/modules/opts-2/module-2.md | 67 + .../out/modules/modules/opts-2/sidebar.json | 37 + .../members/opts-1/Module1/README.md | 16 + .../Module1/interfaces/SomeInterface1.md | 3 + .../Module1/interfaces/SomeInterface2.md | 3 + .../Module1/interfaces/SomeInterface3.md | 3 + .../members/opts-1/Module2/README.md | 9 + .../Module2/interfaces/SomeInterface.md | 3 + .../out/navigation/members/opts-1/README.md | 9 + .../navigation/members/opts-1/sidebar.json | 36 + .../members/opts-2/Module1/README.md | 14 + .../Module1/interfaces/SomeInterface1.md | 3 + .../Module1/interfaces/SomeInterface2.md | 3 + .../Module1/interfaces/SomeInterface3.md | 3 + .../members/opts-2/Module2/README.md | 9 + .../Module2/interfaces/SomeInterface.md | 3 + .../out/navigation/members/opts-2/README.md | 9 + .../navigation/members/opts-2/sidebar.json | 61 + .../out/navigation/modules/opts-1/Module1.md | 17 + .../out/navigation/modules/opts-1/Module2.md | 7 + .../out/navigation/modules/opts-1/README.md | 9 + .../navigation/modules/opts-1/sidebar.json | 12 + .../out/navigation/modules/opts-2/Module1.md | 15 + .../out/navigation/modules/opts-2/Module2.md | 7 + .../out/navigation/modules/opts-2/README.md | 9 + .../navigation/modules/opts-2/sidebar.json | 22 + .../objectsAndParams/members/opts-1/README.md | 9 + .../members/opts-1/classes/AbstractClass.md | 36 + .../members/opts-1/classes/BaseClass.md | 16 + .../members/opts-1/classes/BasicClass.md | 33 + .../opts-1/classes/CallbacksOptions.md | 21 + .../members/opts-1/classes/ChildClassA.md | 24 + .../members/opts-1/classes/ChildClassB.md | 19 + .../classes/ClassWithAccessorKeywords.md | 39 + .../opts-1/classes/ClassWithAccessors.md | 75 + .../opts-1/classes/ClassWithComplexProps.md | 41 + .../classes/ClassWithConstructorOverloads.md | 55 + .../members/opts-1/classes/ClassWithFlags.md | 45 + .../opts-1/classes/ClassWithModifiers.md | 69 + .../opts-1/classes/ClassWithPropCategories.md | 55 + .../opts-1/classes/ClassWithSimpleProps.md | 58 + .../opts-1/classes/ClassWithSymbols.md | 31 + .../opts-1/classes/ClassWithTypeParameters.md | 31 + .../classes/ClassWithoutPropCategories.md | 55 + .../members/opts-1/classes/DerivedClassA.md | 65 + .../members/opts-1/classes/DerivedClassB.md | 49 + .../members/opts-1/classes/DisposableClass.md | 29 + .../opts-1/classes/GrandChildClassA.md | 19 + .../opts-1/classes/GrandChildClassB.md | 19 + .../members/opts-1/enumerations/BasicEnum.md | 19 + .../opts-1/enumerations/EnumWithValues.md | 15 + .../members/opts-1/functions/basicFunction.md | 21 + .../functions/basicFunctionWithReturns.md | 11 + .../opts-1/functions/curriedFunction.md | 61 + .../functions/functionReturningAFunction.md | 25 + .../functions/functionReturningAPromise.md | 15 + .../functions/functionReturningAString.md | 11 + .../functions/functionReturningAUnionType.md | 11 + .../functions/functionReturningAnObject.md | 19 + .../functionWithArrayOfOptionalStuff.md | 15 + .../functions/functionWithArrayOfStuff.md | 15 + .../functions/functionWithComplexParams.md | 21 + .../functionWithDefaultParameters.md | 45 + .../functionWithMultipleSignatures.md | 43 + .../functions/functionWithNamedParams.md | 27 + .../functions/functionWithNestedParameters.md | 57 + .../functionWithOptionalParameters.md | 31 + .../functions/functionWithRestParams.md | 19 + .../functions/functionWithTypeParameters.md | 19 + .../functions/functionWithUnionParams.md | 51 + .../members/opts-1/globals.md | 103 + .../opts-1/interfaces/BasicInterface.md | 193 + .../opts-1/interfaces/CustomEventInterface.md | 19 + .../opts-1/interfaces/ExtendedInterface.md | 239 ++ .../opts-1/interfaces/IndexableInterface.md | 13 + .../interfaces/InterfaceWithComments.md | 51 + .../InterfaceWithEventProperties.md | 39 + .../opts-1/interfaces/InterfaceWithFlags.md | 21 + .../interfaces/InterfaceWithTypeParameters.md | 17 + .../interfaces/MultipleIndexableInterface.md | 15 + .../opts-1/type-aliases/ArrayOfStuff.md | 3 + .../members/opts-1/type-aliases/ArrayType.md | 5 + .../opts-1/type-aliases/ConditionalType.md | 11 + .../type-aliases/ExternalReferenceType.md | 5 + .../opts-1/type-aliases/FunctionType.md | 19 + .../opts-1/type-aliases/IndexAccessType.md | 5 + .../opts-1/type-aliases/IntersectionType.md | 11 + .../opts-1/type-aliases/LiteralType.md | 137 + .../opts-1/type-aliases/PartialMappedType.md | 11 + .../opts-1/type-aliases/PrimitiveType.md | 5 + .../type-aliases/PromiseTypeWithObject.md | 13 + .../type-aliases/PromiseTypeWithSymbol.md | 5 + .../members/opts-1/type-aliases/QueryType.md | 5 + .../opts-1/type-aliases/ReadonlyMappedType.md | 11 + .../opts-1/type-aliases/StringLiteralType.md | 5 + .../members/opts-1/type-aliases/Stuff.md | 13 + .../members/opts-1/type-aliases/TupleType.md | 5 + .../TypeDeclarationWithSpecialCharacters.md | 107 + .../TypeWithExternalSymbolLinkMapping.md | 5 + .../opts-1/type-aliases/TypeWithReturns.md | 9 + .../opts-1/type-aliases/TypeWithTypeParams.md | 15 + .../members/opts-1/type-aliases/UnionType.md | 5 + .../UnionTypeWithTemplateStrings.md | 5 + .../opts-1/type-aliases/UsefulUnionType.md | 19 + .../opts-1/variables/objectLiteralVariable.md | 89 + .../opts-1/variables/objectWithSymbol.md | 13 + .../members/opts-1/variables/someQuery.md | 3 + .../opts-1/variables/stringVariable.md | 5 + .../variables/templateVariableString.md | 5 + .../opts-1/variables/typeOperatorVariable.md | 5 + .../objectsAndParams/members/opts-2/README.md | 9 + .../members/opts-2/classes/AbstractClass.md | 38 + .../members/opts-2/classes/BaseClass.md | 18 + .../members/opts-2/classes/BasicClass.md | 35 + .../opts-2/classes/CallbacksOptions.md | 20 + .../members/opts-2/classes/ChildClassA.md | 26 + .../members/opts-2/classes/ChildClassB.md | 21 + .../classes/ClassWithAccessorKeywords.md | 41 + .../opts-2/classes/ClassWithAccessors.md | 83 + .../opts-2/classes/ClassWithComplexProps.md | 23 + .../classes/ClassWithConstructorOverloads.md | 54 + .../members/opts-2/classes/ClassWithFlags.md | 49 + .../opts-2/classes/ClassWithModifiers.md | 52 + .../opts-2/classes/ClassWithPropCategories.md | 64 + .../opts-2/classes/ClassWithSimpleProps.md | 24 + .../opts-2/classes/ClassWithSymbols.md | 31 + .../opts-2/classes/ClassWithTypeParameters.md | 23 + .../classes/ClassWithoutPropCategories.md | 55 + .../members/opts-2/classes/DerivedClassA.md | 60 + .../members/opts-2/classes/DerivedClassB.md | 47 + .../members/opts-2/classes/DisposableClass.md | 33 + .../opts-2/classes/GrandChildClassA.md | 21 + .../opts-2/classes/GrandChildClassB.md | 21 + .../members/opts-2/enumerations/BasicEnum.md | 23 + .../opts-2/enumerations/EnumWithValues.md | 19 + .../members/opts-2/functions/basicFunction.md | 21 + .../functions/basicFunctionWithReturns.md | 13 + .../opts-2/functions/curriedFunction.md | 60 + .../functions/functionReturningAFunction.md | 27 + .../functions/functionReturningAPromise.md | 23 + .../functions/functionReturningAString.md | 13 + .../functions/functionReturningAUnionType.md | 13 + .../functions/functionReturningAnObject.md | 33 + .../functionWithArrayOfOptionalStuff.md | 17 + .../functions/functionWithArrayOfStuff.md | 17 + .../functions/functionWithComplexParams.md | 21 + .../functionWithDefaultParameters.md | 28 + .../functionWithMultipleSignatures.md | 42 + .../functions/functionWithNamedParams.md | 21 + .../functions/functionWithNestedParameters.md | 39 + .../functionWithOptionalParameters.md | 24 + .../functions/functionWithRestParams.md | 18 + .../functions/functionWithTypeParameters.md | 18 + .../functions/functionWithUnionParams.md | 30 + .../members/opts-2/globals.md | 103 + .../opts-2/interfaces/BasicInterface.md | 30 + .../opts-2/interfaces/CustomEventInterface.md | 14 + .../opts-2/interfaces/ExtendedInterface.md | 31 + .../opts-2/interfaces/IndexableInterface.md | 13 + .../interfaces/InterfaceWithComments.md | 21 + .../InterfaceWithEventProperties.md | 14 + .../opts-2/interfaces/InterfaceWithFlags.md | 10 + .../interfaces/InterfaceWithTypeParameters.md | 15 + .../interfaces/MultipleIndexableInterface.md | 13 + .../opts-2/type-aliases/ArrayOfStuff.md | 8 + .../members/opts-2/type-aliases/ArrayType.md | 7 + .../opts-2/type-aliases/ConditionalType.md | 13 + .../type-aliases/ExternalReferenceType.md | 7 + .../opts-2/type-aliases/FunctionType.md | 18 + .../opts-2/type-aliases/IndexAccessType.md | 7 + .../opts-2/type-aliases/IntersectionType.md | 17 + .../opts-2/type-aliases/LiteralType.md | 129 + .../opts-2/type-aliases/PartialMappedType.md | 13 + .../opts-2/type-aliases/PrimitiveType.md | 7 + .../type-aliases/PromiseTypeWithObject.md | 19 + .../type-aliases/PromiseTypeWithSymbol.md | 7 + .../members/opts-2/type-aliases/QueryType.md | 7 + .../opts-2/type-aliases/ReadonlyMappedType.md | 13 + .../opts-2/type-aliases/StringLiteralType.md | 13 + .../members/opts-2/type-aliases/Stuff.md | 22 + .../members/opts-2/type-aliases/TupleType.md | 7 + .../TypeDeclarationWithSpecialCharacters.md | 157 + .../TypeWithExternalSymbolLinkMapping.md | 7 + .../opts-2/type-aliases/TypeWithReturns.md | 11 + .../opts-2/type-aliases/TypeWithTypeParams.md | 14 + .../members/opts-2/type-aliases/UnionType.md | 9 + .../UnionTypeWithTemplateStrings.md | 7 + .../opts-2/type-aliases/UsefulUnionType.md | 27 + .../opts-2/variables/objectLiteralVariable.md | 68 + .../opts-2/variables/objectWithSymbol.md | 19 + .../members/opts-2/variables/someQuery.md | 5 + .../opts-2/variables/stringVariable.md | 7 + .../variables/templateVariableString.md | 7 + .../opts-2/variables/typeOperatorVariable.md | 7 + .../out/package/members/opts-1/README.md | 7 + .../opts-1/interfaces/PackageInterface.md | 13 + .../out/package/members/opts-1/packages.md | 13 + .../out/package/members/opts-1/sidebar.json | 12 + .../out/package/modules/opts-1/README.md | 7 + .../out/package/modules/opts-1/packages.md | 13 + .../out/package/modules/opts-1/sidebar.json | 1 + .../opts-1/@scope/package-1/globals.md | 15 + .../members/opts-1/@scope/package-1/index.md | 9 + .../package-1/interfaces/PackageInterface.md | 13 + .../package-3/documents/Package-Document-1.md | 9 + .../members/opts-1/@scope/package-3/index.md | 17 + .../opts-1/@scope/package-3/index/index.md | 13 + .../PackageInterfaceForIndexModule.md | 7 + .../opts-1/@scope/package-3/module-1/index.md | 13 + .../module-1/interfaces/PackageInterface1.md | 7 + .../opts-1/@scope/package-3/module-2/index.md | 13 + .../module-2/interfaces/PackageInterface2.md | 7 + .../out/packages/members/opts-1/index.md | 13 + .../members/opts-1/package-1b/index.md | 13 + .../package-1b/interfaces/PackageInterface.md | 13 + .../members/opts-1/package-2/index.md | 9 + .../opts-1/package-2/module-1/index.md | 13 + .../module-1/interfaces/PackageInterface1.md | 7 + .../opts-1/package-2/module-2/index.md | 13 + .../module-2/interfaces/PackageInterface2.md | 7 + .../members/opts-1/package-2/modules.md | 12 + .../members/opts-1/package-4/index.md | 11 + .../package-4/interfaces/PackageInterface.md | 7 + .../module1/interfaces/PackageInterface1.md | 7 + .../members/opts-1/package-5/module2/index.md | 13 + .../module2/interfaces/PackageInterface2.md | 7 + .../members/opts-1/package-5/package-5.md | 13 + .../out/packages/members/opts-1/package-6.md | 13 + .../module1/interfaces/PackageInterface1.md | 7 + .../members/opts-1/package-6/module2/index.md | 13 + .../module2/interfaces/PackageInterface2.md | 7 + .../members/opts-1/package-7/index.md | 14 + .../package-7/module-1/classes/ClassA.md | 17 + .../package-7/module-1/classes/ClassB.md | 17 + .../opts-1/package-7/module-1/index.md | 14 + .../nested-submodule-1/classes/ClassA.md | 17 + .../nested-submodule-1/classes/ClassB.md | 17 + .../nested-submodule-1/index.md | 14 + .../nested-submodule-2/classes/ClassA.md | 17 + .../nested-submodule-2/classes/ClassB.md | 17 + .../nested-submodule-2/index.md | 14 + .../package-7/module-2/classes/ClassA.md | 17 + .../package-7/module-2/classes/ClassB.md | 17 + .../opts-1/package-7/module-2/index.md | 14 + .../out/packages/members/opts-1/packages.md | 16 + .../out/packages/members/opts-1/sidebar.json | 305 ++ .../out/packages/members/opts-2/README.md | 26 + .../members/opts-2/package-1/README.md | 19 + .../package-1/interfaces/PackageInterface.md | 13 + .../members/opts-2/package-1b/README.md | 15 + .../package-1b/interfaces/PackageInterface.md | 13 + .../members/opts-2/package-2/README.md | 16 + .../opts-2/package-2/module-1/README.md | 15 + .../module-1/interfaces/PackageInterface1.md | 7 + .../opts-2/package-2/module-2/README.md | 15 + .../module-2/interfaces/PackageInterface2.md | 7 + .../members/opts-2/package-3/README.md | 21 + .../package-3/documents/Package-Document-1.md | 9 + .../members/opts-2/package-3/index/README.md | 15 + .../PackageInterfaceForIndexModule.md | 7 + .../opts-2/package-3/module-1/README.md | 15 + .../module-1/interfaces/PackageInterface1.md | 7 + .../opts-2/package-3/module-2/README.md | 15 + .../module-2/interfaces/PackageInterface2.md | 7 + .../members/opts-2/package-4/README.md | 13 + .../package-4/interfaces/PackageInterface.md | 7 + .../module1/interfaces/PackageInterface1.md | 7 + .../opts-2/package-5/module2/README.md | 15 + .../module2/interfaces/PackageInterface2.md | 7 + .../members/opts-2/package-5/package-5.md | 15 + .../out/packages/members/opts-2/package-6.md | 15 + .../module1/interfaces/PackageInterface1.md | 7 + .../opts-2/package-6/module2/README.md | 15 + .../module2/interfaces/PackageInterface2.md | 7 + .../members/opts-2/package-7/README.md | 16 + .../opts-2/package-7/module-1/README.md | 16 + .../package-7/module-1/classes/ClassA.md | 17 + .../package-7/module-1/classes/ClassB.md | 17 + .../nested-submodule-1/README.md | 16 + .../nested-submodule-1/classes/ClassA.md | 17 + .../nested-submodule-1/classes/ClassB.md | 17 + .../nested-submodule-2/README.md | 16 + .../nested-submodule-2/classes/ClassA.md | 17 + .../nested-submodule-2/classes/ClassB.md | 17 + .../opts-2/package-7/module-2/README.md | 16 + .../package-7/module-2/classes/ClassA.md | 17 + .../package-7/module-2/classes/ClassB.md | 17 + .../out/packages/members/opts-2/sidebar.json | 305 ++ .../opts-1/@scope/package-1/globals.md | 21 + .../modules/opts-1/@scope/package-1/index.md | 9 + .../package-3/documents/Package-Document-1.md | 9 + .../modules/opts-1/@scope/package-3/index.md | 17 + .../package-3/interfaces/PackageInterface1.md | 7 + .../package-3/interfaces/PackageInterface2.md | 7 + .../PackageInterfaceForIndexModule.md | 7 + .../opts-1/@scope/package-3/module-1.md | 13 + .../opts-1/@scope/package-3/module-2.md | 13 + .../opts-1/@scope/package-3/module_index.md | 13 + .../out/packages/modules/opts-1/index.md | 13 + .../modules/opts-1/package-1b/index.md | 19 + .../modules/opts-1/package-2/index.md | 9 + .../modules/opts-1/package-2/module-1.md | 11 + .../modules/opts-1/package-2/module-2.md | 11 + .../modules/opts-1/package-2/modules.md | 12 + .../modules/opts-1/package-4/index.md | 11 + .../package-4/interfaces/PackageInterface.md | 7 + .../modules/opts-1/package-5/module2.md | 11 + .../modules/opts-1/package-5/package-5.md | 11 + .../out/packages/modules/opts-1/package-6.md | 11 + .../modules/opts-1/package-6/module2.md | 11 + .../modules/opts-1/package-7/index.md | 14 + .../modules/opts-1/package-7/module-1.md | 35 + .../nested-submodule-1.md | 35 + .../nested-submodule-2.md | 35 + .../modules/opts-1/package-7/module-2.md | 35 + .../out/packages/modules/opts-1/packages.md | 16 + .../out/packages/modules/opts-1/sidebar.json | 174 + .../out/packages/modules/opts-2/README.md | 26 + .../modules/opts-2/package-1/README.md | 23 + .../modules/opts-2/package-1b/README.md | 19 + .../modules/opts-2/package-2/README.md | 16 + .../modules/opts-2/package-2/module-1.md | 11 + .../modules/opts-2/package-2/module-2.md | 11 + .../modules/opts-2/package-3/README.md | 21 + .../package-3/documents/Package-Document-1.md | 9 + .../modules/opts-2/package-3/index.md | 15 + .../package-3/interfaces/PackageInterface1.md | 7 + .../package-3/interfaces/PackageInterface2.md | 7 + .../PackageInterfaceForIndexModule.md | 7 + .../modules/opts-2/package-3/module-1.md | 15 + .../modules/opts-2/package-3/module-2.md | 15 + .../modules/opts-2/package-4/README.md | 13 + .../package-4/interfaces/PackageInterface.md | 7 + .../modules/opts-2/package-5/module2.md | 11 + .../modules/opts-2/package-5/package-5.md | 11 + .../out/packages/modules/opts-2/package-6.md | 11 + .../modules/opts-2/package-6/module2.md | 11 + .../modules/opts-2/package-7/README.md | 16 + .../modules/opts-2/package-7/module-1.md | 35 + .../nested-submodule-1.md | 35 + .../nested-submodule-2.md | 35 + .../modules/opts-2/package-7/module-2.md | 35 + .../out/packages/modules/opts-2/sidebar.json | 167 + .../members/opts-1/functions/someFunction.md | 13 + .../out/readme/members/opts-1/index.md | 19 + .../out/readme/members/opts-1/sidebar.json | 12 + .../out/readme/modules/opts-1/index.md | 25 + .../out/readme/modules/opts-1/sidebar.json | 1 + .../out/reflections/members/opts-1/README.md | 9 + .../members/opts-1/classes/AbstractClass.md | 44 + .../members/opts-1/classes/BaseClass.md | 16 + .../members/opts-1/classes/BasicClass.md | 41 + .../opts-1/classes/CallbacksOptions.md | 21 + .../members/opts-1/classes/ChildClassA.md | 24 + .../members/opts-1/classes/ChildClassB.md | 19 + .../classes/ClassWithAccessorKeywords.md | 51 + .../opts-1/classes/ClassWithAccessors.md | 97 + .../opts-1/classes/ClassWithComplexProps.md | 45 + .../classes/ClassWithConstructorOverloads.md | 67 + .../members/opts-1/classes/ClassWithFlags.md | 69 + .../opts-1/classes/ClassWithModifiers.md | 121 + .../opts-1/classes/ClassWithPropCategories.md | 75 + .../opts-1/classes/ClassWithSimpleProps.md | 74 + .../opts-1/classes/ClassWithSymbols.md | 39 + .../opts-1/classes/ClassWithTypeParameters.md | 31 + .../classes/ClassWithoutPropCategories.md | 75 + .../members/opts-1/classes/DerivedClassA.md | 81 + .../members/opts-1/classes/DerivedClassB.md | 57 + .../members/opts-1/classes/DisposableClass.md | 33 + .../opts-1/classes/GrandChildClassA.md | 19 + .../opts-1/classes/GrandChildClassB.md | 19 + .../members/opts-1/enumerations/BasicEnum.md | 27 + .../opts-1/enumerations/EnumWithValues.md | 23 + .../members/opts-1/functions/basicFunction.md | 25 + .../functions/basicFunctionWithReturns.md | 15 + .../opts-1/functions/curriedFunction.md | 69 + .../functions/functionReturningAFunction.md | 29 + .../functions/functionReturningAPromise.md | 19 + .../functions/functionReturningAString.md | 15 + .../functions/functionReturningAUnionType.md | 15 + .../functions/functionReturningAnObject.md | 23 + .../functionWithArrayOfOptionalStuff.md | 19 + .../functions/functionWithArrayOfStuff.md | 19 + .../functions/functionWithComplexParams.md | 25 + .../functionWithDefaultParameters.md | 49 + .../functionWithMultipleSignatures.md | 51 + .../functions/functionWithNamedParams.md | 31 + .../functions/functionWithNestedParameters.md | 61 + .../functionWithOptionalParameters.md | 35 + .../functions/functionWithRestParams.md | 23 + .../functions/functionWithTypeParameters.md | 23 + .../functions/functionWithUnionParams.md | 55 + .../out/reflections/members/opts-1/globals.md | 103 + .../opts-1/interfaces/BasicInterface.md | 233 ++ .../opts-1/interfaces/CustomEventInterface.md | 27 + .../opts-1/interfaces/ExtendedInterface.md | 283 ++ .../opts-1/interfaces/IndexableInterface.md | 17 + .../interfaces/InterfaceWithComments.md | 55 + .../InterfaceWithEventProperties.md | 51 + .../opts-1/interfaces/InterfaceWithFlags.md | 29 + .../interfaces/InterfaceWithTypeParameters.md | 21 + .../interfaces/MultipleIndexableInterface.md | 19 + .../reflections/members/opts-1/sidebar.json | 442 +++ .../opts-1/type-aliases/ArrayOfStuff.md | 7 + .../members/opts-1/type-aliases/ArrayType.md | 9 + .../opts-1/type-aliases/ConditionalType.md | 15 + .../type-aliases/ExternalReferenceType.md | 9 + .../opts-1/type-aliases/FunctionType.md | 23 + .../opts-1/type-aliases/IndexAccessType.md | 9 + .../opts-1/type-aliases/IntersectionType.md | 15 + .../opts-1/type-aliases/LiteralType.md | 141 + .../opts-1/type-aliases/PartialMappedType.md | 15 + .../opts-1/type-aliases/PrimitiveType.md | 9 + .../type-aliases/PromiseTypeWithObject.md | 17 + .../type-aliases/PromiseTypeWithSymbol.md | 9 + .../members/opts-1/type-aliases/QueryType.md | 9 + .../opts-1/type-aliases/ReadonlyMappedType.md | 15 + .../opts-1/type-aliases/StringLiteralType.md | 9 + .../members/opts-1/type-aliases/Stuff.md | 17 + .../members/opts-1/type-aliases/TupleType.md | 9 + .../TypeDeclarationWithSpecialCharacters.md | 111 + .../TypeWithExternalSymbolLinkMapping.md | 9 + .../opts-1/type-aliases/TypeWithReturns.md | 13 + .../opts-1/type-aliases/TypeWithTypeParams.md | 19 + .../members/opts-1/type-aliases/UnionType.md | 9 + .../UnionTypeWithTemplateStrings.md | 9 + .../opts-1/type-aliases/UsefulUnionType.md | 23 + .../opts-1/variables/objectLiteralVariable.md | 93 + .../opts-1/variables/objectWithSymbol.md | 17 + .../members/opts-1/variables/someQuery.md | 7 + .../opts-1/variables/stringVariable.md | 9 + .../variables/templateVariableString.md | 9 + .../opts-1/variables/typeOperatorVariable.md | 9 + .../out/reflections/members/opts-2/README.md | 115 + .../members/opts-2/classes/AbstractClass.md | 42 + .../members/opts-2/classes/BaseClass.md | 18 + .../members/opts-2/classes/BasicClass.md | 39 + .../opts-2/classes/CallbacksOptions.md | 20 + .../members/opts-2/classes/ChildClassA.md | 26 + .../members/opts-2/classes/ChildClassB.md | 21 + .../classes/ClassWithAccessorKeywords.md | 53 + .../opts-2/classes/ClassWithAccessors.md | 101 + .../opts-2/classes/ClassWithComplexProps.md | 23 + .../classes/ClassWithConstructorOverloads.md | 66 + .../members/opts-2/classes/ClassWithFlags.md | 58 + .../opts-2/classes/ClassWithModifiers.md | 79 + .../opts-2/classes/ClassWithPropCategories.md | 81 + .../opts-2/classes/ClassWithSimpleProps.md | 24 + .../opts-2/classes/ClassWithSymbols.md | 35 + .../opts-2/classes/ClassWithTypeParameters.md | 23 + .../classes/ClassWithoutPropCategories.md | 64 + .../members/opts-2/classes/DerivedClassA.md | 68 + .../members/opts-2/classes/DerivedClassB.md | 51 + .../members/opts-2/classes/DisposableClass.md | 37 + .../opts-2/classes/GrandChildClassA.md | 21 + .../opts-2/classes/GrandChildClassB.md | 21 + .../members/opts-2/enumerations/BasicEnum.md | 10 + .../opts-2/enumerations/EnumWithValues.md | 10 + .../members/opts-2/functions/basicFunction.md | 25 + .../functions/basicFunctionWithReturns.md | 17 + .../opts-2/functions/curriedFunction.md | 68 + .../functions/functionReturningAFunction.md | 31 + .../functions/functionReturningAPromise.md | 21 + .../functions/functionReturningAString.md | 17 + .../functions/functionReturningAUnionType.md | 17 + .../functions/functionReturningAnObject.md | 22 + .../functionWithArrayOfOptionalStuff.md | 21 + .../functions/functionWithArrayOfStuff.md | 21 + .../functions/functionWithComplexParams.md | 23 + .../functionWithDefaultParameters.md | 32 + .../functionWithMultipleSignatures.md | 48 + .../functions/functionWithNamedParams.md | 22 + .../functions/functionWithNestedParameters.md | 33 + .../functionWithOptionalParameters.md | 28 + .../functions/functionWithRestParams.md | 22 + .../functions/functionWithTypeParameters.md | 22 + .../functions/functionWithUnionParams.md | 31 + .../opts-2/interfaces/BasicInterface.md | 30 + .../opts-2/interfaces/CustomEventInterface.md | 14 + .../opts-2/interfaces/ExtendedInterface.md | 31 + .../opts-2/interfaces/IndexableInterface.md | 13 + .../interfaces/InterfaceWithComments.md | 21 + .../InterfaceWithEventProperties.md | 14 + .../opts-2/interfaces/InterfaceWithFlags.md | 10 + .../interfaces/InterfaceWithTypeParameters.md | 15 + .../interfaces/MultipleIndexableInterface.md | 13 + .../reflections/members/opts-2/sidebar.json | 442 +++ .../opts-2/type-aliases/ArrayOfStuff.md | 9 + .../members/opts-2/type-aliases/ArrayType.md | 11 + .../opts-2/type-aliases/ConditionalType.md | 17 + .../type-aliases/ExternalReferenceType.md | 11 + .../opts-2/type-aliases/FunctionType.md | 22 + .../opts-2/type-aliases/IndexAccessType.md | 11 + .../opts-2/type-aliases/IntersectionType.md | 17 + .../opts-2/type-aliases/LiteralType.md | 28 + .../opts-2/type-aliases/PartialMappedType.md | 17 + .../opts-2/type-aliases/PrimitiveType.md | 11 + .../type-aliases/PromiseTypeWithObject.md | 17 + .../type-aliases/PromiseTypeWithSymbol.md | 11 + .../members/opts-2/type-aliases/QueryType.md | 11 + .../opts-2/type-aliases/ReadonlyMappedType.md | 17 + .../opts-2/type-aliases/StringLiteralType.md | 17 + .../members/opts-2/type-aliases/Stuff.md | 16 + .../members/opts-2/type-aliases/TupleType.md | 11 + .../TypeDeclarationWithSpecialCharacters.md | 43 + .../TypeWithExternalSymbolLinkMapping.md | 11 + .../opts-2/type-aliases/TypeWithReturns.md | 15 + .../opts-2/type-aliases/TypeWithTypeParams.md | 18 + .../members/opts-2/type-aliases/UnionType.md | 13 + .../UnionTypeWithTemplateStrings.md | 11 + .../opts-2/type-aliases/UsefulUnionType.md | 27 + .../opts-2/variables/objectLiteralVariable.md | 27 + .../opts-2/variables/objectWithSymbol.md | 17 + .../members/opts-2/variables/someQuery.md | 9 + .../opts-2/variables/stringVariable.md | 11 + .../variables/templateVariableString.md | 11 + .../opts-2/variables/typeOperatorVariable.md | 11 + .../out/reflections/modules/opts-1/README.md | 9 + .../out/reflections/modules/opts-1/globals.md | 3339 +++++++++++++++++ .../reflections/modules/opts-1/sidebar.json | 1 + .../out/reflections/modules/opts-2/README.md | 2380 ++++++++++++ .../reflections/modules/opts-2/sidebar.json | 1 + .../out/text/members/opts-1/README.md | 14 + .../text/members/opts-1/module-1/README.md | 17 + .../module-1/interfaces/SomeInterface.md | 23 + .../text/members/opts-1/module-2/README.md | 17 + .../opts-1/module-2/variables/constA.md | 13 + .../out/text/members/opts-1/sidebar.json | 36 + .../out/text/members/opts-2/README.md | 10 + .../text/members/opts-2/module-1/README.md | 13 + .../module-1/interfaces/SomeInterface.md | 19 + .../text/members/opts-2/module-2/README.md | 13 + .../opts-2/module-2/variables/constA.md | 9 + .../out/text/members/opts-2/sidebar.json | 36 + .../out/text/modules/opts-1/README.md | 14 + .../out/text/modules/opts-1/module-1.md | 27 + .../out/text/modules/opts-1/module-2.md | 17 + .../out/text/modules/opts-1/sidebar.json | 12 + .../out/text/modules/opts-2/README.md | 10 + .../out/text/modules/opts-2/module-1.md | 23 + .../out/text/modules/opts-2/module-2.md | 13 + .../out/text/modules/opts-2/sidebar.json | 12 + .../out/utils/members/opts-1/README.md | 17 + .../members/opts-1/classes/ClassWithChars.md | 23 + .../functions/some_prettier_function.md | 28 + .../opts-1/interfaces/InterfaceWithChars.md | 31 + .../opts-1/variables/variableWithChars.md | 17 + .../out/utils/members/opts-2/README.md | 17 + .../members/opts-2/classes/ClassWithChars.md | 27 + .../functions/some_prettier_function.md | 30 + .../opts-2/interfaces/InterfaceWithChars.md | 39 + .../opts-2/variables/variableWithChars.md | 29 + .../out/utils/modules/opts-1/README.md | 106 + .../out/utils/modules/opts-2/README.md | 132 + .../test/fixtures/src/readme/index.ts | 2 +- .../test}/fixtures/typedoc.cjs | 0 .../test/fixtures/typedoc.readme.cjs | 11 + .../test/fixtures/typedoc.text-1.cjs | 21 + .../test/fixtures/typedoc.text-2.cjs | 23 + .../test/fixtures/typedoc.text-locales.cjs | 19 - .../test/fixtures/typedoc.text-mappings.cjs | 22 - .../specs/__snapshots__/comments.spec.ts.snap | 4 +- .../__snapshots__/entryfiles.spec.ts.snap | 14 +- .../specs/__snapshots__/groups.spec.ts.snap | 70 +- .../specs/__snapshots__/packages.spec.ts.snap | 30 +- .../specs/__snapshots__/readme.spec.ts.snap | 8 +- .../reflection.class.spec.ts.snap | 64 +- .../specs/__snapshots__/text.spec.ts.snap | 60 +- .../specs/__snapshots__/utils.spec.ts.snap | 4 +- .../typedoc.public.json | 4 +- .../test/out/globals-notoc/README.md | 47 + .../test/out/globals/README.md | 54 + .../test/out/members/README.md | 6 + .../test/out/members/module-1/README.md | 23 + .../out/members/module-1/classes/SomeClass.md | 49 + .../module-1/functions/some_function.md | 35 + .../module-1/interfaces/SomeInterface.md | 49 + .../test/out/members/module-2/README.md | 15 + .../module-2/functions/some_function.md | 41 + .../module-2/variables/someVariable.md | 7 + .../test/out/modules/README.md | 6 + .../test/out/modules/module-1.md | 128 + .../test/out/modules/module-2.md | 58 + .../specs/__snapshots__/remark.spec.ts.snap | 6 +- .../test/out/default/index.md | 6 + .../out/default/module-1/classes/ClassA.md | 11 + .../out/default/module-1/classes/ClassB.md | 11 + .../test/out/default/module-1/index.md | 13 + .../default/module-1/interfaces/InterfaceA.md | 3 + .../default/module-1/interfaces/InterfaceB.md | 7 + .../out/default/module-2/classes/ClassA.md | 11 + .../out/default/module-2/classes/ClassB.md | 11 + .../test/out/default/module-2/index.md | 13 + .../default/module-2/interfaces/InterfaceA.md | 1 + .../default/module-2/interfaces/InterfaceB.md | 1 + .../test/out/default/typedoc-sidebar.json | 1 + .../test/out/sidebar-options-2/index.md | 6 + .../module-1/classes/ClassA.md | 11 + .../module-1/classes/ClassB.md | 11 + .../out/sidebar-options-2/module-1/index.md | 13 + .../module-1/interfaces/InterfaceA.md | 3 + .../module-1/interfaces/InterfaceB.md | 7 + .../module-2/classes/ClassA.md | 11 + .../module-2/classes/ClassB.md | 11 + .../out/sidebar-options-2/module-2/index.md | 13 + .../module-2/interfaces/InterfaceA.md | 1 + .../module-2/interfaces/InterfaceB.md | 1 + .../sidebar-options-2/typedoc-sidebar.json | 1 + .../test/out/sidebar-options/index.md | 6 + .../module-1/classes/ClassA.md | 11 + .../module-1/classes/ClassB.md | 11 + .../out/sidebar-options/module-1/index.md | 13 + .../module-1/interfaces/InterfaceA.md | 3 + .../module-1/interfaces/InterfaceB.md | 7 + .../module-2/classes/ClassA.md | 11 + .../module-2/classes/ClassB.md | 11 + .../out/sidebar-options/module-2/index.md | 13 + .../module-2/interfaces/InterfaceA.md | 1 + .../module-2/interfaces/InterfaceB.md | 1 + .../out/sidebar-options/typedoc-sidebar.json | 72 + typedoc.json | 12 +- 1334 files changed, 40860 insertions(+), 711 deletions(-) delete mode 100644 devtools/packages/fixtures/README.md delete mode 100644 devtools/packages/fixtures/models.ts delete mode 100644 devtools/packages/fixtures/package.json rename devtools/typedoc-plugins/{typedoc-default-values.js => typedoc-default-values.mjs} (86%) create mode 100644 packages/docusaurus-plugin-typedoc/test/out/default/index.md create mode 100644 packages/docusaurus-plugin-typedoc/test/out/default/links/enumerations/CommentEnum.md create mode 100644 packages/docusaurus-plugin-typedoc/test/out/default/links/index.md create mode 100644 packages/docusaurus-plugin-typedoc/test/out/default/links/interfaces/CommentInterface.md create mode 100644 packages/docusaurus-plugin-typedoc/test/out/default/links/interfaces/CommentInterfaceExtended.md create mode 100644 packages/docusaurus-plugin-typedoc/test/out/default/module-1/classes/ClassA.md create mode 100644 packages/docusaurus-plugin-typedoc/test/out/default/module-1/classes/ClassB.md create mode 100644 packages/docusaurus-plugin-typedoc/test/out/default/module-1/index.md create mode 100644 packages/docusaurus-plugin-typedoc/test/out/default/module-1/interfaces/InterfaceA.md create mode 100644 packages/docusaurus-plugin-typedoc/test/out/default/module-1/interfaces/InterfaceB.md create mode 100644 packages/docusaurus-plugin-typedoc/test/out/default/module-2/classes/ClassA.md create mode 100644 packages/docusaurus-plugin-typedoc/test/out/default/module-2/classes/ClassB.md create mode 100644 packages/docusaurus-plugin-typedoc/test/out/default/module-2/index.md create mode 100644 packages/docusaurus-plugin-typedoc/test/out/default/module-2/interfaces/InterfaceA.md create mode 100644 packages/docusaurus-plugin-typedoc/test/out/default/module-2/interfaces/InterfaceB.md create mode 100644 packages/docusaurus-plugin-typedoc/test/out/default/typedoc-sidebar.cjs create mode 100644 packages/docusaurus-plugin-typedoc/test/out/global-members/classes/ClassA.mdx create mode 100644 packages/docusaurus-plugin-typedoc/test/out/global-members/classes/ClassB.mdx create mode 100644 packages/docusaurus-plugin-typedoc/test/out/global-members/index.mdx create mode 100644 packages/docusaurus-plugin-typedoc/test/out/global-members/interfaces/InterfaceA.mdx create mode 100644 packages/docusaurus-plugin-typedoc/test/out/global-members/interfaces/InterfaceB.mdx create mode 100644 packages/docusaurus-plugin-typedoc/test/out/global-members/typedoc-sidebar.cjs create mode 100644 packages/docusaurus-plugin-typedoc/test/out/links/index.md create mode 100644 packages/docusaurus-plugin-typedoc/test/out/links/typedoc-sidebar.cjs create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/default/_sidebar.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/default/home.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/classes/ClassA.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/classes/ClassB.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/home.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/interfaces/InterfaceA.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/interfaces/InterfaceB.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/namespaces/Validation/home.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/namespaces/Validation/interfaces/NamespaceInterface.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/classes/ClassA.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/classes/ClassB.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/home.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/interfaces/InterfaceA.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/interfaces/InterfaceB.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/globals/_sidebar.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/globals/classes/ClassA.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/globals/classes/ClassB.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/globals/home.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/globals/interfaces/InterfaceA.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/globals/interfaces/InterfaceB.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/single-modules/_sidebar.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/single-modules/home.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/single-modules/module-1/home.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/single-modules/module-1/namespaces/Validation.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/single-modules/module-2.md create mode 100644 packages/typedoc-gitlab-wiki-theme/test/out/single-page/home.md create mode 100644 packages/typedoc-plugin-frontmatter/test/out/no-data/README.md create mode 100644 packages/typedoc-plugin-frontmatter/test/out/no-data/globals.md create mode 100644 packages/typedoc-plugin-frontmatter/test/out/no-data/interfaces/SomeInterface.md create mode 100644 packages/typedoc-plugin-frontmatter/test/out/options-2/README.md create mode 100644 packages/typedoc-plugin-frontmatter/test/out/options-2/globals.md create mode 100644 packages/typedoc-plugin-frontmatter/test/out/options-2/interfaces/SomeInterface.md create mode 100644 packages/typedoc-plugin-frontmatter/test/out/options/README.md create mode 100644 packages/typedoc-plugin-frontmatter/test/out/options/globals.md create mode 100644 packages/typedoc-plugin-frontmatter/test/out/options/interfaces/SomeInterface.md delete mode 100644 packages/typedoc-plugin-markdown/barrelsby.config.json rename devtools/packages/fixtures/cli.ts => packages/typedoc-plugin-markdown/test/__scripts__/build-fixtures.mjs (64%) rename packages/typedoc-plugin-markdown/test/{scripts => __scripts__/lint}/lint.md.mjs (100%) rename packages/typedoc-plugin-markdown/test/{scripts => __scripts__/lint}/lint.mdx.mjs (100%) rename packages/typedoc-plugin-markdown/test/fixtures/{config.ts => config.mjs} (97%) create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/_media/PROJECT_DOC_1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/_media/logo.png create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/_media/logo.svg create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/classes/BaseClassProperties.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/classes/ClassPropertiesTable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/enumerations/CommentEnum.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/enumerations/EnumMembersTable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/constFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/constFunctionWithReturns.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/functionWithBlockTags.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/multipleExampleTags.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/parametersTable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/singleExampleTag.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/BaseInterfaceProperties.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/CommentInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/CommentInterfaceExtended.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/InterfacePropertiesTable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/SameName.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/type-aliases/TypeDeclarationTable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/type-aliases/TypeWithGenerics.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/type-aliases/typeWithBlockTags.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/SameName.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/TypeDeclarationTable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/prop.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/prop_with_underscore.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/propb.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Class.BaseClassProperties.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Class.ClassPropertiesTable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Enumeration.CommentEnum.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Enumeration.EnumMembersTable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.constFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.constFunctionWithReturns.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.functionWithBlockTags.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.multipleExampleTags.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.parametersTable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.singleExampleTag.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.BaseInterfaceProperties.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.CommentInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.CommentInterfaceExtended.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.InterfacePropertiesTable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.SameName.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/TypeAlias.TypeDeclarationTable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/TypeAlias.TypeWithGenerics.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/TypeAlias.typeWithBlockTags.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable.SameName.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable.TypeDeclarationTable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable._prop_with_underscore.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable.prop.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable.propb.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/_media/PROJECT_DOC_1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/_media/logo.png create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/_media/logo.svg create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/_media/PROJECT_DOC_1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/_media/logo.png create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/_media/logo.svg create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/_media/PROJECT_DOC_1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/_media/logo.png create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/_media/logo.svg create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/functions/someFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/post-render-async-job.txt create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/pre-render-async-job.txt create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/renderer-event-begin.txt create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/renderer-event-end.txt create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/classes/ClassWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/classes/documents/CLASS_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/documents/MODULE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/enumerations/EnumWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/enumerations/documents/ENUM_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_3.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/functionWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/multipleFunctionWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/interfaces/InterfaceWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/interfaces/documents/INTERFACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/NamespaceClassWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/documents/CLASS_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/type-aliases/TypeWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/type-aliases/documents/TYPE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/variables/documents/VARIABLE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/variables/variableWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/classes/ClassWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/classes/documents/CLASS_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/documents/MODULE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/enumerations/EnumWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/enumerations/documents/ENUM_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/documents/FUNCTION_DOC_1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/documents/FUNCTION_DOC_2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/documents/FUNCTION_DOC_3.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/functionWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/multipleFunctionWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/interfaces/InterfaceWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/interfaces/documents/INTERFACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/type-aliases/TypeWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/type-aliases/documents/TYPE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/variables/documents/VARIABLE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/variables/variableWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/documents/Project-Document-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/documents/docs/project/PROJECT_DOC_2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/documents/docs/project/PROJECT_DOC_3.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/Document.Project-Document-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/Document.docs.project.PROJECT_DOC_2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/Document.docs.project.PROJECT_DOC_3.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Class.ClassWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.ClassWithDocuments.Document.CLASS_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Document.MODULE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.EnumWithDocuments.Document.ENUM_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Enumeration.EnumWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Function.functionWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Function.multipleFunctionWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Interface.InterfaceWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.InterfaceWithDocuments.Document.INTERFACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Namespace.NamespaceWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.NamespaceWithDocuments.Class.NamespaceClassWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.NamespaceWithDocuments.Document.NAMESPACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.NamespaceWithDocuments.NamespaceClassWithDocuments.Document.CLASS_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.TypeAlias.TypeWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.TypeWithDocuments.Document.TYPE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Variable.variableWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.functionWithDocuments.Document.FUNCTION_DOC_1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.multipleFunctionWithDocuments.Document.FUNCTION_DOC_1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.multipleFunctionWithDocuments.Document.FUNCTION_DOC_2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.multipleFunctionWithDocuments.Document.FUNCTION_DOC_3.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.variableWithDocuments.Document.VARIABLE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Class.ClassWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.ClassWithDocuments.Document.CLASS_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Document.MODULE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.EnumWithDocuments.Document.ENUM_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Enumeration.EnumWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Function.functionWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Function.multipleFunctionWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Interface.InterfaceWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.InterfaceWithDocuments.Document.INTERFACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.TypeAlias.TypeWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.TypeWithDocuments.Document.TYPE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Variable.variableWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.functionWithDocuments.Document.FUNCTION_DOC_1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.multipleFunctionWithDocuments.Document.FUNCTION_DOC_1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.multipleFunctionWithDocuments.Document.FUNCTION_DOC_2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.multipleFunctionWithDocuments.Document.FUNCTION_DOC_3.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.variableWithDocuments.Document.VARIABLE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Class.CLASS_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Enumeration.ENUM_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_3.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Interface.INTERFACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/MODULE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/TypeAlias.TYPE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Variable.VARIABLE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/Class.CLASS_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Class.CLASS_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Enumeration.ENUM_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Function.FUNCTION_DOC_1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Function.FUNCTION_DOC_2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Function.FUNCTION_DOC_3.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Interface.INTERFACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/MODULE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/TypeAlias.TYPE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Variable.VARIABLE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/documents/Project-Document-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/documents/docs/project/PROJECT_DOC_2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/documents/docs/project/PROJECT_DOC_3.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Class.CLASS_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Enumeration.ENUM_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Function.FUNCTION_DOC_1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Function.FUNCTION_DOC_2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Function.FUNCTION_DOC_3.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Interface.INTERFACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Project-Document-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.TypeAlias.TYPE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Variable.VARIABLE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.docs.project.PROJECT_DOC_2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.docs.project.PROJECT_DOC_3.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments1.Document.MODULE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments1.Namespace.NamespaceWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments1.NamespaceWithDocuments.Document.NAMESPACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments2.Document.MODULE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/classes/ClassWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/classes/documents/CLASS_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/documents/MODULE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/enumerations/EnumWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/enumerations/documents/ENUM_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_3.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/functionWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/multipleFunctionWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/interfaces/InterfaceWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/interfaces/documents/INTERFACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/NamespaceClassWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/documents/CLASS_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/type-aliases/TypeWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/type-aliases/documents/TYPE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/variables/documents/VARIABLE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/variables/variableWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/documents/Project-Document-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/classes/ClassWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/classes/documents/CLASS_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/documents/MODULE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/enumerations/EnumWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/enumerations/documents/ENUM_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_3.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/functionWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/multipleFunctionWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/interfaces/InterfaceWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/interfaces/documents/INTERFACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/NamespaceClassWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/documents/CLASS_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/type-aliases/TypeWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/type-aliases/documents/TYPE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/variables/documents/VARIABLE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/variables/variableWithDocuments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/documents/Project-Document-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Class.CLASS_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Enumeration.ENUM_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_3.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Interface.INTERFACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/MODULE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/TypeAlias.TYPE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Variable.VARIABLE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/Class.CLASS_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/documents/Project-Document-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Class.CLASS_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Enumeration.ENUM_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_3.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Interface.INTERFACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/MODULE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/TypeAlias.TYPE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Variable.VARIABLE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/Class.CLASS_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/documents/Project-Document-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/.nojekyll create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/@scope/module-1/README.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/@scope/module-1/classes/ModuleClass.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/README.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/entry-module/classes/ModuleClass.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/module-2/README.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/module-2/classes/ModuleClass.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/readme_.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/entry-module/classes/ModuleClass.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/index.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/module-1/classes/ModuleClass.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/module-1/index.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/module-2/classes/ModuleClass.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/module-2/index.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/.nojekyll create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/@scope/module-1.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/README.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/module-2.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/readme_.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-2/index.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-2/module-1.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-2/module-2.mdx create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/-internal-/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/42-module-name/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/classes/ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/classes/ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/enumerations/EnumA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/enumerations/EnumB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/functions/functionA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/interfaces/InterfaceA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/interfaces/InterfaceB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/type-aliases/TypeA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/type-aliases/TypeB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/variables/variableA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/variables/variableB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/CategoryAEnum1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/CategoryAEnum2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/CategoryBEnum1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/CategoryBEnum2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/UnCategorizedEnum.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryAInterface1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryAInterface2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryBInterface1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryBInterface2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryCInterface1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryCInterface2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/UnCategorizedInterace.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/variables/variabelA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/variables/variableB1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/variables/variableB2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/variables/variableC.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/classes/ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/classes/Class_A.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/enumerations/EnumB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/enumerations/Enum_A.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/functions/functionB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/functions/function_A.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/interfaces/InterfaceB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/interfaces/Interface_A.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/NamespaceB/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/Namespace_A/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/Namespace_A/interfaces/NamespaceInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/interfaces/NamespaceInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/type-aliases/TypeB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/type-aliases/Type_A.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/variables/variableB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/variables/variable_A.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-references/functions/defaultFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-references/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-same-exports/classes/SomeClass-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-same-exports/classes/someClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-same-exports/functions/someFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-same-exports/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/index/classes/SomeClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/index/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/modules.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/-internal-/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/42-module-name/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/classes/ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/classes/ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/enumerations/EnumA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/enumerations/EnumB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/functions/functionA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/interfaces/InterfaceA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/interfaces/InterfaceB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/type-aliases/TypeA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/type-aliases/TypeB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/CategoryAEnum1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/CategoryAEnum2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/CategoryBEnum1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/CategoryBEnum2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/UnCategorizedEnum.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryAInterface1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryAInterface2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryBInterface1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryBInterface2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryCInterface1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryCInterface2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/UnCategorizedInterace.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-custom-groups/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/classes/ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/classes/Class_A.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/enumerations/EnumB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/enumerations/Enum_A.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/functions/functionB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/functions/function_A.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/interfaces/InterfaceB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/interfaces/Interface_A.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/NamespaceB/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/Namespace_A/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/Namespace_A/interfaces/NamespaceInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/interfaces/NamespaceInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/type-aliases/TypeB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/type-aliases/Type_A.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-references/functions/defaultFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-references/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-same-exports/classes/SomeClass-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-same-exports/classes/someClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-same-exports/functions/someFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-same-exports/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/index/classes/SomeClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/index/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/-internal-.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/42-module-name.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/basic.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-categories.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-custom-groups.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-namespaces/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-namespaces/namespaces/NamespaceB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-namespaces/namespaces/Namespace_A/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-references.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-same-exports.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/module_index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/modules.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/-internal-.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/42-module-name.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/basic.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-categories.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-custom-groups.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-namespaces/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-namespaces/namespaces/NamespaceB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-namespaces/namespaces/Namespace_A/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-references.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-same-exports.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/module_index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/Test_Module_Name/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/Test_Module_Name/interfaces/InterfaceA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/classes/ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/classes/ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/enumerations/EnumA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/enumerations/EnumB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/interfaces/InterfaceA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/interfaces/InterfaceB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/type-aliases/TypeA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/type-aliases/TypeB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/classes/ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/classes/ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/enumerations/EnumA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/enumerations/EnumB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/interfaces/InterfaceA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/interfaces/InterfaceB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/type-aliases/TypeA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/type-aliases/TypeB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/enumerations/EnumA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/enumerations/EnumB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/interfaces/InterfaceA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/interfaces/InterfaceB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/type-aliases/TypeA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/type-aliases/TypeB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/enumerations/EnumA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/enumerations/EnumB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/interfaces/InterfaceA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/interfaces/InterfaceB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/type-aliases/TypeA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/type-aliases/TypeB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/classes/ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/classes/ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/enumerations/EnumA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/enumerations/EnumB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/interfaces/InterfaceA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/interfaces/InterfaceB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/type-aliases/TypeA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/type-aliases/TypeB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/modules.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/classes/ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/classes/ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/enumerations/EnumA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/enumerations/EnumB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/interfaces/InterfaceA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/interfaces/InterfaceB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/type-aliases/TypeA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/type-aliases/TypeB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Class.ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Class.ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Enumeration.EnumA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Enumeration.EnumB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Interface.InterfaceA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Interface.InterfaceB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.TypeAlias.TypeA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.TypeAlias.TypeB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/Test.Module.Name.Interface.InterfaceA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/Test.Module.Name.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/documentation.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Class.ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Class.ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Enumeration.EnumA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Enumeration.EnumB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Interface.InterfaceA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Interface.InterfaceB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.TypeAlias.TypeA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.TypeAlias.TypeB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Class.ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Class.ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Enumeration.EnumA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Enumeration.EnumB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Interface.InterfaceA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Interface.InterfaceB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.TypeAlias.TypeA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.TypeAlias.TypeB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Class.ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Class.ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Enumeration.EnumA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Enumeration.EnumB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Interface.InterfaceA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Interface.InterfaceB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.TypeAlias.TypeA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.TypeAlias.TypeB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Class.ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Class.ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Enumeration.EnumA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Enumeration.EnumB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Interface.InterfaceA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Interface.InterfaceB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.TypeAlias.TypeA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.TypeAlias.TypeB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Class.ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Class.ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Enumeration.EnumA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Enumeration.EnumB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Interface.InterfaceA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Interface.InterfaceB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.TypeAlias.TypeA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.TypeAlias.TypeB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/Test_Module_Name.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-1/submodules/submodule-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-1/submodules/submodule-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/modules.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/namespace.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/@scope.namespace.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/Test.Module.Name.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/documentation.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-1.submodules.submodule-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-1.submodules.submodule-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module1/interfaces/SomeInterface1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module1/interfaces/SomeInterface2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module1/interfaces/SomeInterface3.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module2/interfaces/SomeInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module1/interfaces/SomeInterface1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module1/interfaces/SomeInterface2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module1/interfaces/SomeInterface3.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module2/interfaces/SomeInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-1/Module1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-1/Module2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-2/Module1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-2/Module2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/AbstractClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/BaseClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/BasicClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/CallbacksOptions.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ChildClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ChildClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithAccessorKeywords.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithAccessors.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithComplexProps.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithConstructorOverloads.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithFlags.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithModifiers.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithPropCategories.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithSimpleProps.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithSymbols.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithTypeParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithoutPropCategories.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/DerivedClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/DerivedClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/DisposableClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/GrandChildClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/GrandChildClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/enumerations/BasicEnum.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/enumerations/EnumWithValues.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/basicFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/basicFunctionWithReturns.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/curriedFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAPromise.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAString.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAUnionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAnObject.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithArrayOfOptionalStuff.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithArrayOfStuff.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithComplexParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithDefaultParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithMultipleSignatures.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithNamedParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithNestedParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithOptionalParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithRestParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithTypeParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithUnionParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/globals.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/BasicInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/CustomEventInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/ExtendedInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/IndexableInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/InterfaceWithComments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/InterfaceWithEventProperties.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/InterfaceWithFlags.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/InterfaceWithTypeParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/MultipleIndexableInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ArrayOfStuff.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ArrayType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ConditionalType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ExternalReferenceType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/FunctionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/IndexAccessType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/IntersectionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/LiteralType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/PartialMappedType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/PrimitiveType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/PromiseTypeWithObject.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/PromiseTypeWithSymbol.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/QueryType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ReadonlyMappedType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/StringLiteralType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/Stuff.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TupleType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TypeDeclarationWithSpecialCharacters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TypeWithExternalSymbolLinkMapping.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TypeWithReturns.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TypeWithTypeParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/UnionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/UnionTypeWithTemplateStrings.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/UsefulUnionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/objectLiteralVariable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/objectWithSymbol.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/someQuery.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/stringVariable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/templateVariableString.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/typeOperatorVariable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/AbstractClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/BaseClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/BasicClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/CallbacksOptions.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ChildClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ChildClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithAccessorKeywords.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithAccessors.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithComplexProps.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithConstructorOverloads.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithFlags.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithModifiers.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithPropCategories.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithSimpleProps.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithSymbols.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithTypeParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithoutPropCategories.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/DerivedClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/DerivedClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/DisposableClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/GrandChildClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/GrandChildClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/enumerations/BasicEnum.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/enumerations/EnumWithValues.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/basicFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/basicFunctionWithReturns.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/curriedFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAPromise.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAString.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAUnionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAnObject.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithArrayOfOptionalStuff.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithArrayOfStuff.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithComplexParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithDefaultParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithMultipleSignatures.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithNamedParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithNestedParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithOptionalParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithRestParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithTypeParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithUnionParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/globals.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/BasicInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/CustomEventInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/ExtendedInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/IndexableInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/InterfaceWithComments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/InterfaceWithEventProperties.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/InterfaceWithFlags.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/InterfaceWithTypeParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/MultipleIndexableInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ArrayOfStuff.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ArrayType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ConditionalType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ExternalReferenceType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/FunctionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/IndexAccessType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/IntersectionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/LiteralType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/PartialMappedType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/PrimitiveType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/PromiseTypeWithObject.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/PromiseTypeWithSymbol.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/QueryType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ReadonlyMappedType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/StringLiteralType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/Stuff.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TupleType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TypeDeclarationWithSpecialCharacters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TypeWithExternalSymbolLinkMapping.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TypeWithReturns.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TypeWithTypeParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/UnionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/UnionTypeWithTemplateStrings.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/UsefulUnionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/objectLiteralVariable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/objectWithSymbol.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/someQuery.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/stringVariable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/templateVariableString.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/typeOperatorVariable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/package/members/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/package/members/opts-1/interfaces/PackageInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/package/members/opts-1/packages.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/package/members/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/package/modules/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/package/modules/opts-1/packages.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/package/modules/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-1/globals.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-1/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-1/interfaces/PackageInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/documents/Package-Document-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/index/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/index/interfaces/PackageInterfaceForIndexModule.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/module-1/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/module-1/interfaces/PackageInterface1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/module-2/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/module-2/interfaces/PackageInterface2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-1b/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-1b/interfaces/PackageInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/module-1/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/module-1/interfaces/PackageInterface1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/module-2/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/module-2/interfaces/PackageInterface2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/modules.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-4/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-4/interfaces/PackageInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-5/module1/interfaces/PackageInterface1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-5/module2/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-5/module2/interfaces/PackageInterface2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-5/package-5.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-6.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-6/module1/interfaces/PackageInterface1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-6/module2/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-6/module2/interfaces/PackageInterface2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/classes/ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/classes/ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-2/classes/ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-2/classes/ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-2/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/packages.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-1/interfaces/PackageInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-1b/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-1b/interfaces/PackageInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/module-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/module-1/interfaces/PackageInterface1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/module-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/module-2/interfaces/PackageInterface2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/documents/Package-Document-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/index/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/index/interfaces/PackageInterfaceForIndexModule.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/module-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/module-1/interfaces/PackageInterface1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/module-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/module-2/interfaces/PackageInterface2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-4/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-4/interfaces/PackageInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-5/module1/interfaces/PackageInterface1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-5/module2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-5/module2/interfaces/PackageInterface2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-5/package-5.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-6.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-6/module1/interfaces/PackageInterface1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-6/module2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-6/module2/interfaces/PackageInterface2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/classes/ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/classes/ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-2/classes/ClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-2/classes/ClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-1/globals.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-1/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/documents/Package-Document-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/interfaces/PackageInterface1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/interfaces/PackageInterface2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/interfaces/PackageInterfaceForIndexModule.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/module-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/module-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/module_index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-1b/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-2/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-2/module-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-2/module-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-2/modules.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-4/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-4/interfaces/PackageInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-5/module2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-5/package-5.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-6.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-6/module2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/module-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/module-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/packages.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-1b/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-2/module-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-2/module-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/documents/Package-Document-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/interfaces/PackageInterface1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/interfaces/PackageInterface2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/interfaces/PackageInterfaceForIndexModule.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/module-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/module-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-4/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-4/interfaces/PackageInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-5/module2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-5/package-5.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-6.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-6/module2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/module-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/module-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/readme/members/opts-1/functions/someFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/readme/members/opts-1/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/readme/members/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/readme/modules/opts-1/index.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/readme/modules/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/AbstractClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/BaseClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/BasicClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/CallbacksOptions.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ChildClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ChildClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithAccessorKeywords.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithAccessors.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithComplexProps.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithConstructorOverloads.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithFlags.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithModifiers.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithPropCategories.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithSimpleProps.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithSymbols.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithTypeParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithoutPropCategories.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/DerivedClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/DerivedClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/DisposableClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/GrandChildClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/GrandChildClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/enumerations/BasicEnum.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/enumerations/EnumWithValues.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/basicFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/basicFunctionWithReturns.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/curriedFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAPromise.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAString.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAUnionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAnObject.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithArrayOfOptionalStuff.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithArrayOfStuff.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithComplexParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithDefaultParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithMultipleSignatures.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithNamedParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithNestedParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithOptionalParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithRestParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithTypeParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithUnionParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/globals.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/BasicInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/CustomEventInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/ExtendedInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/IndexableInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/InterfaceWithComments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/InterfaceWithEventProperties.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/InterfaceWithFlags.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/InterfaceWithTypeParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/MultipleIndexableInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ArrayOfStuff.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ArrayType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ConditionalType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ExternalReferenceType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/FunctionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/IndexAccessType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/IntersectionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/LiteralType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/PartialMappedType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/PrimitiveType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/PromiseTypeWithObject.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/PromiseTypeWithSymbol.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/QueryType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ReadonlyMappedType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/StringLiteralType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/Stuff.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TupleType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TypeDeclarationWithSpecialCharacters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TypeWithExternalSymbolLinkMapping.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TypeWithReturns.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TypeWithTypeParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/UnionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/UnionTypeWithTemplateStrings.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/UsefulUnionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/objectLiteralVariable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/objectWithSymbol.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/someQuery.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/stringVariable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/templateVariableString.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/typeOperatorVariable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/AbstractClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/BaseClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/BasicClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/CallbacksOptions.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ChildClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ChildClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithAccessorKeywords.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithAccessors.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithComplexProps.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithConstructorOverloads.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithFlags.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithModifiers.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithPropCategories.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithSimpleProps.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithSymbols.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithTypeParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithoutPropCategories.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/DerivedClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/DerivedClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/DisposableClass.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/GrandChildClassA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/GrandChildClassB.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/enumerations/BasicEnum.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/enumerations/EnumWithValues.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/basicFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/basicFunctionWithReturns.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/curriedFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAFunction.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAPromise.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAString.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAUnionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAnObject.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithArrayOfOptionalStuff.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithArrayOfStuff.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithComplexParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithDefaultParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithMultipleSignatures.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithNamedParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithNestedParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithOptionalParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithRestParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithTypeParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithUnionParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/BasicInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/CustomEventInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/ExtendedInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/IndexableInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/InterfaceWithComments.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/InterfaceWithEventProperties.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/InterfaceWithFlags.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/InterfaceWithTypeParameters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/MultipleIndexableInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ArrayOfStuff.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ArrayType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ConditionalType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ExternalReferenceType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/FunctionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/IndexAccessType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/IntersectionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/LiteralType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/PartialMappedType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/PrimitiveType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/PromiseTypeWithObject.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/PromiseTypeWithSymbol.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/QueryType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ReadonlyMappedType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/StringLiteralType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/Stuff.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TupleType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TypeDeclarationWithSpecialCharacters.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TypeWithExternalSymbolLinkMapping.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TypeWithReturns.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TypeWithTypeParams.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/UnionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/UnionTypeWithTemplateStrings.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/UsefulUnionType.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/objectLiteralVariable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/objectWithSymbol.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/someQuery.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/stringVariable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/templateVariableString.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/typeOperatorVariable.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-1/globals.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/module-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/module-1/interfaces/SomeInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/module-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/module-2/variables/constA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/module-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/module-1/interfaces/SomeInterface.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/module-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/module-2/variables/constA.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-1/module-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-1/module-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-1/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-2/module-1.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-2/module-2.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-2/sidebar.json create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/classes/ClassWithChars.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/functions/some_prettier_function.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/interfaces/InterfaceWithChars.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/variables/variableWithChars.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/classes/ClassWithChars.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/functions/some_prettier_function.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/interfaces/InterfaceWithChars.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/variables/variableWithChars.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/utils/modules/opts-1/README.md create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/out/utils/modules/opts-2/README.md rename {devtools/packages => packages/typedoc-plugin-markdown/test}/fixtures/typedoc.cjs (100%) create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/typedoc.readme.cjs create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/typedoc.text-1.cjs create mode 100644 packages/typedoc-plugin-markdown/test/fixtures/typedoc.text-2.cjs delete mode 100644 packages/typedoc-plugin-markdown/test/fixtures/typedoc.text-locales.cjs delete mode 100644 packages/typedoc-plugin-markdown/test/fixtures/typedoc.text-mappings.cjs create mode 100644 packages/typedoc-plugin-remark/test/out/globals-notoc/README.md create mode 100644 packages/typedoc-plugin-remark/test/out/globals/README.md create mode 100644 packages/typedoc-plugin-remark/test/out/members/README.md create mode 100644 packages/typedoc-plugin-remark/test/out/members/module-1/README.md create mode 100644 packages/typedoc-plugin-remark/test/out/members/module-1/classes/SomeClass.md create mode 100644 packages/typedoc-plugin-remark/test/out/members/module-1/functions/some_function.md create mode 100644 packages/typedoc-plugin-remark/test/out/members/module-1/interfaces/SomeInterface.md create mode 100644 packages/typedoc-plugin-remark/test/out/members/module-2/README.md create mode 100644 packages/typedoc-plugin-remark/test/out/members/module-2/functions/some_function.md create mode 100644 packages/typedoc-plugin-remark/test/out/members/module-2/variables/someVariable.md create mode 100644 packages/typedoc-plugin-remark/test/out/modules/README.md create mode 100644 packages/typedoc-plugin-remark/test/out/modules/module-1.md create mode 100644 packages/typedoc-plugin-remark/test/out/modules/module-2.md create mode 100644 packages/typedoc-vitepress-theme/test/out/default/index.md create mode 100644 packages/typedoc-vitepress-theme/test/out/default/module-1/classes/ClassA.md create mode 100644 packages/typedoc-vitepress-theme/test/out/default/module-1/classes/ClassB.md create mode 100644 packages/typedoc-vitepress-theme/test/out/default/module-1/index.md create mode 100644 packages/typedoc-vitepress-theme/test/out/default/module-1/interfaces/InterfaceA.md create mode 100644 packages/typedoc-vitepress-theme/test/out/default/module-1/interfaces/InterfaceB.md create mode 100644 packages/typedoc-vitepress-theme/test/out/default/module-2/classes/ClassA.md create mode 100644 packages/typedoc-vitepress-theme/test/out/default/module-2/classes/ClassB.md create mode 100644 packages/typedoc-vitepress-theme/test/out/default/module-2/index.md create mode 100644 packages/typedoc-vitepress-theme/test/out/default/module-2/interfaces/InterfaceA.md create mode 100644 packages/typedoc-vitepress-theme/test/out/default/module-2/interfaces/InterfaceB.md create mode 100644 packages/typedoc-vitepress-theme/test/out/default/typedoc-sidebar.json create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options-2/index.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/classes/ClassA.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/classes/ClassB.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/index.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/interfaces/InterfaceA.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/interfaces/InterfaceB.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/classes/ClassA.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/classes/ClassB.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/index.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/interfaces/InterfaceA.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/interfaces/InterfaceB.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options-2/typedoc-sidebar.json create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options/index.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/classes/ClassA.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/classes/ClassB.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/index.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/interfaces/InterfaceA.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/interfaces/InterfaceB.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/classes/ClassA.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/classes/ClassB.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/index.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/interfaces/InterfaceA.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/interfaces/InterfaceB.md create mode 100644 packages/typedoc-vitepress-theme/test/out/sidebar-options/typedoc-sidebar.json diff --git a/.changeset/big-teachers-shave.md b/.changeset/big-teachers-shave.md index f0f8bcebf..65d6d2f12 100644 --- a/.changeset/big-teachers-shave.md +++ b/.changeset/big-teachers-shave.md @@ -4,4 +4,4 @@ - Implemented typedoc 0.27 compatibility support. - Exposed "typeDeclarationVisibility" option to provide a compacted output structure (#703). -- The "textContentMappings" option now accepts a string with placeholder or a function with arguments (#693, #715). +- Exposed "pageTitleTemplates" option that accepts a string with placeholder or function arguments to control page titles. Should be used in favour of "textContentMapping" (#693, #715). diff --git a/.changeset/chatty-cheetahs-love.md b/.changeset/chatty-cheetahs-love.md index 8df8d950a..02fa590cd 100644 --- a/.changeset/chatty-cheetahs-love.md +++ b/.changeset/chatty-cheetahs-love.md @@ -2,4 +2,4 @@ 'typedoc-plugin-markdown': minor --- -- Exposed formatting with prettier options (--formatWithPrettier and --prettierConfigFile). +- Exposed formatting with prettier options "formatWithPrettier" and "prettierConfigFile" that enables additional formatting of output if Prettier is installed on a project. diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 08ae78a08..90779d40f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -16,15 +16,13 @@ on: jobs: lint-and-test: runs-on: ubuntu-latest + timeout-minutes: 30 strategy: + fail-fast: false matrix: - node: ['20'] + node: ['18'] name: Node ${{ matrix.node }} steps: - - name: Set Swap Space - uses: pierotofy/set-swap-space@master - with: - swap-size-gb: 10 - name: Checkout repository uses: actions/checkout@v4 - name: Set up Node diff --git a/.gitignore b/.gitignore index 3e43d4a82..a894c41bb 100644 --- a/.gitignore +++ b/.gitignore @@ -6,8 +6,8 @@ dist # testing samples -out typedoc-examples +out html /devdocs-html diff --git a/devtools/packages/fixtures/README.md b/devtools/packages/fixtures/README.md deleted file mode 100644 index cb6164b57..000000000 --- a/devtools/packages/fixtures/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# @devtools/fixtures - -A private package to run fixtures from the command line. diff --git a/devtools/packages/fixtures/models.ts b/devtools/packages/fixtures/models.ts deleted file mode 100644 index 7ab752d85..000000000 --- a/devtools/packages/fixtures/models.ts +++ /dev/null @@ -1,7 +0,0 @@ -export interface Fixture { - only?: boolean; - entryPoints: string | string[]; - outputFileStrategies?: ('members' | 'modules')[]; - commonOptions: Record; - options: Record[]; -} diff --git a/devtools/packages/fixtures/package.json b/devtools/packages/fixtures/package.json deleted file mode 100644 index 9717ccea8..000000000 --- a/devtools/packages/fixtures/package.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "name": "@devtools/fixtures", - "version": "0.0.0", - "private": true, - "type": "module", - "files": [ - "/" - ], - "bin": { - "fixtures": "cli.ts" - } -} diff --git a/devtools/packages/prebuild-options/tasks/generate-models.ts b/devtools/packages/prebuild-options/tasks/generate-models.ts index 3f0a8bd3e..ada903c5e 100644 --- a/devtools/packages/prebuild-options/tasks/generate-models.ts +++ b/devtools/packages/prebuild-options/tasks/generate-models.ts @@ -66,7 +66,6 @@ import { ManuallyValidatedOption } from 'typedoc'`); theme_default_value: []; theme_default_type: []; theme_description: []; - theme_documentation: []; theme_event: []; theme_re_exports: []; theme_renames_and_re_exports: []; @@ -134,7 +133,7 @@ ${name}: ${getType(name, option, true)};`, ${Object.entries(option.defaultValue as any) .map( ([key, value]) => - `'${key}'${value === undefined ? '?' : ''}: ${getValueType(value)}`, + `'${key}'${value === undefined ? '?' : ''}: ${getValueType(key, value)}`, ) .join(';')} } @@ -161,7 +160,14 @@ function getComments(name: string) { return ''; } -function getValueType(value: any) { +function getValueType(key: string, value: any) { + if (key === 'pageTitleTemplates') { + return `{ + index: string | ((args: { name: string }) => string); + member: string; + module: string; + }`; + } if (value === true || value === false) { return 'boolean'; } @@ -179,6 +185,13 @@ function getType( option: Partial, isInterface = false, ) { + if (name === 'pageTitleTemplates') { + return `{ + index: string | ((name: { projectName: string; version: string }) => string); + member: string | ((name: { name: string; kind: string; group: string }) => string); + module: string | ((name: { name: string, kind: string }) => string); + }`; + } if (option.type === ParameterType.Array && option.defaultValue?.length) { return `(${option.defaultValue .toString() diff --git a/devtools/typedoc-plugins/typedoc-default-values.js b/devtools/typedoc-plugins/typedoc-default-values.mjs similarity index 86% rename from devtools/typedoc-plugins/typedoc-default-values.js rename to devtools/typedoc-plugins/typedoc-default-values.mjs index 3ff46238d..083e6d0cf 100644 --- a/devtools/typedoc-plugins/typedoc-default-values.js +++ b/devtools/typedoc-plugins/typedoc-default-values.mjs @@ -1,7 +1,6 @@ -const { Converter, TypeScript, CommentTag, Comment } = require('typedoc'); -const { ModifierFlags } = require('typescript'); +import { Comment, CommentTag, Converter, TypeScript } from 'typedoc'; -exports.load = function (app) { +export function load(app) { const printer = TypeScript.createPrinter({ removeComments: false, omitTrailingSemicolon: true, @@ -32,7 +31,7 @@ exports.load = function (app) { reflection.defaultValue = ''; - if (Boolean(reflection.comment)) { + if (reflection.comment) { reflection.comment.blockTags = [ ...(reflection.comment.blockTags || []), getTag(defaultValue), @@ -43,7 +42,7 @@ exports.load = function (app) { } }, ); -}; +} function getTag(value) { return new CommentTag('@defaultValue', [ { diff --git a/devtools/typedoc-plugins/typedoc-symbols.mjs b/devtools/typedoc-plugins/typedoc-symbols.mjs index ae165620e..a8407739f 100644 --- a/devtools/typedoc-plugins/typedoc-symbols.mjs +++ b/devtools/typedoc-plugins/typedoc-symbols.mjs @@ -1,7 +1,15 @@ +// @ts-check + +/** + * Local plugin to tweak TypeDoc output for nextra docs + * + * @param {import("typedoc").Application} app + */ export function load(app) { app.converter.addUnknownSymbolResolver((ref) => { if (ref.moduleSource === 'typedoc') { - const symbol = ref.symbolReference.path[0].path; + const symbol = + ref?.symbolReference?.path && ref?.symbolReference?.path[0].path; const enums = ['ReflectionKind']; const configuration = [ 'DeclarationOption', @@ -56,24 +64,28 @@ export function load(app) { 'QueryType', ]; - if (models.includes(symbol)) { - return `https://typedoc.org/api/classes/Models.${symbol}.html`; - } - if (classes.includes(symbol)) { - return `https://typedoc.org/api/classes/${symbol}.html`; - } - if (enums.includes(symbol)) { - return `https://typedoc.org/api/enums/Models.${symbol}-1.html`; - } - if (interfaces.includes(symbol)) { - return `https://typedoc.org/api/${interfaces}/TypeDocOptions.html`; - } - if (configuration.includes(symbol)) { - return `https://typedoc.org/api/types/Configuration.${symbol}.html`; - } - if (types.includes(symbol)) { - return `https://typedoc.org/api/types/${symbol}.DeclarationOption.html`; + if (symbol) { + if (models.includes(symbol)) { + return `https://typedoc.org/api/classes/Models.${symbol}.html`; + } + if (classes.includes(symbol)) { + return `https://typedoc.org/api/classes/${symbol}.html`; + } + if (enums.includes(symbol)) { + return `https://typedoc.org/api/enums/Models.${symbol}-1.html`; + } + if (interfaces.includes(symbol)) { + return `https://typedoc.org/api/${interfaces}/TypeDocOptions.html`; + } + if (configuration.includes(symbol)) { + return `https://typedoc.org/api/types/Configuration.${symbol}.html`; + } + if (types.includes(symbol)) { + return `https://typedoc.org/api/types/${symbol}.DeclarationOption.html`; + } } + + return ''; } }); } diff --git a/docs/pages/api-docs/Class.MarkdownPageEvent.mdx b/docs/pages/api-docs/Class.MarkdownPageEvent.mdx index 5209e6303..ec2aabfe2 100644 --- a/docs/pages/api-docs/Class.MarkdownPageEvent.mdx +++ b/docs/pages/api-docs/Class.MarkdownPageEvent.mdx @@ -57,6 +57,14 @@ The complete `string` filename where the file will be written.. *** +### group? + +> `optional` **group**: `string` + +The group that the reflection belongs too + +*** + ### contents? > `optional` **contents**: `string` diff --git a/docs/pages/api-docs/Class.MarkdownThemeContext.mdx b/docs/pages/api-docs/Class.MarkdownThemeContext.mdx index ee19e1443..ec7a74aa5 100644 --- a/docs/pages/api-docs/Class.MarkdownThemeContext.mdx +++ b/docs/pages/api-docs/Class.MarkdownThemeContext.mdx @@ -184,10 +184,11 @@ Partials are categorised by their use: | Parameter | Type | | :------ | :------ | | `model` | [`Comment`](https://typedoc.org/api/classes/Models.Comment.html) | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`;`showSummary`: `boolean`;`showTags`: `boolean`;`showReturns`: `boolean`;`isTableColumn`: `boolean`; \} | | `options.headingLevel`? | `number` | | `options.showSummary`? | `boolean` | | `options.showTags`? | `boolean` | +| `options.showReturns`? | `boolean` | | `options.isTableColumn`? | `boolean` | ##### Returns @@ -203,7 +204,7 @@ Partials are categorised by their use: | Parameter | Type | | :------ | :------ | | `model` | [`ContainerReflection`](https://typedoc.org/api/classes/Models.ContainerReflection.html) | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`; \} | | `options.headingLevel` | `number` | ##### Returns @@ -219,7 +220,7 @@ Partials are categorised by their use: | Parameter | Type | | :------ | :------ | | `model` | [`ReflectionCategory`](https://typedoc.org/api/types/ReflectionCategory.DeclarationOption.html)[] | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`; \} | | `options.headingLevel` | `number` | ##### Returns @@ -235,7 +236,7 @@ Partials are categorised by their use: | Parameter | Type | | :------ | :------ | | `model` | [`ReflectionGroup`](https://typedoc.org/api/classes/ReflectionGroup.html)[] | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`;`kind`: [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html); \} | | `options.headingLevel` | `number` | | `options.kind` | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | @@ -252,8 +253,9 @@ Partials are categorised by their use: | Parameter | Type | | :------ | :------ | | `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`;`groupTitle`: `string`; \} | | `options.headingLevel` | `number` | +| `options.groupTitle`? | `string` | ##### Returns @@ -268,7 +270,7 @@ Partials are categorised by their use: | Parameter | Type | | :------ | :------ | | `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`; \} | | `options.headingLevel` | `number` | ##### Returns @@ -284,7 +286,7 @@ Partials are categorised by their use: | Parameter | Type | | :------ | :------ | | `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`; \} | | `options.headingLevel` | `number` | ##### Returns @@ -300,9 +302,10 @@ Partials are categorised by their use: | Parameter | Type | | :------ | :------ | | `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`;`nested`: `boolean`;`groupTitle`: `string`; \} | | `options.headingLevel` | `number` | | `options.nested`? | `boolean` | +| `options.groupTitle`? | `string` | ##### Returns @@ -317,7 +320,7 @@ Partials are categorised by their use: | Parameter | Type | | :------ | :------ | | `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`;`nested`: `boolean`; \} | | `options.headingLevel` | `number` | | `options.nested`? | `boolean` | @@ -347,8 +350,8 @@ Partials are categorised by their use: | Parameter | Type | | :------ | :------ | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) \| [`ContainerReflection`](https://typedoc.org/api/classes/Models.ContainerReflection.html) | -| `options` | `object` | +| `model` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) \| [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`ContainerReflection`](https://typedoc.org/api/classes/Models.ContainerReflection.html) | +| `options` | \{`headingLevel`: `number`; \} | | `options.headingLevel` | `number` | ##### Returns @@ -378,7 +381,7 @@ Partials are categorised by their use: | Parameter | Type | | :------ | :------ | | `model` | [`DeclarationHierarchy`](https://typedoc.org/api/classes/Models.DeclarationHierarchy.html) | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`; \} | | `options.headingLevel` | `number` | ##### Returns @@ -408,7 +411,7 @@ Partials are categorised by their use: | Parameter | Type | | :------ | :------ | | `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`; \} | | `options.headingLevel` | `number` | ##### Returns @@ -440,7 +443,7 @@ Renders a top-level member that contains group and child members such as Classes | Parameter | Type | | :------ | :------ | | `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`; \} | | `options.headingLevel` | `number` | ##### Returns @@ -449,13 +452,15 @@ Renders a top-level member that contains group and child members such as Classes #### parametersList() -> **parametersList**: (`model`) => `string` +> **parametersList**: (`model`, `options`) => `string` ##### Parameters | Parameter | Type | | :------ | :------ | | `model` | [`ParameterReflection`](https://typedoc.org/api/classes/ParameterReflection.html)[] | +| `options` | \{`headingLevel`: `number`; \} | +| `options.headingLevel` | `number` | ##### Returns @@ -488,7 +493,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | | `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | -| `options`? | `object` | +| `options`? | \{`isEventProps`: `boolean`; \} | | `options.isEventProps`? | `boolean` | ##### Returns @@ -517,8 +522,8 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | -| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) | -| `options` | `object` | +| `model` | [`ProjectReflection`](https://typedoc.org/api/classes/Models.ProjectReflection.html) \| [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `options` | \{`headingLevel`: `number`; \} | | `options.headingLevel` | `number` | ##### Returns @@ -534,7 +539,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | | `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`;`nested`: `boolean`;`accessor`: `string`;`multipleSignatures`: `boolean`; \} | | `options.headingLevel` | `number` | | `options.nested`? | `boolean` | | `options.accessor`? | `string` | @@ -567,7 +572,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | | `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`; \} | | `options.headingLevel` | `number` | ##### Returns @@ -583,7 +588,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | | `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | -| `options`? | `object` | +| `options`? | \{`accessor`: `string`;`includeType`: `boolean`; \} | | `options.accessor`? | `string` | | `options.includeType`? | `boolean` | @@ -600,7 +605,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | | `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`;`nested`: `boolean`; \} | | `options.headingLevel` | `number` | | `options.nested`? | `boolean` | @@ -617,7 +622,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | | `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) \| [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html) | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`; \} | | `options.headingLevel` | `number` | ##### Returns @@ -633,7 +638,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | | `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`;`nested`: `boolean`; \} | | `options.headingLevel` | `number` | | `options.nested`? | `boolean` | @@ -664,7 +669,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | | `model` | [`SomeType`](https://typedoc.org/api/classes/SomeType.html)[] | -| `options`? | `object` | +| `options`? | \{`forceCollapse`: `boolean`; \} | | `options.forceCollapse`? | `boolean` | ##### Returns @@ -680,8 +685,27 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | | `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`;`allowSource`: `boolean`; \} | | `options.headingLevel` | `number` | +| `options.allowSource`? | `boolean` | + +##### Returns + +`string` + +#### typeDeclarationContainer() + +> **typeDeclarationContainer**: (`model`, `typeDeclaration`, `opts`) => `string` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `typeDeclaration` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) | +| `opts` | \{`headingLevel`: `number`;`nested`: `boolean`; \} | +| `opts.headingLevel` | `number` | +| `opts.nested`? | `boolean` | ##### Returns @@ -696,7 +720,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | | `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | -| `options` | `object` | +| `options` | \{`headingLevel`: `number`; \} | | `options.headingLevel` | `number` | ##### Returns @@ -712,7 +736,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | | `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | -| `options` | `object` | +| `options` | \{`kind`: [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html); \} | | `options.kind`? | [`ReflectionKind`](https://typedoc.org/api/enums/Models.ReflectionKind-1.html) | ##### Returns @@ -721,13 +745,15 @@ There is no association list partial for properties as these are handled as a st #### typeParametersList() -> **typeParametersList**: (`model`) => `string` +> **typeParametersList**: (`model`, `options`) => `string` ##### Parameters | Parameter | Type | | :------ | :------ | | `model` | [`TypeParameterReflection`](https://typedoc.org/api/classes/TypeParameterReflection.html)[] | +| `options` | \{`headingLevel`: `number`; \} | +| `options.headingLevel` | `number` | ##### Returns @@ -956,7 +982,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | | `model` | [`SignatureReflection`](https://typedoc.org/api/classes/SignatureReflection.html)[] | -| `options`? | `object` | +| `options`? | \{`forceParameterType`: `boolean`; \} | | `options.forceParameterType`? | `boolean` | ##### Returns @@ -972,7 +998,7 @@ There is no association list partial for properties as these are handled as a st | Parameter | Type | | :------ | :------ | | `model` | [`ReflectionType`](https://typedoc.org/api/classes/ReflectionType.html) | -| `options`? | `object` | +| `options`? | \{`forceCollapse`: `boolean`; \} | | `options.forceCollapse`? | `boolean` | ##### Returns @@ -981,13 +1007,15 @@ There is no association list partial for properties as these are handled as a st #### someType() -> **someType**: (`model`?) => `string` +> **someType**: (`model`?, `options`?) => `string` ##### Parameters | Parameter | Type | | :------ | :------ | | `model`? | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) | +| `options`? | \{`forceCollapse`: `boolean`; \} | +| `options.forceCollapse`? | `boolean` | ##### Returns @@ -1128,7 +1156,7 @@ Please note that partials: | Parameter | Type | | :------ | :------ | | `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html)[] | -| `options`? | `object` | +| `options`? | \{`includeSignatures`: `boolean`; \} | | `options.includeSignatures`? | `boolean` | ##### Returns @@ -1186,7 +1214,7 @@ Please note that partials: | Parameter | Type | | :------ | :------ | | `model` | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) | -| `options`? | `object` | +| `options`? | \{`isTarget`: `boolean`; \} | | `options.isTarget`? | `boolean` | ##### Returns @@ -1237,7 +1265,7 @@ Please note that partials: #### getProjectName() -> **getProjectName**: (`stringWithPlaceholders`, `page`) => `string` +> **getProjectName**: (`stringWithPlaceholders`, `page`, `includeVersion`) => `string` ##### Parameters @@ -1245,6 +1273,7 @@ Please note that partials: | :------ | :------ | | `stringWithPlaceholders` | `string` | | `page` | [`MarkdownPageEvent`](/api-docs/Class.MarkdownPageEvent.mdx)\<[`Reflection`](https://typedoc.org/api/classes/Reflection.html)\> | +| `includeVersion` | `boolean` | ##### Returns @@ -1292,6 +1321,20 @@ Please note that partials: `string` +#### hasUsefulTypeDetails() + +> **hasUsefulTypeDetails**: (`type`) => `boolean` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `type` | [`SomeType`](https://typedoc.org/api/classes/SomeType.html) | + +##### Returns + +`boolean` + #### isGroupKind() > **isGroupKind**: (`model`) => `boolean` diff --git a/docs/pages/api-docs/Document.Local-Plugins.mdx b/docs/pages/api-docs/Document.Local-Plugins.mdx index e9c8627e8..5535e5cb7 100644 --- a/docs/pages/api-docs/Document.Local-Plugins.mdx +++ b/docs/pages/api-docs/Document.Local-Plugins.mdx @@ -25,7 +25,7 @@ The plugin can then be consumed by adding the path to the plugin in your `typedo } ``` -Note plugins can either be consumed as CommonJs or ESM. +Note plugins must be consumed as ESM. ## See diff --git a/docs/pages/api-docs/Interface.MarkdownApplication.mdx b/docs/pages/api-docs/Interface.MarkdownApplication.mdx index 35ce47614..9392df18a 100644 --- a/docs/pages/api-docs/Interface.MarkdownApplication.mdx +++ b/docs/pages/api-docs/Interface.MarkdownApplication.mdx @@ -1,6 +1,6 @@ # MarkdownApplication -The MarkdownApplication extends TypeDoc's Application instance with a custom renderer. +The MarkdownApplication extends TypeDoc's [Application](https://typedoc.org/api/classes/Application.html) instance with a custom renderer. ## Extends @@ -12,7 +12,7 @@ The MarkdownApplication extends TypeDoc's Application instance with a custom ren > **renderer**: [`MarkdownRenderer`](/api-docs/Interface.MarkdownRenderer.mdx) & [`Renderer`](https://typedoc.org/api/classes/Renderer.html) -The renderer used to generate the documentation output. +The renderer used to generate the HTML documentation output. #### Overrides diff --git a/docs/pages/api-docs/Interface.MarkdownRenderer.mdx b/docs/pages/api-docs/Interface.MarkdownRenderer.mdx index 59f5c8ef2..9351d4ff9 100644 --- a/docs/pages/api-docs/Interface.MarkdownRenderer.mdx +++ b/docs/pages/api-docs/Interface.MarkdownRenderer.mdx @@ -1,6 +1,6 @@ # MarkdownRenderer -The MarkdownRenderer extends TypeDoc's Renderer instance with custom hooks and async jobs. +The MarkdownRenderer extends TypeDoc's [Renderer](https://typedoc.org/api/classes/Renderer.html) instance with custom hooks and async jobs. ## Extends @@ -10,7 +10,7 @@ The MarkdownRenderer extends TypeDoc's Renderer instance with custom hooks and a ### on() -#### on(event, callback) +#### Call Signature > **on**(`event`, `callback`): `void` @@ -35,7 +35,7 @@ app.renderer.on(MarkdownPageEvent.BEGIN, (renderer) => {}); `Renderer.on` -#### on(event, callback) +#### Call Signature > **on**(`event`, `callback`): `void` diff --git a/docs/pages/api-docs/Interface.PluginOptions.mdx b/docs/pages/api-docs/Interface.PluginOptions.mdx index ad8855716..b02ed3cce 100644 --- a/docs/pages/api-docs/Interface.PluginOptions.mdx +++ b/docs/pages/api-docs/Interface.PluginOptions.mdx @@ -102,6 +102,14 @@ Flatten output files to a single directory. *** +### formatWithPrettier + +> **formatWithPrettier**: `boolean` + +Apply additional output formatting with Prettier. + +*** + ### hideBreadcrumbs > **hideBreadcrumbs**: `boolean` @@ -162,7 +170,7 @@ Determines which members are exported to their own file when `outputFileStrategy > **mergeReadme**: `boolean` -Merges the resolved readme into the project index page. +Appends the documentation index page to the readme page. *** @@ -204,6 +212,26 @@ Determines how output files are generated. *** +### pageTitleTemplates + +> **pageTitleTemplates**: `object` + +Change specific text placeholders in the template. + +#### index + +> **index**: `string` \| (`name`) => `string` + +#### member + +> **member**: `string` \| (`name`) => `string` + +#### module + +> **module**: `string` \| (`name`) => `string` + +*** + ### parametersFormat > **parametersFormat**: `"table"` \| `"list"` \| `"htmlTable"` @@ -220,6 +248,14 @@ Preserve anchor casing when generating link to symbols. *** +### prettierConfigFile + +> **prettierConfigFile**: `string` + +Specify a custom Prettier configuration file location. + +*** + ### propertiesFormat > **propertiesFormat**: `"table"` \| `"list"` \| `"htmlTable"` @@ -294,29 +330,25 @@ Control how table columns are configured and displayed. Change specific text placeholders in the template. -#### header.title +##### header.title > **title**: `string` -#### header.docs - -> **docs**: `string` - -#### breadcrumbs.home +##### breadcrumbs.home > **home**: `string` -#### title.indexPage +##### title.indexPage > **indexPage**: `string` -#### title.memberPage +##### title.memberPage > **memberPage**: `string` -#### footer.text +##### title.modulePage -> **text**: `string` +> **modulePage**: `string` *** @@ -328,6 +360,14 @@ Sets the format of style for type declaration members. *** +### typeDeclarationVisibility + +> **typeDeclarationVisibility**: `"compact"` \| `"verbose"` + +Set the visibility level for type declaration documentation. + +*** + ### useCodeBlocks > **useCodeBlocks**: `boolean` diff --git a/docs/pages/api-docs/Interface.UrlMapping.mdx b/docs/pages/api-docs/Interface.UrlMapping.mdx index bcf5ee5a8..5b0b0bca1 100644 --- a/docs/pages/api-docs/Interface.UrlMapping.mdx +++ b/docs/pages/api-docs/Interface.UrlMapping.mdx @@ -29,3 +29,9 @@ The model used to define the URL mapping structure. #### Returns `string` + +*** + +### group? + +> `optional` **group**: `string` diff --git a/docs/pages/api-docs/index.mdx b/docs/pages/api-docs/index.mdx index 1f053db78..d2fdbd55e 100644 --- a/docs/pages/api-docs/index.mdx +++ b/docs/pages/api-docs/index.mdx @@ -29,9 +29,9 @@ If you are interested more generally in the TypeDoc API please visit [https://ty | Interface | Description | | :------ | :------ | -| [MarkdownApplication](/api-docs/Interface.MarkdownApplication.mdx) | The MarkdownApplication extends TypeDoc's Application instance with a custom renderer. | +| [MarkdownApplication](/api-docs/Interface.MarkdownApplication.mdx) | The MarkdownApplication extends TypeDoc's [Application](https://typedoc.org/api/classes/Application.html) instance with a custom renderer. | | [MarkdownRendererHooks](/api-docs/Interface.MarkdownRendererHooks.mdx) | Describes the hooks available to inject output in the markdown theme. | -| [MarkdownRenderer](/api-docs/Interface.MarkdownRenderer.mdx) | The MarkdownRenderer extends TypeDoc's Renderer instance with custom hooks and async jobs. | +| [MarkdownRenderer](/api-docs/Interface.MarkdownRenderer.mdx) | The MarkdownRenderer extends TypeDoc's [Renderer](https://typedoc.org/api/classes/Renderer.html) instance with custom hooks and async jobs. | | [PluginOptions](/api-docs/Interface.PluginOptions.mdx) | Describes the options declared by the plugin. | | [UrlMapping](/api-docs/Interface.UrlMapping.mdx) | The model used to define the URL mapping structure. | | [NavigationItem](/api-docs/Interface.NavigationItem.mdx) | The model used to define the navigation structure. | diff --git a/docs/pages/docs/CHANGELOG.md b/docs/pages/docs/CHANGELOG.md index 9c192e0c8..59037b6e6 100644 --- a/docs/pages/docs/CHANGELOG.md +++ b/docs/pages/docs/CHANGELOG.md @@ -1,5 +1,25 @@ # Changelog +## 4.3 Pre-release (2024-11-26) + +This release introduces support for TypeDoc 0.27 and some additional UX features and improvements in addition to some bug fixes. + +### TypeDoc 0.27 Support + +This release supports the TypeDoc 0.27 release. Please see https://github.com/TypeStrong/typedoc/blob/beta/CHANGELOG.md for full changelog. + +There are two TypeDoc breaking changes that might effect users of this plugin: + +- All CommonJs plugins will need to be refactored to ESM. +- TypeScript <5.0 is no longer supported. + +### UX Changes + +- There are some changes to list views parameters and type parameters to separate with markdown headings to improve readability and discoverability. +- Page headings have been simplified to simply display project title as per default theme. + +### Features + ## 4.2.10 (2024-11-01) ### Patch Changes diff --git a/docs/pages/docs/options.mdx b/docs/pages/docs/options.mdx index ae321a3de..254af4856 100644 --- a/docs/pages/docs/options.mdx +++ b/docs/pages/docs/options.mdx @@ -17,9 +17,9 @@ Options that are used to configure how files are output. - [--fileExtension](./options/file-options.mdx#--fileextension) - [--entryFileName](./options/file-options.mdx#--entryfilename) - [--modulesFileName](./options/file-options.mdx#--modulesfilename) +- [--mergeReadme](./options/file-options.mdx#--mergereadme) - [--entryModule](./options/file-options.mdx#--entrymodule) - [--excludeScopesInPaths](./options/file-options.mdx#--excludescopesinpaths) -- [--mergeReadme](./options/file-options.mdx#--mergereadme) ## Display Options @@ -38,9 +38,9 @@ Options that are used to configure how the output is structured and displayed. - [--interfacePropertiesFormat](./options/display-options.mdx#--interfacepropertiesformat) - [--classPropertiesFormat](./options/display-options.mdx#--classpropertiesformat) - [--enumMembersFormat](./options/display-options.mdx#--enummembersformat) +- [--propertyMembersFormat](./options/display-options.mdx#--propertymembersformat) - [--typeDeclarationFormat](./options/display-options.mdx#--typedeclarationformat) - [--typeDeclarationVisibility](./options/display-options.mdx#--typedeclarationvisibility) -- [--propertyMembersFormat](./options/display-options.mdx#--propertymembersformat) - [--tableColumnSettings](./options/display-options.mdx#--tablecolumnsettings) ## Utility Options @@ -55,4 +55,4 @@ Options that are used for general configuration and utility purposes. - [--useHTMLEncodedBrackets](./options/utility-options.mdx#--usehtmlencodedbrackets) - [--useHTMLAnchors](./options/utility-options.mdx#--usehtmlanchors) - [--preserveAnchorCasing](./options/utility-options.mdx#--preserveanchorcasing) -- [--textContentMappings](./options/utility-options.mdx#--textcontentmappings) +- [--pageTitleTemplates](./options/utility-options.mdx#--pagetitletemplates) diff --git a/docs/pages/docs/options/display-options.mdx b/docs/pages/docs/options/display-options.mdx index cec33f9d7..cf6d7543e 100644 --- a/docs/pages/docs/options/display-options.mdx +++ b/docs/pages/docs/options/display-options.mdx @@ -226,64 +226,64 @@ This option specifies the output format for enumeration members: } ``` -## --typeDeclarationFormat +## --propertyMembersFormat - Sets the format of style for type declaration members. + Sets the format of style for property members for interfaces and classes. > Accepts one of `"list"` | `"table"` | `"htmlTable"`. Defaults to `"list"`. -This option specifies the output format for type declaration of variables and type aliases. +This option will handle the formatting of object literals assigned as properties in classes or interfaces. -- **"list"**: declarations are output in linear blocks with headings, suitable for more detailed comments. -- **"table"**: declarations are output within a Markdown table, condensed into a single paragraph. -- **"htmlTable"**: declarations are output in an HTML table, enabling block elements to render in tabular format. +Note this options will only take effect when the property declaration is rendered in a `list` format. + +- **"list"**: members are output in linear blocks with headings, suitable for more detailed comments. +- **"table"**: members are output within a Markdown table, condensed into a single paragraph. +- **"htmlTable"**: members are output in an HTML table, enabling block elements to render in tabular format. ```json filename="typedoc.json" { - "typeDeclarationFormat": "list" + "propertyMembersFormat": "list" } ``` -## --typeDeclarationVisibility +## --typeDeclarationFormat - Set the visibility level for type declaration documentation. + Sets the format of style for type declaration members. -> Accepts either `"compact"` or `"expanded"`. Defaults to `"expanded"`. +> Accepts one of `"list"` | `"table"` | `"htmlTable"`. Defaults to `"list"`. -Configures the visibility level for type declaration documentation. +This option specifies the output format for type declaration of variables and type aliases. -- **"expanded"**: Displays all available documentation as text, including nested type declarations. -- **"compact"**: Omits separate documentation blocks for nested type declarations. +- **"list"**: declarations are output in linear blocks with headings, suitable for more detailed comments. +- **"table"**: declarations are output within a Markdown table, condensed into a single paragraph. +- **"htmlTable"**: declarations are output in an HTML table, enabling block elements to render in tabular format. ```json filename="typedoc.json" { - "typeDeclarationVisibility": "expanded" + "typeDeclarationFormat": "list" } ``` -## --propertyMembersFormat +## --typeDeclarationVisibility - Sets the format of style for property members for interfaces and classes. + Set the visibility level for type declaration documentation. -> Accepts one of `"list"` | `"table"` | `"htmlTable"`. Defaults to `"list"`. +> Accepts either `"compact"` or `"verbose"`. Defaults to `"verbose"`. -This option will handle the formatting of object literals assigned as properties in classes or interfaces. +Configures the visibility level for type declaration documentation. Applies to both list and table formats. -Note this options will only take effect when the property declaration is rendered in a `list` format. - -- **"list"**: members are output in linear blocks with headings, suitable for more detailed comments. -- **"table"**: members are output within a Markdown table, condensed into a single paragraph. -- **"htmlTable"**: members are output in an HTML table, enabling block elements to render in tabular format. +- **"verbose"**: Provides full documentation details for all type declarations, including nested types. +- **"compact"**: Summarizes nested types as JSON, reducing verbosity while retaining key information. ```json filename="typedoc.json" { - "propertyMembersFormat": "list" + "typeDeclarationVisibility": "verbose" } ``` diff --git a/docs/pages/docs/options/file-options.mdx b/docs/pages/docs/options/file-options.mdx index 0c2aa7cb6..a5ec7437d 100644 --- a/docs/pages/docs/options/file-options.mdx +++ b/docs/pages/docs/options/file-options.mdx @@ -172,6 +172,26 @@ Please note this option is not applicable when [`--readme`](https://typedoc.org/ } ``` +## --mergeReadme + + + Appends the documentation index page to the readme page. + + +> Accepts a boolean value. Defaults to `false`. + +By default when a readme file is resolved, a separate readme page is created. + +This option appends the documentation main/index page to the readme page so only a single root page is generated. + +This option has no effect when [`--readme`](https://typedoc.org/options/input/#readme) is set to `"none"`. + +```json filename="typedoc.json" +{ + "mergeReadme": false +} +``` + ## --entryModule @@ -226,22 +246,3 @@ Ignored if `flattenOutputFiles` is set to `true`. "excludeScopesInPaths": false } ``` - -## --mergeReadme - - - Merges the resolved readme into the project index page. - - -> Accepts a boolean value. Defaults to `false`. - -By default when a readme file is resolved, a separate readme page is created. -This option appends the index page to the readme so only a single root page is generated. - -This option has no effect when [`--readme`](https://typedoc.org/options/input/#readme) is set to `"none"`. - -```json filename="typedoc.json" -{ - "mergeReadme": false -} -``` diff --git a/docs/pages/docs/options/utility-options.mdx b/docs/pages/docs/options/utility-options.mdx index 7d6b555dc..eeb3fc69f 100644 --- a/docs/pages/docs/options/utility-options.mdx +++ b/docs/pages/docs/options/utility-options.mdx @@ -10,7 +10,7 @@ Options that are used for general configuration and utility purposes. > Accepts a boolean value. Defaults to `false`. -`typedoc-plugin-markdown` plugin generates well-formatted code, however, integrating the popular formatting package [Prettier](https://prettier.io/) can provide additional enhancements, such as: +This plugin generates well-formatted Markdown, however, integrating the popular formatting package [Prettier](https://prettier.io/) can provide additional enhancements, such as: - Formats code inside fenced blocks using the respective Prettier configuration for that language. - Aligns markdown table cells. @@ -19,7 +19,7 @@ Options that are used for general configuration and utility purposes. Please note that Prettier is not a dependency of this plugin and must be installed in your project for this option to work. -If Prettier is not already installed please `npm i prettier --save-dev` to use this option. +`npm i prettier --save-dev` to use this option. ```json filename="typedoc.json" { @@ -39,7 +39,7 @@ By default Prettier uses the options resolved from a discovered Prettier [config Use this option to specify a separate Prettier configuration file in a custom location. -Please note this option is only applicable when `formatWithPrettier` is set to `true`. +Please note this option is only applicable when `formatWithPrettier` is set to `"true"`. ```json filename="typedoc.json" { @@ -151,45 +151,48 @@ This option can be used for engines that require the preservation of anchor link } ``` -## --textContentMappings +## --pageTitleTemplates Change specific text placeholders in the template. > -Defines placeholder text that can be customized. Includes the main page header, breadcrumbs (if displayed) and main page titles. +Customizes the page titles for index, module, and member pages in the documentation. -Values can be strings that accept placeholders inside curly brace `{}`, or functions that provide placeholders as arguments. +The option is provided as an object with keys corresponding to the page type. -Default values within curly braces {} indicates a placeholder of dynamic text. +The Values of each key can be either: -- The `{projectName}` placeholder writes project's name. -- The `{version}` placeholder writes package version (if includeVersion is `true`). -- The `{kind}` placeholder writes the reflection kind of the page. -- The `{name}` placeholder writes the reflection name. -- The `{group}` place holder writes the group title -- The `{category}` placeholder writes the group title +- A function accepting input arguments. +- A strings supporting placeholders. -**Available keys** +Available placeholders / arguments: -| Key | Available Placeholders/Args | Description | -| ------------------ | ----------------------------------- | ----------------------------------------------------------- | -| `header.title` | `projectName`, `version` | Writes the project's name. | -| `breadcrumbs.home` | `projectName`, `version` | Writes the reflection kind of the page. | -| `title.indexPage` | `projectName`, `version` | Writes the package version (if `includeVersion` is `true`). | -| `title.modulePage` | `kind`, `name` | Writes the package version (if `includeVersion` is `true`). | -| `title.memberPage` | `kind`, `name`, `group`, `category` | Writes the group and name of the member page dynamically. | +- `{projectName}` - the project's name resolved by TypeDoc. +- `{version}` - the project version resolved by TypeDoc (when includeVersion is `true`). +- `{kind}` - the reflection kind of the item. +- `{group}` - the group title that the item belongs to. -If you are looking for general localization support please see TypeDoc's [`--lang`](https://typedoc.org/options/output/#lang) and [`--locales`](https://typedoc.org/options/output/#locales) options. +Available keys: + +- The `index` key (main documentation index page) accepts the `projectName` and `version` placeholder/args. +- The `module` key (module and namespace pages) accepts the `kind` and `name` placeholder/args. +- The `member` key (individual module member pages) accepts the `kind`, `name`, and `group` placeholder/args. + +```js filename="typedoc.cjs" +pageTitleTemplates: { + index: (args) => `${args.projectName}: ${args.version}`, + module: (args) => args.name, + member: (args) => `${args.kind}: ${args.name}`, +} +``` ```json filename="typedoc.json" { - "textContentMappings": { - "header.title": "{projectName} {version}", - "breadcrumbs.home": "{projectName} {version}", - "title.indexPage": "{projectName} {version}", - "title.memberPage": "{kind}: {name}", - "title.modulePage": "{name}" + "pageTitleTemplates": { + "index": "{projectName} {version}", + "member": "{kind}: {name}", + "module": "{name}" } } ``` diff --git a/docs/pages/docs/typedoc-usage.mdx b/docs/pages/docs/typedoc-usage.mdx index 6fbce159e..441fa9584 100644 --- a/docs/pages/docs/typedoc-usage.mdx +++ b/docs/pages/docs/typedoc-usage.mdx @@ -12,12 +12,12 @@ The majority of [TypeDoc's options](https://typedoc.org/options/) are used inter These options are output/theme agnostic and can be set in the same way as you would with the HTML theme: -- [Configuration](https://typedoc.org/options/configuration/) Yes ✅ -- [Input](https://typedoc.org/options/input/) Yes ✅ -- [Comments](https://typedoc.org/options/comments/) Yes ✅ -- [Organization](https://typedoc.org/options/organization/) Yes ✅ -- [Validation](https://typedoc.org/options/validation/) Yes ✅ -- [Other](https://typedoc.org/options/other/) Yes ✅ +- [Configuration](https://typedoc.org/options/configuration/) ✅ +- [Input](https://typedoc.org/options/input/) ✅ +- [Comments](https://typedoc.org/options/comments/) ✅ +- [Organization](https://typedoc.org/options/organization/) ✅ +- [Validation](https://typedoc.org/options/validation/) ✅ +- [Other](https://typedoc.org/options/other/) ✅ ### Output Options @@ -25,31 +25,16 @@ TypeDoc's [Output](https://typedoc.org/options/output/) options are used by the Below is a list of which TypeDoc Output options are supported: -- [`--out`](https://typedoc.org/options/output/#out) Yes ✅ -- [`--navigation`](https://typedoc.org/options/output/#navigation) Yes ✅ ([See Utilizing Navigation](/api-docs/Document.Utilizing-Navigation)) -- [`--theme`](https://typedoc.org/options/output/#theme) Yes ✅ (theme should be MarkdownTheme instance) -- [`--cleanOutputDir`](https://typedoc.org/options/output/#cleanoutputdir) Yes ✅ -- [`--lang`](https://typedoc.org/options/output/#lang) Yes ✅ -- [`--locale`](https://typedoc.org/options/output/#locale) Yes ✅ -- [`--basePath`](https://typedoc.org/options/output/#basepath) Yes ✅ -- [`--githubPages`](https://typedoc.org/options/output/#githubpages) Yes ✅ (defaults to `false`) -- `--hostedBaseUrl` & `--useHostedBaseUrlForAbsoluteLinks` No ❌ (use ) -- `--hideParameterTypesInTitle` No ❌ (use ) -- `--titleLink` No ❌ -- `--navigationLinks` No ❌ -- `--sidebarLinks` No ❌ -- `--navigationLeaves` No ❌ -- `--lightHighlightTheme` No ❌ -- `--darkHighlightTheme` No ❌ -- `--customCss` No ❌ -- `--markedOptions` No ❌ -- `--cname` No ❌ -- `--sourceLinkExternal` No ❌ -- `--htmlLang` No ❌ -- `--cacheBust` No ❌ -- `--gaID` No ❌ -- `--hideGenerator` No ❌ -- `--searchInComments` No ❌ +- [`--out`](https://typedoc.org/options/output/#out) ✅ +- [`--navigation`](https://typedoc.org/options/output/#navigation) ✅ ([See Utilizing Navigation](/api-docs/Document.Utilizing-Navigation)) +- [`--theme`](https://typedoc.org/options/output/#theme) ✅ (theme should be MarkdownTheme instance) +- [`--cleanOutputDir`](https://typedoc.org/options/output/#cleanoutputdir) ✅ +- [`--lang`](https://typedoc.org/options/output/#lang) ✅ +- [`--locale`](https://typedoc.org/options/output/#locale) ✅ +- [`--basePath`](https://typedoc.org/options/output/#basepath) ✅ +- [`--githubPages`](https://typedoc.org/options/output/#githubpages) ✅ (defaults to `false`) + +All other output options will have no effect on the markdown output. ## Option Typings diff --git a/docs/pages/docs/versioning.mdx b/docs/pages/docs/versioning.mdx index a008238ab..851b71394 100644 --- a/docs/pages/docs/versioning.mdx +++ b/docs/pages/docs/versioning.mdx @@ -8,13 +8,16 @@ Please note that TypeDoc is still released within the 0.x.x range and may includ A new minor version of the plugin and be released with each minor TypeDoc version, and we will attempt to release in a non-breaking manner. -## Node Version +## Compatibility Table -We will follow the Node.js version specified in the TypeDoc `package.json` file. +We will follow the Node.js and TypeScript versions as specified in the TypeDoc `package.json` file. -## Compatibility Table +Version compatibility for the plugin and TypeDoc is as follows: + +| Plugin | TypeDoc | Node | TypeScript | +| ------------- | ------- | ----- | ------------- | +| 4.3.x | 0.27.x | >= 18 | 5.0.x - 5.7.x | +| 4.1.x - 4.2.x | 0.26.x | >= 18 | 4.6.x - 5.5.x | +| 4.0.x | 0.25.x | >= 16 | 4.6.x - 5.4.x | -| typedoc-plugin-markdown | TypeDoc | Node Version | -| ----------------------- | ------- | ------------ | -| 4.1.x - 4.2.x | 0.26.x | >= 18 | -| 4.0.x | 0.25.x | >= 16 | +For more information please visit [TypeDoc installation](https://typedoc.org/guides/installation/) page. diff --git a/docs/public/schema.json b/docs/public/schema.json index 0c6a064d2..351b1d780 100644 --- a/docs/public/schema.json +++ b/docs/public/schema.json @@ -74,6 +74,10 @@ "type": "boolean", "description": "[typedoc-plugin-markdown] Flatten output files to a single directory." }, + "formatWithPrettier": { + "type": "boolean", + "description": "[typedoc-plugin-markdown] Apply additional output formatting with Prettier." + }, "hideBreadcrumbs": { "type": "boolean", "description": "[typedoc-plugin-markdown] Do not print breadcrumbs." @@ -135,7 +139,7 @@ }, "mergeReadme": { "type": "boolean", - "description": "[typedoc-plugin-markdown] Merges the resolved readme into the project index page." + "description": "[typedoc-plugin-markdown] Appends the documentation index page to the readme page." }, "modulesFileName": { "type": "string", @@ -171,6 +175,132 @@ "description": "[typedoc-plugin-markdown] Determines how output files are generated.", "default": "members" }, + "pageTitleTemplates": { + "type": "object", + "properties": { + "index": { + "anyOf": [ + { + "type": "string" + }, + { + "$comment": "(name: { projectName: string; version: string }) => string", + "type": "object", + "properties": { + "namedArgs": { + "type": "object", + "properties": { + "name": { + "type": "object", + "properties": { + "projectName": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "required": [ + "projectName", + "version" + ] + } + }, + "required": [ + "name" + ], + "additionalProperties": false + } + } + } + ] + }, + "member": { + "anyOf": [ + { + "type": "string" + }, + { + "$comment": "(name: { name: string; kind: string; group: string }) => string", + "type": "object", + "properties": { + "namedArgs": { + "type": "object", + "properties": { + "name": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "group": { + "type": "string" + } + }, + "required": [ + "name", + "kind", + "group" + ] + } + }, + "required": [ + "name" + ], + "additionalProperties": false + } + } + } + ] + }, + "module": { + "anyOf": [ + { + "type": "string" + }, + { + "$comment": "(name: { name: string; kind: string }) => string", + "type": "object", + "properties": { + "namedArgs": { + "type": "object", + "properties": { + "name": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "kind": { + "type": "string" + } + }, + "required": [ + "name", + "kind" + ] + } + }, + "required": [ + "name" + ], + "additionalProperties": false + } + } + } + ] + } + }, + "description": "[typedoc-plugin-markdown] Change specific text placeholders in the template.", + "default": { + "index": "{projectName} {version}", + "member": "{kind}: {name}", + "module": "{name}" + } + }, "parametersFormat": { "type": "string", "enum": [ @@ -185,6 +315,10 @@ "type": "boolean", "description": "[typedoc-plugin-markdown] Preserve anchor casing when generating link to symbols." }, + "prettierConfigFile": { + "type": "string", + "description": "[typedoc-plugin-markdown] Specify a custom Prettier configuration file location." + }, "propertiesFormat": { "type": "string", "enum": [ @@ -255,9 +389,6 @@ "header.title": { "type": "string" }, - "header.docs": { - "type": "string" - }, "breadcrumbs.home": { "type": "string" }, @@ -267,18 +398,17 @@ "title.memberPage": { "type": "string" }, - "footer.text": { + "title.modulePage": { "type": "string" } }, "description": "[typedoc-plugin-markdown] Change specific text placeholders in the template.", "default": { "header.title": "{projectName} {version}", - "header.docs": "Docs", "breadcrumbs.home": "{projectName} {version}", "title.indexPage": "{projectName} {version}", "title.memberPage": "{kind}: {name}", - "footer.text": "" + "title.modulePage": "{name}" } }, "typeDeclarationFormat": { @@ -291,6 +421,15 @@ "description": "[typedoc-plugin-markdown] Sets the format of style for type declaration members.", "default": "list" }, + "typeDeclarationVisibility": { + "type": "string", + "enum": [ + "compact", + "verbose" + ], + "description": "[typedoc-plugin-markdown] Set the visibility level for type declaration documentation.", + "default": "verbose" + }, "useCodeBlocks": { "type": "boolean", "description": "[typedoc-plugin-markdown] Wraps signatures and declarations in code blocks." diff --git a/package-lock.json b/package-lock.json index 50fbe2430..746bb2eec 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5,7 +5,7 @@ "packages": { "": { "workspaces": [ - "packages/typedoc-pslugin-markdown", + "packages/typedoc-plugin-markdown", "packages/typedoc-plugin-remark", "packages/typedoc-plugin-frontmatter", "packages/docusaurus-plugin-typedoc", @@ -22,7 +22,7 @@ "@types/eslint__js": "^8.42.3", "@types/fs-extra": "^11.0.4", "@types/jest": "^29.5.14", - "@types/node": "^22.9.3", + "@types/node": "^22.10.0", "consola": "^3.2.3", "copyfiles": "^2.4.1", "eslint": "^9.15.0", @@ -31,7 +31,8 @@ "husky": "^9.1.7", "jest": "^29.7.0", "markdownlint": "^0.36.1", - "prettier": "^3.3.3", + "p-limit": "^6.1.0", + "prettier": "^3.4.1", "prettier-plugin-organize-imports": "^4.1.0", "remark": "^15.0.1", "remark-gfm": "^4.0.0", @@ -44,7 +45,7 @@ "ts-morph": "^24.0.0", "tsc-alias": "^1.8.10", "tsx": "^4.19.2", - "typedoc": "^0.27.0-beta.2", + "typedoc": "^0.27.0", "typescript": "^5.7.2", "typescript-eslint": "^8.16.0" } @@ -52,6 +53,7 @@ "devtools/packages/fixtures": { "name": "@devtools/fixtures", "version": "0.0.0", + "extraneous": true, "bin": { "fixtures": "cli.ts" } @@ -2142,6 +2144,21 @@ "graceful-fs": "^4.1.6" } }, + "node_modules/@changesets/cli/node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/@changesets/cli/node_modules/universalify": { "version": "0.1.2", "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", @@ -3788,10 +3805,6 @@ "postcss": "^8.4" } }, - "node_modules/@devtools/fixtures": { - "resolved": "devtools/packages/fixtures", - "link": true - }, "node_modules/@devtools/helpers": { "resolved": "devtools/packages/helpers", "link": true @@ -4791,7 +4804,6 @@ "version": "1.23.2", "resolved": "https://registry.npmjs.org/@gerrit0/mini-shiki/-/mini-shiki-1.23.2.tgz", "integrity": "sha512-6e/41ZAilc2iE4n0bxxMSvzrt1dy2MSa9lSdd2M5lcTDlrzcau+FucIEDrG+xF1dPou/a093tm1t4HPTSI4g1w==", - "dev": true, "dependencies": { "@shikijs/engine-oniguruma": "^1.23.1", "@shikijs/types": "^1.23.1", @@ -4959,6 +4971,21 @@ "node": ">=8" } }, + "node_modules/@istanbuljs/load-nyc-config/node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/@istanbuljs/load-nyc-config/node_modules/p-locate": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", @@ -5573,6 +5600,21 @@ "node": ">=8" } }, + "node_modules/@manypkg/find-root/node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/@manypkg/find-root/node_modules/p-locate": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", @@ -5814,7 +5856,6 @@ "version": "1.23.1", "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-1.23.1.tgz", "integrity": "sha512-KQ+lgeJJ5m2ISbUZudLR1qHeH3MnSs2mjFg7bnencgs5jDVPeJ2NVDJ3N5ZHbcTsOIh0qIueyAJnwg7lg7kwXQ==", - "dev": true, "dependencies": { "@shikijs/types": "1.23.1", "@shikijs/vscode-textmate": "^9.3.0" @@ -5824,7 +5865,6 @@ "version": "1.23.1", "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-1.23.1.tgz", "integrity": "sha512-98A5hGyEhzzAgQh2dAeHKrWW4HfCMeoFER2z16p5eJ+vmPeF6lZ/elEne6/UCU551F/WqkopqRsr1l2Yu6+A0g==", - "dev": true, "dependencies": { "@shikijs/vscode-textmate": "^9.3.0", "@types/hast": "^3.0.4" @@ -5833,8 +5873,7 @@ "node_modules/@shikijs/vscode-textmate": { "version": "9.3.0", "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-9.3.0.tgz", - "integrity": "sha512-jn7/7ky30idSkd/O5yDBfAnVt+JJpepofP/POZ1iMOxK59cOfqIgg/Dj0eFsjOTMw+4ycJN0uhZH/Eb0bs/EUA==", - "dev": true + "integrity": "sha512-jn7/7ky30idSkd/O5yDBfAnVt+JJpepofP/POZ1iMOxK59cOfqIgg/Dj0eFsjOTMw+4ycJN0uhZH/Eb0bs/EUA==" }, "node_modules/@sideway/address": { "version": "4.1.5", @@ -6706,12 +6745,12 @@ "integrity": "sha512-nG96G3Wp6acyAgJqGasjODb+acrI7KltPiRxzHPXnP3NgI28bpQDRv53olbqGXbfcgF5aiiHmO3xpwEpS5Ld9g==" }, "node_modules/@types/node": { - "version": "22.9.3", - "resolved": "https://registry.npmjs.org/@types/node/-/node-22.9.3.tgz", - "integrity": "sha512-F3u1fs/fce3FFk+DAxbxc78DF8x0cY09RRL8GnXLmkJ1jvx3TtPdWoTT5/NiYfI5ASqXBmfqJi9dZ3gxMx4lzw==", + "version": "22.10.0", + "resolved": "https://registry.npmjs.org/@types/node/-/node-22.10.0.tgz", + "integrity": "sha512-XC70cRZVElFHfIUB40FgZOBbgJYFKKMa5nb9lxcwYstFG/Mi+/Y0bGS+rs6Dmhmkpq4pnNiLiuZAbc02YCOnmA==", "dev": true, "dependencies": { - "undici-types": "~6.19.8" + "undici-types": "~6.20.0" } }, "node_modules/@types/node-forge": { @@ -7788,8 +7827,7 @@ "node_modules/balanced-match": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", - "dev": true + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==" }, "node_modules/batch": { "version": "0.6.1", @@ -10190,7 +10228,6 @@ "version": "4.5.0", "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", - "dev": true, "engines": { "node": ">=0.12" }, @@ -14651,7 +14688,6 @@ "version": "5.0.0", "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz", "integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==", - "dev": true, "dependencies": { "uc.micro": "^2.0.0" } @@ -14820,8 +14856,7 @@ "node_modules/lunr": { "version": "2.3.9", "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", - "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", - "dev": true + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==" }, "node_modules/make-dir": { "version": "4.0.0", @@ -14869,7 +14904,6 @@ "version": "14.1.0", "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.0.tgz", "integrity": "sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==", - "dev": true, "dependencies": { "argparse": "^2.0.1", "entities": "^4.4.0", @@ -14885,8 +14919,7 @@ "node_modules/markdown-it/node_modules/argparse": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", - "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", - "dev": true + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==" }, "node_modules/markdown-table": { "version": "3.0.4", @@ -15284,8 +15317,7 @@ "node_modules/mdurl": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.0.0.tgz", - "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==", - "dev": true + "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==" }, "node_modules/media-typer": { "version": "0.3.0", @@ -16652,15 +16684,27 @@ } }, "node_modules/p-limit": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", - "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-6.1.0.tgz", + "integrity": "sha512-H0jc0q1vOzlEk0TqAKXKZxdl7kX3OFUzCnNVUnq5Pc3DGo0kpeaMuPqxQn235HibwBEb0/pm9dgKTjXy66fBkg==", "dev": true, "dependencies": { - "p-try": "^2.0.0" + "yocto-queue": "^1.1.1" }, "engines": { - "node": ">=6" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/p-limit/node_modules/yocto-queue": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.1.1.tgz", + "integrity": "sha512-b4JR1PFR10y1mKjhHY9LaGo6tmrgjit7hxVIeAmyMw3jegXR4dhYqLaQF5zMXZxY7tLpMyJeLjr1C4rLmkVe8g==", + "dev": true, + "engines": { + "node": ">=12.20" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -17025,6 +17069,21 @@ "node": ">=8" } }, + "node_modules/pkg-dir/node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/pkg-dir/node_modules/p-locate": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", @@ -17083,6 +17142,21 @@ "node": ">=6" } }, + "node_modules/pkg-up/node_modules/p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/pkg-up/node_modules/p-locate": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", @@ -18625,9 +18699,9 @@ } }, "node_modules/prettier": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.3.3.tgz", - "integrity": "sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew==", + "version": "3.4.1", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.4.1.tgz", + "integrity": "sha512-G+YdqtITVZmOJje6QkXQWzl3fSfMxFwm1tjTyo9exhkmWSqC4Yhd1+lug++IlR2mvRVAxEDDWYkQdeSztajqgg==", "dev": true, "bin": { "prettier": "bin/prettier.cjs" @@ -18775,7 +18849,6 @@ "version": "2.3.1", "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz", "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==", - "dev": true, "engines": { "node": ">=6" } @@ -21616,10 +21689,9 @@ } }, "node_modules/typedoc": { - "version": "0.27.0-beta.2", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.27.0-beta.2.tgz", - "integrity": "sha512-yLhYB5honuZZOHtXZBQ0WDQbo+vl2gTGog0C5EtSbLUAmPA9V6eps9hACg+EsONsAOrucjHhJSco07df3MPi9Q==", - "dev": true, + "version": "0.27.0", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.27.0.tgz", + "integrity": "sha512-7AkTJhFdhsihthaBFHNpj5iFdLyR7FpQqXM+IABJmE1/qTjWypirCLrheToUP3fjpWHN1Drn3K7PWH1t37KvNQ==", "dependencies": { "@gerrit0/mini-shiki": "^1.23.2", "lunr": "^2.3.9", @@ -21665,7 +21737,6 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", - "dev": true, "dependencies": { "balanced-match": "^1.0.0" } @@ -21674,7 +21745,6 @@ "version": "9.0.5", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", - "dev": true, "dependencies": { "brace-expansion": "^2.0.1" }, @@ -21689,7 +21759,6 @@ "version": "5.7.2", "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.7.2.tgz", "integrity": "sha512-i5t66RHxDvVN40HfDd1PsEThGNnlMCMT3jMUuoh9/0TaqWevNontacunWyN02LA9/fIbEWlcHZcgTKb9QoaLfg==", - "dev": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -21727,13 +21796,12 @@ "node_modules/uc.micro": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz", - "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==", - "dev": true + "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==" }, "node_modules/undici-types": { - "version": "6.19.8", - "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.19.8.tgz", - "integrity": "sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==", + "version": "6.20.0", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.20.0.tgz", + "integrity": "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg==", "dev": true }, "node_modules/unicode-canonical-property-names-ecmascript": { @@ -23102,6 +23170,9 @@ "license": "MIT", "engines": { "node": ">= 18" + }, + "peerDependencies": { + "typedoc": "0.27.x" } }, "packages/typedoc-plugin-remark": { diff --git a/package.json b/package.json index 52fcd084d..796123487 100644 --- a/package.json +++ b/package.json @@ -15,6 +15,7 @@ "devdocs": "npm run build --workspace typedoc-plugin-markdown && typedoc", "build-all": "npm run build --workspaces --if-present", "test-all": "npm run test --workspaces --if-present", + "test-and-update-all": "npm run test:update --workspaces --if-present", "lint-all": "npm run lint --workspaces --if-present", "prerelease": "npm run build-all", "release": "npx changeset publish", @@ -28,7 +29,7 @@ "@types/eslint__js": "^8.42.3", "@types/fs-extra": "^11.0.4", "@types/jest": "^29.5.14", - "@types/node": "^22.9.3", + "@types/node": "^22.10.0", "consola": "^3.2.3", "copyfiles": "^2.4.1", "eslint": "^9.15.0", @@ -37,7 +38,8 @@ "husky": "^9.1.7", "jest": "^29.7.0", "markdownlint": "^0.36.1", - "prettier": "^3.3.3", + "p-limit": "^6.1.0", + "prettier": "^3.4.1", "prettier-plugin-organize-imports": "^4.1.0", "remark": "^15.0.1", "remark-gfm": "^4.0.0", @@ -50,7 +52,7 @@ "ts-morph": "^24.0.0", "tsc-alias": "^1.8.10", "tsx": "^4.19.2", - "typedoc": "^0.27.0-beta.2", + "typedoc": "^0.27.0", "typescript": "^5.7.2", "typescript-eslint": "^8.16.0" } diff --git a/packages/docusaurus-plugin-typedoc/OVERVIEW.md b/packages/docusaurus-plugin-typedoc/OVERVIEW.md index b5c1c03eb..6b0636489 100644 --- a/packages/docusaurus-plugin-typedoc/OVERVIEW.md +++ b/packages/docusaurus-plugin-typedoc/OVERVIEW.md @@ -1,9 +1,9 @@ -# typedoc-vitepress-theme +# docusaurus-plugin-typedoc -"typedoc-vitepress-theme" is a "theme" in the sense that it targets output for VitePress. +"docusaurus-plugin-typedoc" is a Docusaurus plugin that bootstraps TypeDoc within the Docusaurus eco-system. ## What Does the Package Do? -- Exposes some additional options to TypeDoc. -- Presets relevant typedoc-plugin-markdown options. -- Generates a sidebar json file. +- Presets relevant options of typedoc-plugin-markdown. +- Bootstraps TypeDoc from the Docusaurus CLI. +- Generates a sidebar file with configurable structure. diff --git a/packages/docusaurus-plugin-typedoc/test/out/default/index.md b/packages/docusaurus-plugin-typedoc/test/out/default/index.md new file mode 100644 index 000000000..5492d5c44 --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/default/index.md @@ -0,0 +1,7 @@ +# docusaurus-plugin-typedoc + +## Modules + +- [links](links/index.md) +- [module-1](module-1/index.md) +- [module-2](module-2/index.md) diff --git a/packages/docusaurus-plugin-typedoc/test/out/default/links/enumerations/CommentEnum.md b/packages/docusaurus-plugin-typedoc/test/out/default/links/enumerations/CommentEnum.md new file mode 100644 index 000000000..0795fdf71 --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/default/links/enumerations/CommentEnum.md @@ -0,0 +1,13 @@ +# Enumeration: CommentEnum + +## Enumeration Members + +### Member + +> **Member**: `0` + +*** + +### MemberB + +> **MemberB**: `1` diff --git a/packages/docusaurus-plugin-typedoc/test/out/default/links/index.md b/packages/docusaurus-plugin-typedoc/test/out/default/links/index.md new file mode 100644 index 000000000..1f9e19265 --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/default/links/index.md @@ -0,0 +1,12 @@ +# links + +## Index + +### Enumerations + +- [CommentEnum](enumerations/CommentEnum.md) + +### Interfaces + +- [CommentInterface](interfaces/CommentInterface.md) +- [CommentInterfaceExtended](interfaces/CommentInterfaceExtended.md) diff --git a/packages/docusaurus-plugin-typedoc/test/out/default/links/interfaces/CommentInterface.md b/packages/docusaurus-plugin-typedoc/test/out/default/links/interfaces/CommentInterface.md new file mode 100644 index 000000000..3a97e5b5e --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/default/links/interfaces/CommentInterface.md @@ -0,0 +1,31 @@ +# Interface: CommentInterface\ + +Comments form module comments + +Links using `{@link}` inline tags. + +- [CommentInterface](CommentInterface.md) - Links to CommentInterface +- [Links to CommentInterface.prop](CommentInterface.md#prop) +- [Links to CommentInterface.propb](CommentInterface.md#propb) + +## Extended by + +- [`CommentInterfaceExtended`](CommentInterfaceExtended.md) + +## Type Parameters + +### T + +\- + +## Properties + +### prop + +> **prop**: `string` + +*** + +### propb + +> **propb**: `T` diff --git a/packages/docusaurus-plugin-typedoc/test/out/default/links/interfaces/CommentInterfaceExtended.md b/packages/docusaurus-plugin-typedoc/test/out/default/links/interfaces/CommentInterfaceExtended.md new file mode 100644 index 000000000..6063642b2 --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/default/links/interfaces/CommentInterfaceExtended.md @@ -0,0 +1,39 @@ +# Interface: CommentInterfaceExtended + +Comments form module comments + +Links using `{@link}` inline tags. + +- [CommentInterface](CommentInterface.md) - Links to CommentInterface +- [Links to CommentInterface.prop](CommentInterface.md#prop) +- [Links to CommentInterface.propb](CommentInterface.md#propb) + +## Extends + +- [`CommentInterface`](CommentInterface.md)\<[`CommentEnum`](../enumerations/CommentEnum.md)\> + +## Properties + +### prop + +> **prop**: `string` + +#### Inherited from + +[`CommentInterface`](CommentInterface.md).[`prop`](CommentInterface.md#prop) + +*** + +### propb + +> **propb**: [`CommentEnum`](../enumerations/CommentEnum.md) + +#### Inherited from + +[`CommentInterface`](CommentInterface.md).[`propb`](CommentInterface.md#propb) + +*** + +### propc + +> **propc**: `string` diff --git a/packages/docusaurus-plugin-typedoc/test/out/default/module-1/classes/ClassA.md b/packages/docusaurus-plugin-typedoc/test/out/default/module-1/classes/ClassA.md new file mode 100644 index 000000000..b05380e0c --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/default/module-1/classes/ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/docusaurus-plugin-typedoc/test/out/default/module-1/classes/ClassB.md b/packages/docusaurus-plugin-typedoc/test/out/default/module-1/classes/ClassB.md new file mode 100644 index 000000000..de4b002bc --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/default/module-1/classes/ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/docusaurus-plugin-typedoc/test/out/default/module-1/index.md b/packages/docusaurus-plugin-typedoc/test/out/default/module-1/index.md new file mode 100644 index 000000000..3422326b5 --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/default/module-1/index.md @@ -0,0 +1,13 @@ +# module-1 + +## Index + +### CategoryA + +- [ClassA](classes/ClassA.md) + +### CategoryB + +- [ClassB](classes/ClassB.md) +- [InterfaceA](interfaces/InterfaceA.md) +- [InterfaceB](interfaces/InterfaceB.md) diff --git a/packages/docusaurus-plugin-typedoc/test/out/default/module-1/interfaces/InterfaceA.md b/packages/docusaurus-plugin-typedoc/test/out/default/module-1/interfaces/InterfaceA.md new file mode 100644 index 000000000..05ebc7537 --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/default/module-1/interfaces/InterfaceA.md @@ -0,0 +1 @@ +# Interface: InterfaceA diff --git a/packages/docusaurus-plugin-typedoc/test/out/default/module-1/interfaces/InterfaceB.md b/packages/docusaurus-plugin-typedoc/test/out/default/module-1/interfaces/InterfaceB.md new file mode 100644 index 000000000..635164782 --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/default/module-1/interfaces/InterfaceB.md @@ -0,0 +1 @@ +# Interface: InterfaceB diff --git a/packages/docusaurus-plugin-typedoc/test/out/default/module-2/classes/ClassA.md b/packages/docusaurus-plugin-typedoc/test/out/default/module-2/classes/ClassA.md new file mode 100644 index 000000000..b05380e0c --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/default/module-2/classes/ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/docusaurus-plugin-typedoc/test/out/default/module-2/classes/ClassB.md b/packages/docusaurus-plugin-typedoc/test/out/default/module-2/classes/ClassB.md new file mode 100644 index 000000000..de4b002bc --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/default/module-2/classes/ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/docusaurus-plugin-typedoc/test/out/default/module-2/index.md b/packages/docusaurus-plugin-typedoc/test/out/default/module-2/index.md new file mode 100644 index 000000000..1946a6c66 --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/default/module-2/index.md @@ -0,0 +1,13 @@ +# module-2 + +## Index + +### Classes + +- [ClassA](classes/ClassA.md) +- [ClassB](classes/ClassB.md) + +### Interfaces + +- [InterfaceA](interfaces/InterfaceA.md) +- [InterfaceB](interfaces/InterfaceB.md) diff --git a/packages/docusaurus-plugin-typedoc/test/out/default/module-2/interfaces/InterfaceA.md b/packages/docusaurus-plugin-typedoc/test/out/default/module-2/interfaces/InterfaceA.md new file mode 100644 index 000000000..05ebc7537 --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/default/module-2/interfaces/InterfaceA.md @@ -0,0 +1 @@ +# Interface: InterfaceA diff --git a/packages/docusaurus-plugin-typedoc/test/out/default/module-2/interfaces/InterfaceB.md b/packages/docusaurus-plugin-typedoc/test/out/default/module-2/interfaces/InterfaceB.md new file mode 100644 index 000000000..635164782 --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/default/module-2/interfaces/InterfaceB.md @@ -0,0 +1 @@ +# Interface: InterfaceB diff --git a/packages/docusaurus-plugin-typedoc/test/out/default/typedoc-sidebar.cjs b/packages/docusaurus-plugin-typedoc/test/out/default/typedoc-sidebar.cjs new file mode 100644 index 000000000..7095ad0ed --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/default/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: [{"type":"category","label":"links","items":[{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"out/default/links/enumerations/CommentEnum","label":"CommentEnum"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"out/default/links/interfaces/CommentInterface","label":"CommentInterface"},{"type":"doc","id":"out/default/links/interfaces/CommentInterfaceExtended","label":"CommentInterfaceExtended"}]}],"link":{"type":"doc","id":"out/default/links/index"}},{"type":"category","label":"module-1","items":[{"type":"category","label":"CategoryA","items":[{"type":"doc","id":"out/default/module-1/classes/ClassA","label":"ClassA"}]},{"type":"category","label":"CategoryB","items":[{"type":"doc","id":"out/default/module-1/classes/ClassB","label":"ClassB"},{"type":"doc","id":"out/default/module-1/interfaces/InterfaceA","label":"InterfaceA"},{"type":"doc","id":"out/default/module-1/interfaces/InterfaceB","label":"InterfaceB"}]}],"link":{"type":"doc","id":"out/default/module-1/index"}},{"type":"category","label":"module-2","items":[{"type":"category","label":"Classes","items":[{"type":"doc","id":"out/default/module-2/classes/ClassA","label":"ClassA"},{"type":"doc","id":"out/default/module-2/classes/ClassB","label":"ClassB"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"out/default/module-2/interfaces/InterfaceA","label":"InterfaceA"},{"type":"doc","id":"out/default/module-2/interfaces/InterfaceB","label":"InterfaceB"}]}],"link":{"type":"doc","id":"out/default/module-2/index"}}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/packages/docusaurus-plugin-typedoc/test/out/global-members/classes/ClassA.mdx b/packages/docusaurus-plugin-typedoc/test/out/global-members/classes/ClassA.mdx new file mode 100644 index 000000000..3bb39afbb --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/global-members/classes/ClassA.mdx @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.mdx) + +#### Returns + +[`ClassA`](ClassA.mdx) diff --git a/packages/docusaurus-plugin-typedoc/test/out/global-members/classes/ClassB.mdx b/packages/docusaurus-plugin-typedoc/test/out/global-members/classes/ClassB.mdx new file mode 100644 index 000000000..189766c7e --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/global-members/classes/ClassB.mdx @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.mdx) + +#### Returns + +[`ClassB`](ClassB.mdx) diff --git a/packages/docusaurus-plugin-typedoc/test/out/global-members/index.mdx b/packages/docusaurus-plugin-typedoc/test/out/global-members/index.mdx new file mode 100644 index 000000000..dea4d6d24 --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/global-members/index.mdx @@ -0,0 +1,11 @@ +# docusaurus-plugin-typedoc + +## CategoryA + +- [ClassA](classes/ClassA.mdx) + +## CategoryB + +- [ClassB](classes/ClassB.mdx) +- [InterfaceA](interfaces/InterfaceA.mdx) +- [InterfaceB](interfaces/InterfaceB.mdx) diff --git a/packages/docusaurus-plugin-typedoc/test/out/global-members/interfaces/InterfaceA.mdx b/packages/docusaurus-plugin-typedoc/test/out/global-members/interfaces/InterfaceA.mdx new file mode 100644 index 000000000..05ebc7537 --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/global-members/interfaces/InterfaceA.mdx @@ -0,0 +1 @@ +# Interface: InterfaceA diff --git a/packages/docusaurus-plugin-typedoc/test/out/global-members/interfaces/InterfaceB.mdx b/packages/docusaurus-plugin-typedoc/test/out/global-members/interfaces/InterfaceB.mdx new file mode 100644 index 000000000..635164782 --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/global-members/interfaces/InterfaceB.mdx @@ -0,0 +1 @@ +# Interface: InterfaceB diff --git a/packages/docusaurus-plugin-typedoc/test/out/global-members/typedoc-sidebar.cjs b/packages/docusaurus-plugin-typedoc/test/out/global-members/typedoc-sidebar.cjs new file mode 100644 index 000000000..035479005 --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/global-members/typedoc-sidebar.cjs @@ -0,0 +1,37 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: [ + { + "type": "category", + "label": "CategoryA", + "items": [ + { + "type": "doc", + "id": "out/global-members/classes/ClassA", + "label": "ClassA" + } + ] + }, + { + "type": "category", + "label": "CategoryB", + "items": [ + { + "type": "doc", + "id": "out/global-members/classes/ClassB", + "label": "ClassB" + }, + { + "type": "doc", + "id": "out/global-members/interfaces/InterfaceA", + "label": "InterfaceA" + }, + { + "type": "doc", + "id": "out/global-members/interfaces/InterfaceB", + "label": "InterfaceB" + } + ] + } +]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/packages/docusaurus-plugin-typedoc/test/out/links/index.md b/packages/docusaurus-plugin-typedoc/test/out/links/index.md new file mode 100644 index 000000000..954bfafb7 --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/links/index.md @@ -0,0 +1,85 @@ +# docusaurus-plugin-typedoc + +## Enumerations + +### CommentEnum + +#### Enumeration Members + +##### Member + +> **Member**: `0` + +##### MemberB + +> **MemberB**: `1` + +## Interfaces + +### CommentInterface\ + +Comments form module comments + +Links using `{@link}` inline tags. + +- [CommentInterface](index.md#commentinterfacet) - Links to CommentInterface +- [Links to CommentInterface.prop](index.md#prop) +- [Links to CommentInterface.propb](index.md#propb) + +#### Extended by + +- [`CommentInterfaceExtended`](index.md#commentinterfaceextended) + +#### Type Parameters + +##### T + +\- + +#### Properties + +##### prop + +> **prop**: `string` + +##### propb + +> **propb**: `T` + +*** + +### CommentInterfaceExtended + +Comments form module comments + +Links using `{@link}` inline tags. + +- [CommentInterface](index.md#commentinterfacet) - Links to CommentInterface +- [Links to CommentInterface.prop](index.md#prop) +- [Links to CommentInterface.propb](index.md#propb) + +#### Extends + +- [`CommentInterface`](index.md#commentinterfacet)\<[`CommentEnum`](index.md#commentenum)\> + +#### Properties + +##### prop + +> **prop**: `string` + +###### Inherited from + +[`CommentInterface`](index.md#commentinterfacet).[`prop`](index.md#prop) + +##### propb + +> **propb**: [`CommentEnum`](index.md#commentenum) + +###### Inherited from + +[`CommentInterface`](index.md#commentinterfacet).[`propb`](index.md#propb) + +##### propc + +> **propc**: `string` diff --git a/packages/docusaurus-plugin-typedoc/test/out/links/typedoc-sidebar.cjs b/packages/docusaurus-plugin-typedoc/test/out/links/typedoc-sidebar.cjs new file mode 100644 index 000000000..908ac0d74 --- /dev/null +++ b/packages/docusaurus-plugin-typedoc/test/out/links/typedoc-sidebar.cjs @@ -0,0 +1,4 @@ +// @ts-check +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const typedocSidebar = { items: []}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/packages/docusaurus-plugin-typedoc/test/specs/__snapshots__/docusaurus.spec.ts.snap b/packages/docusaurus-plugin-typedoc/test/specs/__snapshots__/docusaurus.spec.ts.snap index f5ceef5d9..16167ce7f 100644 --- a/packages/docusaurus-plugin-typedoc/test/specs/__snapshots__/docusaurus.spec.ts.snap +++ b/packages/docusaurus-plugin-typedoc/test/specs/__snapshots__/docusaurus.spec.ts.snap @@ -68,7 +68,9 @@ Links using \`{@link}\` inline tags. #### Type Parameters -• **T** +##### T + +\\- #### Properties diff --git a/packages/typedoc-github-wiki-theme/test/specs/__snapshots__/github-wiki.spec.ts.snap b/packages/typedoc-github-wiki-theme/test/specs/__snapshots__/github-wiki.spec.ts.snap index a8e27e1bc..65f21379c 100644 --- a/packages/typedoc-github-wiki-theme/test/specs/__snapshots__/github-wiki.spec.ts.snap +++ b/packages/typedoc-github-wiki-theme/test/specs/__snapshots__/github-wiki.spec.ts.snap @@ -65,7 +65,7 @@ exports[`GithubWiki should output member docs 1`] = ` ## Constructors -### Constructor +### new ClassA() > **new ClassA**(): [\`ClassA\`](../wiki/module-1.Class.ClassA) diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/default/_sidebar.md b/packages/typedoc-gitlab-wiki-theme/test/out/default/_sidebar.md new file mode 100644 index 000000000..a7c20948f --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/default/_sidebar.md @@ -0,0 +1,4 @@ +## API + +- [module-1](module-1/home) +- [module-2](module-2/home) diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/default/home.md b/packages/typedoc-gitlab-wiki-theme/test/out/default/home.md new file mode 100644 index 000000000..700910f9e --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/default/home.md @@ -0,0 +1,6 @@ +# typedoc-gitlab-wiki-theme + +## Modules + +- [module-1](./module-1/home) +- [module-2](./module-2/home) diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/classes/ClassA.md b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/classes/ClassA.md new file mode 100644 index 000000000..8ed7bf1eb --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/classes/ClassA.md @@ -0,0 +1,13 @@ +[typedoc-gitlab-wiki-theme](../../home) / [module-1](../home) / ClassA + +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](./ClassA) + +#### Returns + +[`ClassA`](./ClassA) diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/classes/ClassB.md b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/classes/ClassB.md new file mode 100644 index 000000000..a566cbf88 --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/classes/ClassB.md @@ -0,0 +1,13 @@ +[typedoc-gitlab-wiki-theme](../../home) / [module-1](../home) / ClassB + +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](./ClassB) + +#### Returns + +[`ClassB`](./ClassB) diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/home.md b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/home.md new file mode 100644 index 000000000..5969e31d8 --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/home.md @@ -0,0 +1,19 @@ +[typedoc-gitlab-wiki-theme](../home) / module-1 + +# module-1 + +## Index + +### Namespaces + +- [Validation](./namespaces/Validation/home) + +### Classes + +- [ClassA](./classes/ClassA) +- [ClassB](./classes/ClassB) + +### Interfaces + +- [InterfaceA](./interfaces/InterfaceA) +- [InterfaceB](./interfaces/InterfaceB) diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/interfaces/InterfaceA.md b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/interfaces/InterfaceA.md new file mode 100644 index 000000000..0acd03def --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/interfaces/InterfaceA.md @@ -0,0 +1,3 @@ +[typedoc-gitlab-wiki-theme](../../home) / [module-1](../home) / InterfaceA + +# Interface: InterfaceA diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/interfaces/InterfaceB.md b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/interfaces/InterfaceB.md new file mode 100644 index 000000000..71115b7da --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/interfaces/InterfaceB.md @@ -0,0 +1,3 @@ +[typedoc-gitlab-wiki-theme](../../home) / [module-1](../home) / InterfaceB + +# Interface: InterfaceB diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/namespaces/Validation/home.md b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/namespaces/Validation/home.md new file mode 100644 index 000000000..3e72394ef --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/namespaces/Validation/home.md @@ -0,0 +1,9 @@ +[typedoc-gitlab-wiki-theme](../../../home) / [module-1](../../home) / Validation + +# Validation + +## Index + +### Interfaces + +- [NamespaceInterface](./interfaces/NamespaceInterface) diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/namespaces/Validation/interfaces/NamespaceInterface.md b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/namespaces/Validation/interfaces/NamespaceInterface.md new file mode 100644 index 000000000..1936f4968 --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-1/namespaces/Validation/interfaces/NamespaceInterface.md @@ -0,0 +1,9 @@ +[typedoc-gitlab-wiki-theme](../../../../home) / [module-1](../../../home) / [Validation](../home) / NamespaceInterface + +# Interface: NamespaceInterface + +## Properties + +### item + +> **item**: `string` diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/classes/ClassA.md b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/classes/ClassA.md new file mode 100644 index 000000000..5d8458cb8 --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/classes/ClassA.md @@ -0,0 +1,13 @@ +[typedoc-gitlab-wiki-theme](../../home) / [module-2](../home) / ClassA + +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](./ClassA) + +#### Returns + +[`ClassA`](./ClassA) diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/classes/ClassB.md b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/classes/ClassB.md new file mode 100644 index 000000000..c75bbf0ef --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/classes/ClassB.md @@ -0,0 +1,13 @@ +[typedoc-gitlab-wiki-theme](../../home) / [module-2](../home) / ClassB + +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](./ClassB) + +#### Returns + +[`ClassB`](./ClassB) diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/home.md b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/home.md new file mode 100644 index 000000000..304302a3b --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/home.md @@ -0,0 +1,15 @@ +[typedoc-gitlab-wiki-theme](../home) / module-2 + +# module-2 + +## Index + +### Classes + +- [ClassA](./classes/ClassA) +- [ClassB](./classes/ClassB) + +### Interfaces + +- [InterfaceA](./interfaces/InterfaceA) +- [InterfaceB](./interfaces/InterfaceB) diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/interfaces/InterfaceA.md b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/interfaces/InterfaceA.md new file mode 100644 index 000000000..49c1da66c --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/interfaces/InterfaceA.md @@ -0,0 +1,3 @@ +[typedoc-gitlab-wiki-theme](../../home) / [module-2](../home) / InterfaceA + +# Interface: InterfaceA diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/interfaces/InterfaceB.md b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/interfaces/InterfaceB.md new file mode 100644 index 000000000..b19e08cc3 --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/default/module-2/interfaces/InterfaceB.md @@ -0,0 +1,3 @@ +[typedoc-gitlab-wiki-theme](../../home) / [module-2](../home) / InterfaceB + +# Interface: InterfaceB diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/globals/_sidebar.md b/packages/typedoc-gitlab-wiki-theme/test/out/globals/_sidebar.md new file mode 100644 index 000000000..2ca4f3163 --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/globals/_sidebar.md @@ -0,0 +1,11 @@ +## API + +### Classes + +- [ClassA](classes/ClassA) +- [ClassB](classes/ClassB) + +### Interfaces + +- [InterfaceA](interfaces/InterfaceA) +- [InterfaceB](interfaces/InterfaceB) diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/globals/classes/ClassA.md b/packages/typedoc-gitlab-wiki-theme/test/out/globals/classes/ClassA.md new file mode 100644 index 000000000..bfe3aa6c0 --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/globals/classes/ClassA.md @@ -0,0 +1,13 @@ +[typedoc-gitlab-wiki-theme](../home) / ClassA + +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](./ClassA) + +#### Returns + +[`ClassA`](./ClassA) diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/globals/classes/ClassB.md b/packages/typedoc-gitlab-wiki-theme/test/out/globals/classes/ClassB.md new file mode 100644 index 000000000..6a4aa7f44 --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/globals/classes/ClassB.md @@ -0,0 +1,13 @@ +[typedoc-gitlab-wiki-theme](../home) / ClassB + +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](./ClassB) + +#### Returns + +[`ClassB`](./ClassB) diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/globals/home.md b/packages/typedoc-gitlab-wiki-theme/test/out/globals/home.md new file mode 100644 index 000000000..518237a40 --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/globals/home.md @@ -0,0 +1,11 @@ +# typedoc-gitlab-wiki-theme + +## Classes + +- [ClassA](./classes/ClassA) +- [ClassB](./classes/ClassB) + +## Interfaces + +- [InterfaceA](./interfaces/InterfaceA) +- [InterfaceB](./interfaces/InterfaceB) diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/globals/interfaces/InterfaceA.md b/packages/typedoc-gitlab-wiki-theme/test/out/globals/interfaces/InterfaceA.md new file mode 100644 index 000000000..ecbe834af --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/globals/interfaces/InterfaceA.md @@ -0,0 +1,3 @@ +[typedoc-gitlab-wiki-theme](../home) / InterfaceA + +# Interface: InterfaceA diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/globals/interfaces/InterfaceB.md b/packages/typedoc-gitlab-wiki-theme/test/out/globals/interfaces/InterfaceB.md new file mode 100644 index 000000000..b02882d03 --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/globals/interfaces/InterfaceB.md @@ -0,0 +1,3 @@ +[typedoc-gitlab-wiki-theme](../home) / InterfaceB + +# Interface: InterfaceB diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/single-modules/_sidebar.md b/packages/typedoc-gitlab-wiki-theme/test/out/single-modules/_sidebar.md new file mode 100644 index 000000000..7e797b74d --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/single-modules/_sidebar.md @@ -0,0 +1,4 @@ +## API + +- [module-1](module-1/home) +- [module-2](module-2) diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/single-modules/home.md b/packages/typedoc-gitlab-wiki-theme/test/out/single-modules/home.md new file mode 100644 index 000000000..38bb56d39 --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/single-modules/home.md @@ -0,0 +1,6 @@ +# typedoc-gitlab-wiki-theme + +## Modules + +- [module-1](./module-1/home) +- [module-2](./module-2) diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/single-modules/module-1/home.md b/packages/typedoc-gitlab-wiki-theme/test/out/single-modules/module-1/home.md new file mode 100644 index 000000000..a92e2a2c8 --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/single-modules/module-1/home.md @@ -0,0 +1,45 @@ +[typedoc-gitlab-wiki-theme](../home) / module-1 + +# module-1 + +## Index + +### Namespaces + +- [Validation](./namespaces/Validation) + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](./home#classa) + +###### Returns + +[`ClassA`](./home#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](./home#classb) + +###### Returns + +[`ClassB`](./home#classb) + +## Interfaces + +### InterfaceA + +*** + +### InterfaceB diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/single-modules/module-1/namespaces/Validation.md b/packages/typedoc-gitlab-wiki-theme/test/out/single-modules/module-1/namespaces/Validation.md new file mode 100644 index 000000000..f23a2d48d --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/single-modules/module-1/namespaces/Validation.md @@ -0,0 +1,13 @@ +[typedoc-gitlab-wiki-theme](../../home) / [module-1](../home) / Validation + +# Validation + +## Interfaces + +### NamespaceInterface + +#### Properties + +##### item + +> **item**: `string` diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/single-modules/module-2.md b/packages/typedoc-gitlab-wiki-theme/test/out/single-modules/module-2.md new file mode 100644 index 000000000..fe22b071f --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/single-modules/module-2.md @@ -0,0 +1,39 @@ +[typedoc-gitlab-wiki-theme](./home) / module-2 + +# module-2 + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](./module-2#classa) + +###### Returns + +[`ClassA`](./module-2#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](./module-2#classb) + +###### Returns + +[`ClassB`](./module-2#classb) + +## Interfaces + +### InterfaceA + +*** + +### InterfaceB diff --git a/packages/typedoc-gitlab-wiki-theme/test/out/single-page/home.md b/packages/typedoc-gitlab-wiki-theme/test/out/single-page/home.md new file mode 100644 index 000000000..f44f61de0 --- /dev/null +++ b/packages/typedoc-gitlab-wiki-theme/test/out/single-page/home.md @@ -0,0 +1,37 @@ +# typedoc-gitlab-wiki-theme + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](./home#classa) + +###### Returns + +[`ClassA`](./home#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](./home#classb) + +###### Returns + +[`ClassB`](./home#classb) + +## Interfaces + +### InterfaceA + +*** + +### InterfaceB diff --git a/packages/typedoc-gitlab-wiki-theme/test/specs/__snapshots__/gitlab-wiki.spec.ts.snap b/packages/typedoc-gitlab-wiki-theme/test/specs/__snapshots__/gitlab-wiki.spec.ts.snap index 9f6a0ffff..cd5829b11 100644 --- a/packages/typedoc-gitlab-wiki-theme/test/specs/__snapshots__/gitlab-wiki.spec.ts.snap +++ b/packages/typedoc-gitlab-wiki-theme/test/specs/__snapshots__/gitlab-wiki.spec.ts.snap @@ -46,7 +46,7 @@ exports[`GithubWiki should output member docs 1`] = ` ## Constructors -### Constructor +### new ClassA() > **new ClassA**(): [\`ClassA\`](./ClassA) diff --git a/packages/typedoc-plugin-frontmatter/test/out/no-data/README.md b/packages/typedoc-plugin-frontmatter/test/out/no-data/README.md new file mode 100644 index 000000000..250a56f37 --- /dev/null +++ b/packages/typedoc-plugin-frontmatter/test/out/no-data/README.md @@ -0,0 +1 @@ +# The Readme diff --git a/packages/typedoc-plugin-frontmatter/test/out/no-data/globals.md b/packages/typedoc-plugin-frontmatter/test/out/no-data/globals.md new file mode 100644 index 000000000..ffb6f71ec --- /dev/null +++ b/packages/typedoc-plugin-frontmatter/test/out/no-data/globals.md @@ -0,0 +1,5 @@ +# typedoc-plugin-frontmatter + +## Interfaces + +- [SomeInterface](interfaces/SomeInterface.md) diff --git a/packages/typedoc-plugin-frontmatter/test/out/no-data/interfaces/SomeInterface.md b/packages/typedoc-plugin-frontmatter/test/out/no-data/interfaces/SomeInterface.md new file mode 100644 index 000000000..4a69d09e4 --- /dev/null +++ b/packages/typedoc-plugin-frontmatter/test/out/no-data/interfaces/SomeInterface.md @@ -0,0 +1,9 @@ +# Interface: SomeInterface + +## Tag One + +0 + +## Tag Two + +'Frontmatter' tag diff --git a/packages/typedoc-plugin-frontmatter/test/out/options-2/README.md b/packages/typedoc-plugin-frontmatter/test/out/options-2/README.md new file mode 100644 index 000000000..c8271f60e --- /dev/null +++ b/packages/typedoc-plugin-frontmatter/test/out/options-2/README.md @@ -0,0 +1,9 @@ +--- +title: typedoc-plugin-frontmatter +layout: blog +navOrder: 1 +hide: true +onReadme: true +--- + +# The Readme diff --git a/packages/typedoc-plugin-frontmatter/test/out/options-2/globals.md b/packages/typedoc-plugin-frontmatter/test/out/options-2/globals.md new file mode 100644 index 000000000..ed418dd81 --- /dev/null +++ b/packages/typedoc-plugin-frontmatter/test/out/options-2/globals.md @@ -0,0 +1,13 @@ +--- +title: typedoc-plugin-frontmatter +layout: blog +navOrder: 1 +hide: true +onIndex: true +--- + +# typedoc-plugin-frontmatter + +## Interfaces + +- [SomeInterface](interfaces/SomeInterface.md) diff --git a/packages/typedoc-plugin-frontmatter/test/out/options-2/interfaces/SomeInterface.md b/packages/typedoc-plugin-frontmatter/test/out/options-2/interfaces/SomeInterface.md new file mode 100644 index 000000000..a477b483b --- /dev/null +++ b/packages/typedoc-plugin-frontmatter/test/out/options-2/interfaces/SomeInterface.md @@ -0,0 +1,18 @@ +--- +title: SomeInterface +layout: blog +navOrder: 1 +hide: true +tagOne: 0 +tagTwo: "'Frontmatter' tag" +--- + +# Interface: SomeInterface + +## Tag One + +0 + +## Tag Two + +'Frontmatter' tag diff --git a/packages/typedoc-plugin-frontmatter/test/out/options/README.md b/packages/typedoc-plugin-frontmatter/test/out/options/README.md new file mode 100644 index 000000000..ecb08b966 --- /dev/null +++ b/packages/typedoc-plugin-frontmatter/test/out/options/README.md @@ -0,0 +1,8 @@ +--- +title: typedoc-plugin-frontmatter +layout: blog +navOrder: 1 +hide: true +--- + +# The Readme diff --git a/packages/typedoc-plugin-frontmatter/test/out/options/globals.md b/packages/typedoc-plugin-frontmatter/test/out/options/globals.md new file mode 100644 index 000000000..50f142ae3 --- /dev/null +++ b/packages/typedoc-plugin-frontmatter/test/out/options/globals.md @@ -0,0 +1,12 @@ +--- +title: typedoc-plugin-frontmatter +layout: blog +navOrder: 1 +hide: true +--- + +# typedoc-plugin-frontmatter + +## Interfaces + +- [SomeInterface](interfaces/SomeInterface.md) diff --git a/packages/typedoc-plugin-frontmatter/test/out/options/interfaces/SomeInterface.md b/packages/typedoc-plugin-frontmatter/test/out/options/interfaces/SomeInterface.md new file mode 100644 index 000000000..16b20b164 --- /dev/null +++ b/packages/typedoc-plugin-frontmatter/test/out/options/interfaces/SomeInterface.md @@ -0,0 +1,10 @@ +--- +title: SomeInterface +layout: blog +navOrder: 1 +hide: true +tagOne: 0 +tagTwo: "'Frontmatter' tag" +--- + +# Interface: SomeInterface diff --git a/packages/typedoc-plugin-markdown/.gitignore b/packages/typedoc-plugin-markdown/.gitignore index 42ca75dd6..1a34a1056 100644 --- a/packages/typedoc-plugin-markdown/.gitignore +++ b/packages/typedoc-plugin-markdown/.gitignore @@ -1 +1,2 @@ -playground/docs \ No newline at end of file +playground/docs +!out \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/.scripts/schema/generate-schema.ts b/packages/typedoc-plugin-markdown/.scripts/schema/generate-schema.ts index 270f2cb67..683474aaa 100644 --- a/packages/typedoc-plugin-markdown/.scripts/schema/generate-schema.ts +++ b/packages/typedoc-plugin-markdown/.scripts/schema/generate-schema.ts @@ -1,7 +1,12 @@ import * as fs from 'fs'; import * as path from 'path'; +import { dirname } from 'path'; +import { fileURLToPath } from 'url'; import { declarations } from '../../src/options'; +export const __filename = fileURLToPath(import.meta.url); +export const __dirname = dirname(__filename); + main(); async function main() { diff --git a/packages/typedoc-plugin-markdown/CHANGELOG.md b/packages/typedoc-plugin-markdown/CHANGELOG.md index 9c192e0c8..e086dae8f 100644 --- a/packages/typedoc-plugin-markdown/CHANGELOG.md +++ b/packages/typedoc-plugin-markdown/CHANGELOG.md @@ -1,5 +1,28 @@ # Changelog +## 4.3 Pre-release (2024-11-26) + +This release introduces support for TypeDoc 0.27 and some additional UX features and improvements in addition to some bug fixes. + +### TypeDoc 0.27 Support + +Please see for full [changelog](https://typedoc.org/documents/CHANGELOG.html#v0270-2024-11-27). Note many items only relate to the HTML theme output. + +There are two TypeDoc breaking changes that might effect users of this plugin: + +- TypeDoc has converted to ESM and therefore all public and local CommonJs plugins will need to be refactored to ESM. +- TypeScript <5.0 is no longer supported. + +It is now possible to output HTML and Markdown in the same process. + +### UX Changes + +- There are UX changes to parameters list views to separate params with markdown headings to improve readability and discoverability. +- Improved structure of curried and overloaded signatures. +- Page headings have been simplified to simply display project title as per default theme. + +### Features + ## 4.2.10 (2024-11-01) ### Patch Changes diff --git a/packages/typedoc-plugin-markdown/barrelsby.config.json b/packages/typedoc-plugin-markdown/barrelsby.config.json deleted file mode 100644 index b68b61472..000000000 --- a/packages/typedoc-plugin-markdown/barrelsby.config.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "delete": true, - "directory": [ - "./src/libs/markdown", - "./src/libs/utils", - "./src/theme/context/templates", - "./src/theme/context/partials", - "./src/theme/context/helpers" - ], - "exclude": ".*\\.spec\\.ts|^index\\.ts$", - "location": "top", - "name": "_index.ts", - "singleQuotes": true, - "noHeader": true -} diff --git a/packages/typedoc-plugin-markdown/package.json b/packages/typedoc-plugin-markdown/package.json index 25d381c5f..6d5e6025a 100644 --- a/packages/typedoc-plugin-markdown/package.json +++ b/packages/typedoc-plugin-markdown/package.json @@ -14,13 +14,13 @@ "prepublishOnly": "npm run lint && npm run build", "prebuild": "rm -rf dist && prebuild-options && tsx ./.scripts/prebuild", "build": "tsc && tsc-alias", - "build-and-run": "npm run build && npm run pretest", - "pretest": "fixtures -c ./test/fixtures/config.ts", - "validate": "tsx test/scripts/lint.md.mjs && tsx test/scripts/lint.mdx.mjs", + "build-and-run": "npm run build && npm run fixtures", + "fixtures": "node test/__scripts__/build-fixtures.mjs -c test/fixtures/config.mjs", + "validate": "node test/__scripts__/lint/lint.md.mjs && tsx test/__scripts__/lint/lint.mdx.mjs", "test": "npm run validate && jest", - "test:update": "npm run build && npm run test -- -u", + "test:update": "npm run build && npm run fixtures && npm run test -- -u", "playground": "npm run build && typedoc --options ./playground/typedoc.json", - "schema": "ts-node ./.scripts/schema/generate-schema.ts", + "schema": "tsx ./.scripts/schema/generate-schema.ts", "docs": "npm run build && typedoc --options ./typedoc.public.json" }, "author": "Thomas Grey", @@ -34,7 +34,9 @@ "directory": "packages/typedoc-plugin-markdown" }, "homepage": "https://typedoc-plugin-markdown.org", - "peerDependencies": {}, + "peerDependencies": { + "typedoc": "0.27.x" + }, "engines": { "node": ">= 18" }, diff --git a/packages/typedoc-plugin-markdown/src/_typedoc.d.ts b/packages/typedoc-plugin-markdown/src/_typedoc.d.ts index 1f86fdf79..547aeeed1 100644 --- a/packages/typedoc-plugin-markdown/src/_typedoc.d.ts +++ b/packages/typedoc-plugin-markdown/src/_typedoc.d.ts @@ -37,6 +37,15 @@ declare module 'typedoc' { excludeFolders: boolean; }; outputFileStrategy: 'members' | 'modules'; + pageTitleTemplates: { + index: + | string + | ((name: { projectName: string; version: string }) => string); + member: + | string + | ((name: { name: string; kind: string; group: string }) => string); + module: string | ((name: { name: string; kind: string }) => string); + }; parametersFormat: 'list' | 'table' | 'htmlTable'; preserveAnchorCasing: boolean; prettierConfigFile: string; @@ -61,7 +70,7 @@ declare module 'typedoc' { 'title.modulePage': string; }>; typeDeclarationFormat: 'list' | 'table' | 'htmlTable'; - typeDeclarationVisibility: 'compact' | 'expanded'; + typeDeclarationVisibility: 'compact' | 'verbose'; useCodeBlocks: boolean; useHTMLAnchors: boolean; useHTMLEncodedBrackets: boolean; @@ -72,7 +81,6 @@ declare module 'typedoc' { theme_default_value: []; theme_default_type: []; theme_description: []; - theme_documentation: []; theme_event: []; theme_re_exports: []; theme_renames_and_re_exports: []; diff --git a/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts b/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts index ca4e2d63b..cb98504db 100644 --- a/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts +++ b/packages/typedoc-plugin-markdown/src/events/markdown-page-event.ts @@ -20,7 +20,7 @@ export class MarkdownPageEvent< readonly model: Model; /** - * The group that the reflection belongs too + * The group title of the group reflection belongs to. */ group?: string; diff --git a/packages/typedoc-plugin-markdown/src/index.ts b/packages/typedoc-plugin-markdown/src/index.ts index fb8b16ea4..81e36b85c 100644 --- a/packages/typedoc-plugin-markdown/src/index.ts +++ b/packages/typedoc-plugin-markdown/src/index.ts @@ -63,18 +63,13 @@ export function load(app: Application) { app.outputs.setDefaultOutputName('markdown'); - /** - * ============================= - * 2. Configure Hooks - * ============================= - */ Object.defineProperty(app.renderer, 'markdownHooks', { value: new EventHooks(), }); /** * ========================= - * 4. Configure localization + * 3. Configure localization * ========================= */ diff --git a/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts b/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts index 4a572f359..a61b37d43 100644 --- a/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts +++ b/packages/typedoc-plugin-markdown/src/internationalization/locales/en.ts @@ -8,7 +8,6 @@ export const translatable: TranslatableStrings = { theme_default_value: 'Default value', theme_default_type: 'Default type', theme_description: 'Description', - theme_documentation: 'Documentation', theme_event: 'Event', theme_re_exports: 'Re-exports', theme_renames_and_re_exports: 'Renames and re-exports', diff --git a/packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts b/packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts index d90a6d2e7..15d45245b 100644 --- a/packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts +++ b/packages/typedoc-plugin-markdown/src/internationalization/locales/jp.ts @@ -9,7 +9,6 @@ export const translatable: Partial = { theme_default_value: 'デフォルト値', theme_default_type: 'デフォルトタイプ', theme_description: '説明', - theme_documentation: 'ドキュメント', theme_event: 'イベント', theme_re_exports: '再エクスポート', theme_renames_and_re_exports: 'リネームと再エクスポート', diff --git a/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts b/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts index 22f2d68a7..d572d1224 100644 --- a/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts +++ b/packages/typedoc-plugin-markdown/src/internationalization/locales/ko.ts @@ -8,7 +8,6 @@ export const translatable: Partial = { theme_default_value: '기본 값', theme_default_type: '기본 유형', theme_description: '설명', - theme_documentation: '문서', theme_event: '이벤트', theme_re_exports: '다시 내보내진 원본:', theme_renames_and_re_exports: '새 이름으로 내보내진 원본:', diff --git a/packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts b/packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts index ebb2269bd..5d3d29dd4 100644 --- a/packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts +++ b/packages/typedoc-plugin-markdown/src/internationalization/locales/zh.ts @@ -8,7 +8,6 @@ export const translatable: Partial = { theme_default_value: '默认值', theme_default_type: '默认类型', theme_description: '描述', - theme_documentation: '文档', theme_event: '事件', theme_re_exports: '重新导出', theme_renames_and_re_exports: '重命名并重新导出', diff --git a/packages/typedoc-plugin-markdown/src/options/constants.ts b/packages/typedoc-plugin-markdown/src/options/constants.ts index 6e6e836c2..3bcabaa6a 100644 --- a/packages/typedoc-plugin-markdown/src/options/constants.ts +++ b/packages/typedoc-plugin-markdown/src/options/constants.ts @@ -28,3 +28,9 @@ export const TEXT_CONTENT_MAPPINGS = { 'title.memberPage': '{kind}: {name}', 'title.modulePage': '{name}', }; + +export const DEFAULT_PAGE_TITLES = { + index: '{projectName} {version}', + member: '{kind}: {name}', + module: '{name}', +}; diff --git a/packages/typedoc-plugin-markdown/src/options/declarations.ts b/packages/typedoc-plugin-markdown/src/options/declarations.ts index d4e805369..35a19f785 100644 --- a/packages/typedoc-plugin-markdown/src/options/declarations.ts +++ b/packages/typedoc-plugin-markdown/src/options/declarations.ts @@ -22,6 +22,7 @@ import { DeclarationOption, ParameterType } from 'typedoc'; import { ALLOWED_OWN_FILE_MEMBERS, + DEFAULT_PAGE_TITLES, TEXT_CONTENT_MAPPINGS, } from './constants.js'; import { @@ -204,6 +205,21 @@ export const modulesFileName: Partial = { type: ParameterType.String, }; +/** + * By default when a readme file is resolved, a separate readme page is created. + * + * This option appends the documentation main/index page to the readme page so only a single root page is generated. + * + * This option has no effect when [`--readme`](https://typedoc.org/options/input/#readme) is set to `"none"`. + * + * @category File + */ +export const mergeReadme: Partial = { + help: 'Appends the documentation index page to the readme page.', + type: ParameterType.Boolean, + defaultValue: false, +}; + /** * This option can be used when the root page of the documentation should be a specific module (typically a module named `index`). * @@ -252,20 +268,6 @@ export const excludeScopesInPaths: Partial = { defaultValue: false, }; -/** - * By default when a readme file is resolved, a separate readme page is created. - * This option appends the index page to the readme so only a single root page is generated. - * - * This option has no effect when [`--readme`](https://typedoc.org/options/input/#readme) is set to `"none"`. - * - * @category File - */ -export const mergeReadme: Partial = { - help: 'Merges the resolved readme into the project index page.', - type: ParameterType.Boolean, - defaultValue: false, -}; - /** * @category Display */ @@ -466,6 +468,24 @@ export const enumMembersFormat: Partial = { defaultValue: DisplayFormat.List, }; +/** + * This option will handle the formatting of object literals assigned as properties in classes or interfaces. + * + * Note this options will only take effect when the property declaration is rendered in a `list` format. + * + * - **"list"**: members are output in linear blocks with headings, suitable for more detailed comments. + * - **"table"**: members are output within a Markdown table, condensed into a single paragraph. + * - **"htmlTable"**: members are output in an HTML table, enabling block elements to render in tabular format. + * + * @category Display + */ +export const propertyMembersFormat: Partial = { + help: 'Sets the format of style for property members for interfaces and classes.', + type: ParameterType.Map, + map: DisplayFormat, + defaultValue: DisplayFormat.List, +}; + /** * This option specifies the output format for type declaration of variables and type aliases. * @@ -483,10 +503,10 @@ export const typeDeclarationFormat: Partial = { }; /** - * Configures the visibility level for type declaration documentation. + * Configures the visibility level for type declaration documentation. Applies to both list and table formats. * - * - **"expanded"**: Displays all available documentation as text, including nested type declarations. - * - **"compact"**: Omits separate documentation blocks for nested type declarations. + * - **"verbose"**: Provides full documentation details for all type declarations, including nested types. + * - **"compact"**: Summarizes nested types as JSON, reducing verbosity while retaining key information. * * @category Display */ @@ -494,25 +514,7 @@ export const typeDeclarationVisibility: Partial = { help: 'Set the visibility level for type declaration documentation.', type: ParameterType.Map, map: TypeDeclarationVisibility, - defaultValue: TypeDeclarationVisibility.Expanded, -}; - -/** - * This option will handle the formatting of object literals assigned as properties in classes or interfaces. - * - * Note this options will only take effect when the property declaration is rendered in a `list` format. - * - * - **"list"**: members are output in linear blocks with headings, suitable for more detailed comments. - * - **"table"**: members are output within a Markdown table, condensed into a single paragraph. - * - **"htmlTable"**: members are output in an HTML table, enabling block elements to render in tabular format. - * - * @category Display - */ -export const propertyMembersFormat: Partial = { - help: 'Sets the format of style for property members for interfaces and classes.', - type: ParameterType.Map, - map: DisplayFormat, - defaultValue: DisplayFormat.List, + defaultValue: TypeDeclarationVisibility.Verbose, }; /** @@ -552,7 +554,7 @@ export const tableColumnSettings: Partial = { }; /** - * `typedoc-plugin-markdown` plugin generates well-formatted code, however, integrating the popular formatting package [Prettier](https://prettier.io/) can provide additional enhancements, such as: + * This plugin generates well-formatted Markdown, however, integrating the popular formatting package [Prettier](https://prettier.io/) can provide additional enhancements, such as: * * - Formats code inside fenced blocks using the respective Prettier configuration for that language. * - Aligns markdown table cells. @@ -561,7 +563,7 @@ export const tableColumnSettings: Partial = { * * Please note that Prettier is not a dependency of this plugin and must be installed in your project for this option to work. * - * If Prettier is not already installed please `npm i prettier --save-dev` to use this option. + * `npm i prettier --save-dev` to use this option. * * @category Utility */ @@ -576,7 +578,7 @@ export const formatWithPrettier: Partial = { * * Use this option to specify a separate Prettier configuration file in a custom location. * - * Please note this option is only applicable when `formatWithPrettier` is set to `true`. + * Please note this option is only applicable when `formatWithPrettier` is set to `"true"`. * * @example "./path/to/.prettierrc.json" * @@ -674,38 +676,70 @@ export const preserveAnchorCasing: Partial = { }; /** - * Defines placeholder text that can be customized. Includes the main page header, breadcrumbs (if displayed) and main page titles. - * - * Values can be strings that accept placeholders inside curly brace `{}`, or functions that provide placeholders as arguments. + * @hidden * - * Default values within curly braces {} indicates a placeholder of dynamic text. + * @deprecated This option has been deprecated in favour of `--pageTitleTemplates`. * - * - The `{projectName}` placeholder writes project's name. - * - The `{version}` placeholder writes package version (if includeVersion is `true`). - * - The `{kind}` placeholder writes the reflection kind of the page. - * - The `{name}` placeholder writes the reflection name. - * - The `{group}` place holder writes the group title - * - The `{category}` placeholder writes the group title + * @category Utility + */ +export const textContentMappings: Partial = { + help: 'Change specific text placeholders in the template.', + type: ParameterType.Object, + defaultValue: TEXT_CONTENT_MAPPINGS, + configFileOnly: true, + validate(value) { + if (!value || typeof value !== 'object') { + throw new Error( + '[typedoc-plugin-markdown] textContentMappings must be an object.', + ); + } + for (const val of Object.values(value)) { + if (typeof val !== 'string') { + throw new Error( + `[typedoc-plugin-markdown] All values of textContentMappings must be strings.`, + ); + } + } + }, +}; +/** + * Customizes the page titles for index, module, and member pages in the documentation. + * + * The option is provided as an object with keys corresponding to the page type. + * + * The Values of each key can be either: + * + * - A function accepting input arguments. + * - A strings supporting placeholders. * - * **Available keys** + * Available placeholders / arguments: * - * | Key | Available Placeholders/Args | Description | - * |-----------------------|----------------------------|----------------------------------------------------------------------------| - * | `header.title` | `projectName`, `version` | Writes the project's name. | - * | `breadcrumbs.home` | `projectName`, `version` | Writes the reflection kind of the page. | - * | `title.indexPage` | `projectName`, `version` | Writes the package version (if `includeVersion` is `true`). | - * | `title.modulePage` | `kind`, `name` | Writes the package version (if `includeVersion` is `true`). | - * | `title.memberPage` | `kind`, `name`, `group`, `category` | Writes the group and name of the member page dynamically. | + * - `{projectName}` - the project's name resolved by TypeDoc. + * - `{version}` - the project version resolved by TypeDoc (when includeVersion is `true`). + * - `{kind}` - the reflection kind of the item. + * - `{group}` - the group title that the item belongs to. * - * If you are looking for general localization support please see TypeDoc's [`--lang`](https://typedoc.org/options/output/#lang) and [`--locales`](https://typedoc.org/options/output/#locales) options. + * Available keys: + * + * - The `index` key (main documentation index page) accepts the `projectName` and `version` placeholder/args. + * - The `module` key (module and namespace pages) accepts the `kind` and `name` placeholder/args. + * - The `member` key (individual module member pages) accepts the `kind`, `name`, and `group` placeholder/args. + * + * ```js filename="typedoc.cjs" + * pageTitleTemplates: { + * index: (args) => `${args.projectName}: ${args.version}`, + * module: (args) => args.name, + * member: (args) => `${args.kind}: ${args.name}`, + * } + * ``` * * @category Utility */ -export const textContentMappings: Partial = { +export const pageTitleTemplates: Partial = { help: 'Change specific text placeholders in the template.', type: ParameterType.Object, - defaultValue: TEXT_CONTENT_MAPPINGS, + defaultValue: DEFAULT_PAGE_TITLES, configFileOnly: true, validate(value) { if (!value || typeof value !== 'object') { diff --git a/packages/typedoc-plugin-markdown/src/options/maps.ts b/packages/typedoc-plugin-markdown/src/options/maps.ts index 713db1210..8227e2502 100644 --- a/packages/typedoc-plugin-markdown/src/options/maps.ts +++ b/packages/typedoc-plugin-markdown/src/options/maps.ts @@ -26,5 +26,5 @@ export enum DisplayFormat { */ export enum TypeDeclarationVisibility { Compact = 'compact', - Expanded = 'expanded', + Verbose = 'verbose', } diff --git a/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-project-name.ts b/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-project-name.ts index e516f62c9..0401faabc 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-project-name.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-project-name.ts @@ -4,12 +4,15 @@ import { Reflection } from 'typedoc'; export function getProjectName( stringWithPlaceholders: string, page: MarkdownPageEvent, + includeVersion = true, ) { return stringWithPlaceholders .replace('{projectName}', page.project.name) .replace( '{version}', - page.project.packageVersion ? `v${page.project.packageVersion}` : '', + includeVersion && page.project.packageVersion + ? `v${page.project.packageVersion}` + : '', ) .replace(/\s+/g, ' ') .trim(); diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts index 1639104e9..a907142ea 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.constructors.ts @@ -1,4 +1,5 @@ import { heading } from '@plugin/libs/markdown/index.js'; +import { escapeChars } from '@plugin/libs/utils/escape-chars.js'; import { MarkdownThemeContext } from '@plugin/theme/index.js'; import { DeclarationReflection } from 'typedoc'; @@ -10,7 +11,9 @@ export function constructor( const md: string[] = []; model.signatures?.forEach((signature) => { - md.push(heading(options.headingLevel, this.i18n.kind_constructor())); + md.push( + heading(options.headingLevel, `new ${escapeChars(signature.name)}()`), + ); md.push( this.partials.signature(signature, { headingLevel: options.headingLevel + 1, diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/page.breadcrumbs.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/page.breadcrumbs.ts index bf9883053..f99f3f77a 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/page.breadcrumbs.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/page.breadcrumbs.ts @@ -7,7 +7,6 @@ export function breadcrumbs(this: MarkdownThemeContext): string { const md: string[] = []; const textContentMappings = this.options.getValue('textContentMappings'); - const breadcrumbsHome = textContentMappings['breadcrumbs.home'] as any; const fileExtension = this.options.getValue('fileExtension'); const entryFileName = `${path.parse(this.options.getValue('entryFileName')).name}${fileExtension}`; @@ -19,16 +18,11 @@ export function breadcrumbs(this: MarkdownThemeContext): string { return ''; } - let homeLabel = ''; - - if (typeof breadcrumbsHome === 'string') { - homeLabel = this.helpers.getProjectName(breadcrumbsHome, this.page); - } else { - homeLabel = breadcrumbsHome({ - name: this.page?.project?.name, - version: this.page?.project?.packageVersion, - }); - } + const homeLabel = this.helpers.getProjectName( + textContentMappings['breadcrumbs.home'], + this.page, + false, + ); md.push( link( diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts index 323010154..0887e35fd 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/page.header.ts @@ -11,7 +11,6 @@ import { export function header(this: MarkdownThemeContext): string { const textContentMappings = this.options.getValue('textContentMappings'); - const headerTitle = textContentMappings['header.title'] as any; const getHeader = () => { const isPackages = @@ -33,22 +32,10 @@ export function header(this: MarkdownThemeContext): string { const md: string[] = []; - let title = ''; - - if (typeof headerTitle === 'string') { - title = this.helpers.getProjectName( - textContentMappings['header.title'], - this.page, - ); - } else { - title = headerTitle({ - name: this.page?.project?.name, - version: this.page?.project?.packageVersion, - }); - } - - const indexLabel = - textContentMappings['header.docs'] || this.i18n.theme_documentation(); + const title = this.helpers.getProjectName( + textContentMappings['header.title'], + this.page, + ); if (this.page.url === entryFileName) { md.push(bold(title)); @@ -56,39 +43,6 @@ export function header(this: MarkdownThemeContext): string { md.push(link(bold(title), this.getRelativeUrl(entryFileName))); } - const preserveReadme = - Boolean(this.page.project.readme) && - !this.options.getValue('mergeReadme'); - - const useEntryModule = - (this.page.project?.groups && - Boolean( - this.page.project?.groups[0]?.children.find( - (child) => child.name === this.options.getValue('entryModule'), - ), - )) || - false; - - if (preserveReadme) { - const readMeUrl = useEntryModule - ? `readme_${fileExtension}` - : entryFileName; - - const indexUrl = useEntryModule ? entryFileName : this.page.project.url; - - if (indexLabel.length) { - if (this.page.url === readMeUrl) { - md.push(link(bold(indexLabel), this.getRelativeUrl(indexUrl || ''))); - } else { - md.push(bold(indexLabel)); - } - } - } else { - if (indexLabel.length) { - md.push(bold(indexLabel)); - } - } - return `${md.join(' • ')}\n\n***\n`; }; @@ -103,9 +57,6 @@ export function header(this: MarkdownThemeContext): string { const md: string[] = []; - const indexLabel = - textContentMappings['header.docs'] || this.i18n.theme_documentation(); - const ignoreScopes = this.options.getValue('excludeScopesInPaths'); const fileExtension = this.options.getValue('fileExtension'); const entryFileName = `${path.parse(this.options.getValue('entryFileName')).name}${fileExtension}`; @@ -130,25 +81,6 @@ export function header(this: MarkdownThemeContext): string { ); } - const preservePackageReadme = - Boolean(packageItem.readme) && !this.options.getValue('mergeReadme'); - - if (preservePackageReadme) { - if (indexLabel.length) { - if (this.page.url === packageEntryFile) { - md.push( - link(bold(indexLabel), this.getRelativeUrl(packageItem.url || '')), - ); - } else { - md.push(bold(indexLabel)); - } - } - } else { - if (indexLabel.length) { - md.push(bold(indexLabel)); - } - } - return `${md.join(' • ')}\n\n***\n`; }; diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts index c5b6a0bfd..646333949 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/page.pageTitle.ts @@ -3,9 +3,17 @@ import { DeclarationReflection, ReflectionKind } from 'typedoc'; export function pageTitle(this: MarkdownThemeContext): string { const textContentMappings = this.options.getValue('textContentMappings'); - const indexPageTitle = textContentMappings['title.indexPage'] as any; - const modulePageTitle = textContentMappings['title.modulePage'] as any; - const memberPageTitle = textContentMappings['title.memberPage'] as any; + const pageTitleTemplates = this.options.getValue('pageTitleTemplates'); + const hasCustomPageTitle = this.options.isSet('pageTitleTemplates'); + const indexPageTitle: any = hasCustomPageTitle + ? pageTitleTemplates['index'] + : textContentMappings['title.indexPage']; + const modulePageTitle: any = hasCustomPageTitle + ? pageTitleTemplates['module'] + : textContentMappings['title.modulePage']; + const memberPageTitle: any = hasCustomPageTitle + ? pageTitleTemplates['member'] + : textContentMappings['title.memberPage']; const page = this.page; @@ -14,7 +22,7 @@ export function pageTitle(this: MarkdownThemeContext): string { return this.helpers.getProjectName(indexPageTitle, page); } return indexPageTitle({ - name: page?.project?.name, + projectName: page?.project?.name, version: page?.project?.packageVersion, }); } diff --git a/packages/typedoc-plugin-markdown/src/theme/context/resources.ts b/packages/typedoc-plugin-markdown/src/theme/context/resources.ts index 8dee6e736..38c743104 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/resources.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/resources.ts @@ -328,10 +328,12 @@ export const resourceHelpers = (context: MarkdownThemeContext) => { getProjectName: ( stringWithPlaceholders: string, page: MarkdownPageEvent, + includeVersion: boolean = true, ) => helpers.getProjectName.apply(context, [ stringWithPlaceholders, page, + includeVersion, ]) as string, getPropertyDefaultValue: (model: DeclarationReflection) => helpers.getPropertyDefaultValue.apply(context, [model]) as string | null, diff --git a/packages/typedoc-plugin-markdown/src/types/internationalization.ts b/packages/typedoc-plugin-markdown/src/types/internationalization.ts index 33ac3a742..e5e7d8c0f 100644 --- a/packages/typedoc-plugin-markdown/src/types/internationalization.ts +++ b/packages/typedoc-plugin-markdown/src/types/internationalization.ts @@ -11,7 +11,6 @@ export interface TranslatableStrings { theme_default_value: string; theme_default_type: string; theme_description: string; - theme_documentation: string; theme_event: string; theme_re_exports: string; theme_renames_and_re_exports: string; diff --git a/packages/typedoc-plugin-markdown/src/types/markdown-application.ts b/packages/typedoc-plugin-markdown/src/types/markdown-application.ts index 5723ecb48..4dd03c4e7 100644 --- a/packages/typedoc-plugin-markdown/src/types/markdown-application.ts +++ b/packages/typedoc-plugin-markdown/src/types/markdown-application.ts @@ -2,7 +2,7 @@ import { Application, Renderer } from 'typedoc'; import { MarkdownRenderer } from './markdown-renderer.js'; /** - * The MarkdownApplication extends TypeDoc's {@linkcode Application} instance with a custom renderer. + * The MarkdownApplication extends TypeDoc's {@link typedoc!Application Application} instance with a custom renderer. */ export interface MarkdownApplication extends Application { renderer: MarkdownRenderer & Renderer; diff --git a/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts b/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts index e48ba6442..64082fc9d 100644 --- a/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts +++ b/packages/typedoc-plugin-markdown/src/types/markdown-renderer.ts @@ -7,7 +7,7 @@ import { EventHooks, Options, Renderer } from 'typedoc'; import { MarkdownRendererHooks } from './markdown-renderer-hooks.js'; /** - * The MarkdownRenderer extends TypeDoc's Renderer instance with custom hooks and async jobs. + * The MarkdownRenderer extends TypeDoc's {@link typedoc!Renderer Renderer} instance with custom hooks and async jobs. */ export interface MarkdownRenderer extends Renderer { /** diff --git a/packages/typedoc-plugin-markdown/src/types/options.ts b/packages/typedoc-plugin-markdown/src/types/options.ts index faecbd7bc..f1ad7fca4 100644 --- a/packages/typedoc-plugin-markdown/src/types/options.ts +++ b/packages/typedoc-plugin-markdown/src/types/options.ts @@ -113,7 +113,7 @@ export interface PluginOptions { )[]; /** - * Merges the resolved readme into the project index page. + * Appends the documentation index page to the readme page. */ mergeReadme: boolean; @@ -136,6 +136,19 @@ export interface PluginOptions { */ outputFileStrategy: 'members' | 'modules'; + /** + * Change specific text placeholders in the template. + */ + pageTitleTemplates: { + index: + | string + | ((name: { projectName: string; version: string }) => string); + member: + | string + | ((name: { name: string; kind: string; group: string }) => string); + module: string | ((name: { name: string; kind: string }) => string); + }; + /** * Sets the format of parameter and type parameter groups. */ @@ -203,7 +216,7 @@ export interface PluginOptions { /** * Set the visibility level for type declaration documentation. */ - typeDeclarationVisibility: 'compact' | 'expanded'; + typeDeclarationVisibility: 'compact' | 'verbose'; /** * Wraps signatures and declarations in code blocks. diff --git a/packages/typedoc-plugin-markdown/supporting-docs/public/local-plugins.md b/packages/typedoc-plugin-markdown/supporting-docs/public/local-plugins.md index 6276f69e4..bd79cf4b2 100644 --- a/packages/typedoc-plugin-markdown/supporting-docs/public/local-plugins.md +++ b/packages/typedoc-plugin-markdown/supporting-docs/public/local-plugins.md @@ -30,7 +30,7 @@ The plugin can then be consumed by adding the path to the plugin in your `typedo } ``` -Note plugins can either be consumed as CommonJs or ESM. +Note plugins must be consumed as ESM. ## See diff --git a/devtools/packages/fixtures/cli.ts b/packages/typedoc-plugin-markdown/test/__scripts__/build-fixtures.mjs similarity index 64% rename from devtools/packages/fixtures/cli.ts rename to packages/typedoc-plugin-markdown/test/__scripts__/build-fixtures.mjs index c9d8c99f1..6caa7c127 100755 --- a/devtools/packages/fixtures/cli.ts +++ b/packages/typedoc-plugin-markdown/test/__scripts__/build-fixtures.mjs @@ -1,19 +1,16 @@ -#!/usr/bin/env tsx - -/* eslint-disable @typescript-eslint/no-unused-vars */ - -import { getPackageName } from '@devtools/helpers/index.js'; import { spawn } from 'child_process'; import { consola } from 'consola'; import fs from 'fs-extra'; +import pLimit from 'p-limit'; import * as path from 'path'; import { dirname } from 'path'; import { fileURLToPath } from 'url'; -import { Fixture } from './models.js'; export const __filename = fileURLToPath(import.meta.url); export const __dirname = dirname(__filename); +const limit = pLimit(5); + const timeStart = new Date().getTime(); main(); @@ -23,13 +20,11 @@ async function main() { fs.removeSync(outPath); - const config: Record = await import( - path.join(process.cwd(), process.argv[3]) - ); + const config = await import(path.join(process.cwd(), process.argv[3])); const fixtures = Object.entries(config.default); - const filtered = fixtures.filter(([key, config]) => { + const filtered = fixtures.filter(([, config]) => { return config.only; }); @@ -46,36 +41,47 @@ async function main() { `[${getPackageName()}] Building ${fixtureCount} test fixtures...`, ); - fixturesToBuild.forEach(([key, config]) => { - const outputFileStrategies: ('members' | 'modules')[] = - config.outputFileStrategies || ['members', 'modules']; - - //writeHtml(key, config.entryPoints); - outputFileStrategies.forEach((outputFileStrategy) => { - config.options.forEach((optionGroup, index: number) => { - const options = { - outputFileStrategy, - ...config.commonOptions, - ...optionGroup, - }; - writeMarkdown( - key, - config.entryPoints, - outputFileStrategy, - options, - 'opts-' + Number(index + 1), - ); - }); + // Create tasks for each fixture with limited concurrency + const tasks = fixturesToBuild.map(([key, config]) => + limit(() => processFixture(key, config)), + ); + + // Run all tasks and wait for completion + await Promise.all(tasks); +} + +async function processFixture(key, config) { + consola.info(`[${getPackageName()}] Building "${key}" fixture(s)`); + const outputFileStrategies = config.outputFileStrategies || [ + 'members', + 'modules', + ]; + + //writeHtml(key, config.entryPoints); + outputFileStrategies.forEach((outputFileStrategy) => { + config.options.forEach((optionGroup, index) => { + const options = { + outputFileStrategy, + ...config.commonOptions, + ...optionGroup, + }; + writeMarkdown( + key, + config.entryPoints, + outputFileStrategy, + options, + 'opts-' + Number(index + 1), + ); }); }); } function writeMarkdown( - key: string, - entryPoints: string[], - outputFileStrategy: 'members' | 'modules', - options: any, - optionDir: string, + key, + entryPoints, + outputFileStrategy, + options, + optionDir, ) { const fullPath = path.join( process.cwd(), @@ -87,12 +93,12 @@ function writeMarkdown( optionDir, ); - spawn( + const mdProcess = spawn( 'typedoc', [ ...[ '-options', - path.join(__dirname, 'typedoc.cjs'), + path.join(__dirname, '..', 'fixtures', 'typedoc.cjs'), '-logLevel', 'None', '-out', @@ -102,12 +108,26 @@ function writeMarkdown( ...objectToOptions(options), ], { - stdio: 'inherit', + stdio: 'pipe', }, ); + + mdProcess.on('close', (code) => { + if (code !== 0) { + consola.error( + `[${getPackageName()}] ${key} Fixture "${key}" exited with code ${code}.`, + ); + } + }); + + mdProcess.on('error', (err) => { + consola.error( + `[${getPackageName()}] Fixture "${key}" error occurred ${err.message}`, + ); + }); } -export function writeHtml(key: string, entryPoints: string[]) { +export function writeHtml(key, entryPoints) { const fixturesRoot = path.join( __dirname, '../../../packages/typedoc-plugin-markdown/test/fixtures', @@ -149,7 +169,7 @@ export function writeHtml(key: string, entryPoints: string[]) { ); } -function toEntryPoints(entryPoints: string | string[]) { +function toEntryPoints(entryPoints) { if (Array.isArray(entryPoints)) { return entryPoints.reduce((prev, curr) => { return [ @@ -161,9 +181,9 @@ function toEntryPoints(entryPoints: string | string[]) { return ['--entryPoints', `${process.cwd()}/test/fixtures/src/${entryPoints}`]; } -function objectToOptions(obj: any) { +function objectToOptions(obj) { return Object.entries(obj).reduce( - (prev: any, curr: any) => { + (prev, curr) => { if (Array.isArray(curr[1])) { return [ ...prev, @@ -175,7 +195,7 @@ function objectToOptions(obj: any) { if (typeof curr[1] === 'object') { return [ ...prev, - ...Object.entries(curr[1]).reduce((prev1: any, curr1: any) => { + ...Object.entries(curr[1]).reduce((prev1, curr1) => { return [...prev1, ...[`-${curr[0]}.${curr1[0]}`, curr1[1]]]; }, []), ]; @@ -199,3 +219,8 @@ process.on('exit', () => { ).toFixed(2)} seconds`, ); }); + +function getPackageName() { + const cwdParts = process.cwd().split(path.sep); + return cwdParts[cwdParts.length - 1]; +} diff --git a/packages/typedoc-plugin-markdown/test/scripts/lint.md.mjs b/packages/typedoc-plugin-markdown/test/__scripts__/lint/lint.md.mjs similarity index 100% rename from packages/typedoc-plugin-markdown/test/scripts/lint.md.mjs rename to packages/typedoc-plugin-markdown/test/__scripts__/lint/lint.md.mjs diff --git a/packages/typedoc-plugin-markdown/test/scripts/lint.mdx.mjs b/packages/typedoc-plugin-markdown/test/__scripts__/lint/lint.mdx.mjs similarity index 100% rename from packages/typedoc-plugin-markdown/test/scripts/lint.mdx.mjs rename to packages/typedoc-plugin-markdown/test/__scripts__/lint/lint.mdx.mjs diff --git a/packages/typedoc-plugin-markdown/test/fixtures/config.ts b/packages/typedoc-plugin-markdown/test/fixtures/config.mjs similarity index 97% rename from packages/typedoc-plugin-markdown/test/fixtures/config.ts rename to packages/typedoc-plugin-markdown/test/fixtures/config.mjs index 1510a0813..81a41df29 100644 --- a/packages/typedoc-plugin-markdown/test/fixtures/config.ts +++ b/packages/typedoc-plugin-markdown/test/fixtures/config.mjs @@ -1,4 +1,3 @@ -import { Fixture } from '@devtools/fixtures/models.js'; import * as path from 'path'; import { dirname } from 'path'; import { fileURLToPath } from 'url'; @@ -6,7 +5,10 @@ import { fileURLToPath } from 'url'; const __filename = fileURLToPath(import.meta.url); const __dirname = dirname(__filename); -const config: Record = { +/** + * @type {Record} + */ +const config = { reflections: { only: false, entryPoints: '/reflections/index.ts', @@ -248,6 +250,7 @@ const config: Record = { disableSources: true, mergeReadme: true, includeVersion: true, + options: './test/fixtures/typedoc.readme.cjs', }, ], }, @@ -264,10 +267,10 @@ const config: Record = { }, options: [ { - options: './test/fixtures/typedoc.text-mappings.cjs', + options: './test/fixtures/typedoc.text-1.cjs', }, { - options: './test/fixtures/typedoc.text-locales.cjs', + options: './test/fixtures/typedoc.text-2.cjs', }, ], }, diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/README.md new file mode 100644 index 000000000..d2cb95038 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/README.md @@ -0,0 +1,111 @@ +# typedoc-stubs + +Comments form module comments + +> links + +Links using `{@link}` inline tags. + +- [CommentInterface](interfaces/CommentInterface.md) - Links to CommentInterface +- [Links to CommentInterface.prop](interfaces/CommentInterface.md#prop) +- [Links to CommentInterface.propb](interfaces/CommentInterface.md#propb) +- [CommentEnum.MemberB](enumerations/CommentEnum.md) +- [SameName:var](variables/SameName.md) +- [SameName:interface](interfaces/SameName.md) +- [SameName.prop](interfaces/SameName.md#prop) +- [prop:var](variables/prop.md) +- [_prop_with_underscore:var](variables/prop_with_underscore.md) +- [TypeWithGenerics](type-aliases/TypeWithGenerics.md) + +External links: + +- [Google](https://www.google.com) +- [`https://www.google.com`](https://www.google.com) + +Relative Links: + +- [Relative Document](_media/PROJECT_DOC_1.md) +- [Relative Link](../../../groups/members/opts-1/index.md) + +Relative Image Links: + +Logo + +![Logo](_media/logo.svg) + +## See + + - Comments for a tag + - Comments for tag written on same line + +## Html And Jsx + +A in comments + +A `` in backticks + +Another object `{ x: 1 }`. + +
+ +
+ +Some random {{braces}}. + +``` +A in a code block +Some

html

inside codeblock +``` + +> codeBlocks + +```css +.class {color:red} +``` + +```html +
x
y +``` + +`single line {block}` + +## Enumerations + +- [CommentEnum](enumerations/CommentEnum.md) +- [EnumMembersTable](enumerations/EnumMembersTable.md) + +## Classes + +- [BaseClassProperties](classes/BaseClassProperties.md) +- [ClassPropertiesTable](classes/ClassPropertiesTable.md) + +## Interfaces + +- [BaseInterfaceProperties](interfaces/BaseInterfaceProperties.md) +- [CommentInterface](interfaces/CommentInterface.md) +- [CommentInterfaceExtended](interfaces/CommentInterfaceExtended.md) +- [InterfacePropertiesTable](interfaces/InterfacePropertiesTable.md) +- [SameName](interfaces/SameName.md) + +## Type Aliases + +- [TypeDeclarationTable](type-aliases/TypeDeclarationTable.md) +- [typeWithBlockTags](type-aliases/typeWithBlockTags.md) +- [TypeWithGenerics](type-aliases/TypeWithGenerics.md) + +## Variables + +- [\_prop\_with\_underscore](variables/prop_with_underscore.md) +- [prop](variables/prop.md) +- [propb](variables/propb.md) +- [SameName](variables/SameName.md) +- [TypeDeclarationTable](variables/TypeDeclarationTable.md) + +## Functions + +- [constFunction](functions/constFunction.md) +- [constFunctionWithReturns](functions/constFunctionWithReturns.md) +- [functionWithBlockTags](functions/functionWithBlockTags.md) +- [multipleExampleTags](functions/multipleExampleTags.md) +- [parametersTable](functions/parametersTable.md) +- [singleExampleTag](functions/singleExampleTag.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/_media/PROJECT_DOC_1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/_media/PROJECT_DOC_1.md new file mode 100644 index 000000000..5a3c556b5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/_media/PROJECT_DOC_1.md @@ -0,0 +1,8 @@ +--- +title: 'Project Document 1' +description: 'A description of the document' +--- + +## Project Document 1 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/_media/logo.png b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/_media/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..120c55ad67864cc4ef9a0231ebe19d718878ae36 GIT binary patch literal 1294 zcmc(eYg1Ea6oucDle-X)Tr}c9P7qLvK&lwLq!T zML@+G)IcPST;vXEwH<6i0jZ)wg-+2KC8!00mmuIEDt#OKC;DOS_3Zs=&ze~$q;Vo= zrUw%M;4BeGCODkOAAAjKvJP-bVa9^|2GdSIEl``1> zaHwyd(EE(oOSg4d^-gx{Znqnmi+)$J26CB?kJD^L=u8;}I^Mp>gqOOYjs!HCD8jR4$g+?8`at>Dc!Ri25eG1m{V66t$g}}O8Sg(Q&>tUk;Hig0F zG}y8kw(f#$BG{G)f86ph6OE-;=7=d+l@PZL01U%$9Ovj(g;R+*_!#; zO;NRmD~}#2{E~(asTV$0J^VS?f~*5H`Bi&v#Y7>hq^`D8@$P^tUjbwBp~eue(@vZu z4=1ei5N|2{w3_3-lx*Gjk7^77_saaU_JZ0}{`LvR^$m-sGed=|>u)D4Aq368)c{3Im_JAcW&J(O91?Am*aUYyk6DJj9Ww`WsC|I|=`Ofzs zfn1%4N=4a?b;zxL-QFkiexu?FxiP zpSQ&TpBnX~J5Ftu#O5%;EJpcbA6QGoGJ6M5wq|_h4RC3kMmExFkh6YCvaMkD;v!8l z!Utgqb0X0~jNCDB4N=aDv6KaDbSTXvI4peD({dnr_sboW6uiJtQ^c2~>q8!v?P;Kl zaH;Mm@KzU}XK>Tz<{bXjyRYWe>$`VV4LNgZmRPT0WSLfrT9^O*L#eC$w}66%o-y>g zM4Jzu9Q70mhoiqkXI3!CPJ0>TQ{`mR&F67G*3s8w{3jRE2?j)+vlAVUd(MbW2@4N#F&p3+VkEpa1UL^~l?CA<*U{h8|a-r6C#VNFoO* zO)B@2#+t)q+Flb8^?G{lSH*qgi|%9&doQ;lIztFHU;1)EG zwZs?SuyJK)m$>n|oun5;8%D(496Ub8`+QkDQq{cbY2|Ub$n2fA^RssFYICe4YQwFv z6|N3}C{##xsF1`!(om*gvEQ z^v|@t?Ri-}wG8K!KRI|`(kWmNi`AY-JOTaMe(+bvbRo^=lTyKw2l}Vl3V^Yc*W?d0 ymhn)EWuzd>!8%P&ATr6%oa=n5Po|9nPb>O-$sFt34~jHLV}T?pF0wH~uKpKvqB-UO literal 0 HcmV?d00001 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/_media/logo.svg b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/_media/logo.svg new file mode 100644 index 000000000..6c748a479 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/_media/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/classes/BaseClassProperties.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/classes/BaseClassProperties.md new file mode 100644 index 000000000..c96724c2d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/classes/BaseClassProperties.md @@ -0,0 +1,22 @@ +# Class: BaseClassProperties + +## Extended by + +- [`ClassPropertiesTable`](ClassPropertiesTable.md) + +## Constructors + +### new BaseClassProperties() + +> **new BaseClassProperties**(): [`BaseClassProperties`](BaseClassProperties.md) + +#### Returns + +[`BaseClassProperties`](BaseClassProperties.md) + +## Properties + +| Property | Type | Description | Source | +| ------ | ------ | ------ | ------ | +| ~~`propA`~~ | `string` | **Deprecated** | [index.ts:1](http://source-url) | +| `propB` | `string` | - | [index.ts:1](http://source-url) | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/classes/ClassPropertiesTable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/classes/ClassPropertiesTable.md new file mode 100644 index 000000000..45b190007 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/classes/ClassPropertiesTable.md @@ -0,0 +1,30 @@ +# Class: ClassPropertiesTable + +## Extends + +- [`BaseClassProperties`](BaseClassProperties.md) + +## Constructors + +### new ClassPropertiesTable() + +> **new ClassPropertiesTable**(): [`ClassPropertiesTable`](ClassPropertiesTable.md) + +#### Returns + +[`ClassPropertiesTable`](ClassPropertiesTable.md) + +#### Inherited from + +[`BaseClassProperties`](BaseClassProperties.md).[`constructor`](BaseClassProperties.md#constructors) + +## Properties + +| Property | Modifier | Type | Default value | Description | Overrides | Inherited from | Source | +| ------ | ------ | ------ | ------ | ------ | ------ | ------ | ------ | +| `prop1` | `private` | `boolean` | `undefined` | The subroutine recursively parsed the hexadecimal data. to generate the binary output for input validation. | - | - | [index.ts:1](http://source-url) | +| `prop2` | `readonly` | `RegExp` | `undefined` | Below is a breakdown of the notable performances: - The CPU executed the instruction set in parallel with the GPU computations. - The RAM efficiently cached the frequently accessed data for faster retrieval. - The SSD accessed the stored files with lightning speed due to its high read/write capabilities. | - | - | [index.ts:1](http://source-url) | +| `prop3?` | `public` | `string` | `undefined` | > Example of Triple Code Block `def greet(name): print("Hello, " + name + "!")` | - | - | [index.ts:1](http://source-url) | +| ~~`propA`~~ | `public` | `string` | `'propAValue'` | **Deprecated** | [`BaseClassProperties`](BaseClassProperties.md).`propA` | - | [index.ts:1](http://source-url) | +| `propB` | `public` | `string` | `undefined` | - | - | [`BaseClassProperties`](BaseClassProperties.md).`propB` | [index.ts:1](http://source-url) | +| `propWithFlag` | `public` | `string` | `undefined` | **`Experimental`** Experimental flag comments | - | - | [index.ts:1](http://source-url) | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/enumerations/CommentEnum.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/enumerations/CommentEnum.md new file mode 100644 index 000000000..4fff10e0f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/enumerations/CommentEnum.md @@ -0,0 +1,8 @@ +# Enumeration: CommentEnum + +## Enumeration Members + +| Enumeration Member | Value | Description | Source | +| ------ | ------ | ------ | ------ | +| `Member` | `0` | Comment for Member Some

html

and . **Deprecated** Deprecated member **See** [SameName](../interfaces/SameName.md) | [index.ts:1](http://source-url) | +| `MemberB` | `1` | - | [index.ts:1](http://source-url) | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/enumerations/EnumMembersTable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/enumerations/EnumMembersTable.md new file mode 100644 index 000000000..106243e0c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/enumerations/EnumMembersTable.md @@ -0,0 +1,7 @@ +# Enumeration: EnumMembersTable + +## Enumeration Members + +| Enumeration Member | Value | Description | Source | +| ------ | ------ | ------ | ------ | +| `member1` | `"member1"` | The subroutine recursively parsed the hexadecimal data. | [index.ts:1](http://source-url) | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/constFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/constFunction.md new file mode 100644 index 000000000..bdee2ad41 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/constFunction.md @@ -0,0 +1,23 @@ +# Function: constFunction() + +> **constFunction**(`text`): `boolean` + +constFunction comments + +## Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | Some param | + +## Returns + +`boolean` + +## Remarks + +Some remarks + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/constFunctionWithReturns.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/constFunctionWithReturns.md new file mode 100644 index 000000000..5bf3d155b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/constFunctionWithReturns.md @@ -0,0 +1,25 @@ +# Function: constFunctionWithReturns() + +> **constFunctionWithReturns**(`text`): `boolean` + +constFunctionWithReturns comments + +## Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | Some param | + +## Returns + +`boolean` + +Return comments + +## Remarks + +Some remarks + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/functionWithBlockTags.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/functionWithBlockTags.md new file mode 100644 index 000000000..34b580fbe --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/functionWithBlockTags.md @@ -0,0 +1,34 @@ +# Function: functionWithBlockTags() + +> **functionWithBlockTags**(`x`, `y`): `void` + +Function with block tags summary + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `x` | `string` | +| `y` | `string` | + +## Returns + +`void` + +## Example + +```ts +const x = 1; +``` + +## See + +abc.com + +## Remarks + +Other block tags + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/multipleExampleTags.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/multipleExampleTags.md new file mode 100644 index 000000000..26ea45ff8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/multipleExampleTags.md @@ -0,0 +1,30 @@ +# Function: multipleExampleTags() + +> **multipleExampleTags**(): `boolean` + +Function with multiple example tags + +## Returns + +`boolean` + +## Examples + +```ts +// If there are no code blocks, TypeDoc assumes the whole tag +// should be a code block. This is not valid TSDoc, but is recognized +// by VSCode and enables better JSDoc support. + +factorial(1) +``` + +If there is a code block, then both TypeDoc and VSCode will treat +text outside of the code block as regular text. + +```ts +factorial(1) +``` + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/parametersTable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/parametersTable.md new file mode 100644 index 000000000..b4674bc83 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/parametersTable.md @@ -0,0 +1,27 @@ +# Function: parametersTable() + +> **parametersTable**\<`T`\>(`param1`, `param2`, `param3`): `number` + +Adds two numbers together. + +## Type Parameters + +| Type Parameter | Default type | Description | +| ------ | ------ | ------ | +| `T` | `string` | The type of the numbers to be added. | + +## Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `param1` | `number` | `undefined` | The first param to be added. | +| `param2` | `number` | `undefined` | The second param to be added. Some additional text for num2. | +| `param3` | `number` | `4` | The third param to be added. | + +## Returns + +`number` + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/singleExampleTag.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/singleExampleTag.md new file mode 100644 index 000000000..ac2eba98e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/functions/singleExampleTag.md @@ -0,0 +1,24 @@ +# Function: singleExampleTag() + +> **singleExampleTag**(): `boolean` + +Function with single example tag + +## Returns + +`boolean` + +Return comments + +## Example + +If there is a code block, then both TypeDoc and VSCode will treat +text outside of the code block as regular text. + +```ts +factorial(1) +``` + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/BaseInterfaceProperties.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/BaseInterfaceProperties.md new file mode 100644 index 000000000..7cf47730d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/BaseInterfaceProperties.md @@ -0,0 +1,27 @@ +# Interface: BaseInterfaceProperties + +## Extended by + +- [`InterfacePropertiesTable`](InterfacePropertiesTable.md) + +## Properties + +### ~~propA~~ + +> **propA**: `string` + +#### Deprecated + +#### Source + +[index.ts:1](http://source-url) + +*** + +### propB + +> **propB**: `string` + +#### Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/CommentInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/CommentInterface.md new file mode 100644 index 000000000..22945d0a5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/CommentInterface.md @@ -0,0 +1,25 @@ +# Interface: CommentInterface + +## Extended by + +- [`CommentInterfaceExtended`](CommentInterfaceExtended.md) + +## Properties + +### prop + +> **prop**: `string` + +#### Source + +[index.ts:1](http://source-url) + +*** + +### propb + +> **propb**: `string` + +#### Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/CommentInterfaceExtended.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/CommentInterfaceExtended.md new file mode 100644 index 000000000..43bef333e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/CommentInterfaceExtended.md @@ -0,0 +1,43 @@ +# Interface: CommentInterfaceExtended + +## Extends + +- [`CommentInterface`](CommentInterface.md) + +## Properties + +### prop + +> **prop**: `string` + +#### Inherited from + +[`CommentInterface`](CommentInterface.md).[`prop`](CommentInterface.md#prop) + +#### Source + +[index.ts:1](http://source-url) + +*** + +### propb + +> **propb**: `string` + +#### Inherited from + +[`CommentInterface`](CommentInterface.md).[`propb`](CommentInterface.md#propb) + +#### Source + +[index.ts:1](http://source-url) + +*** + +### propc + +> **propc**: `string` + +#### Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/InterfacePropertiesTable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/InterfacePropertiesTable.md new file mode 100644 index 000000000..794d4a5b6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/InterfacePropertiesTable.md @@ -0,0 +1,96 @@ +# Interface: InterfacePropertiesTable + +## Extends + +- [`BaseInterfaceProperties`](BaseInterfaceProperties.md) + +## Properties + +### prop1 + +> **prop1**: `boolean` + +The subroutine recursively parsed the hexadecimal data. +to generate the binary output for input validation. + +#### Source + +[index.ts:1](http://source-url) + +*** + +### prop2 + +> **prop2**: `RegExp` + +Below is a breakdown of the notable performances: + +- The CPU executed the instruction set in parallel with the GPU computations. +- The RAM efficiently cached the frequently accessed data for faster retrieval. +- The SSD accessed the stored files with lightning speed due to its high read/write capabilities. + +#### Source + +[index.ts:1](http://source-url) + +*** + +### prop3? + +> `optional` **prop3**: `string` + +> Example of Triple Code Block + +```ts +def greet(name): +print("Hello, " + name + "!") +``` + +#### Source + +[index.ts:1](http://source-url) + +*** + +### prop4 + +> **prop4**: `object` + +| Name | Type | Source | +| ------ | ------ | ------ | +| `a` | `string` | [index.ts:1](http://source-url) | +| `b` | `string` | [index.ts:1](http://source-url) | + +#### Source + +[index.ts:1](http://source-url) + +*** + +### ~~propA~~ + +> **propA**: `string` + +#### Deprecated + +#### Inherited from + +[`BaseInterfaceProperties`](BaseInterfaceProperties.md).[`propA`](BaseInterfaceProperties.md#propa) + +#### Source + +[index.ts:1](http://source-url) + +*** + +### propB + +> **propB**: `string` + +#### Inherited from + +[`BaseInterfaceProperties`](BaseInterfaceProperties.md).[`propB`](BaseInterfaceProperties.md#propb) + +#### Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/SameName.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/SameName.md new file mode 100644 index 000000000..ea2277102 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/interfaces/SameName.md @@ -0,0 +1,21 @@ +# Interface: SameName + +## Properties + +### prop + +> **prop**: `string` + +#### Source + +[index.ts:1](http://source-url) + +*** + +### propb + +> **propb**: `string` + +#### Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/sidebar.json new file mode 100644 index 000000000..ab4461791 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/sidebar.json @@ -0,0 +1,147 @@ +[ + { + "title": "Enumerations", + "children": [ + { + "title": "CommentEnum", + "kind": 8, + "path": "enumerations/CommentEnum.md" + }, + { + "title": "EnumMembersTable", + "kind": 8, + "path": "enumerations/EnumMembersTable.md" + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "BaseClassProperties", + "kind": 128, + "path": "classes/BaseClassProperties.md" + }, + { + "title": "ClassPropertiesTable", + "kind": 128, + "path": "classes/ClassPropertiesTable.md" + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "BaseInterfaceProperties", + "kind": 256, + "path": "interfaces/BaseInterfaceProperties.md" + }, + { + "title": "CommentInterface", + "kind": 256, + "path": "interfaces/CommentInterface.md" + }, + { + "title": "CommentInterfaceExtended", + "kind": 256, + "path": "interfaces/CommentInterfaceExtended.md" + }, + { + "title": "InterfacePropertiesTable", + "kind": 256, + "path": "interfaces/InterfacePropertiesTable.md" + }, + { + "title": "SameName", + "kind": 256, + "path": "interfaces/SameName.md" + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeDeclarationTable", + "kind": 2097152, + "path": "type-aliases/TypeDeclarationTable.md" + }, + { + "title": "typeWithBlockTags", + "kind": 2097152, + "path": "type-aliases/typeWithBlockTags.md" + }, + { + "title": "TypeWithGenerics", + "kind": 2097152, + "path": "type-aliases/TypeWithGenerics.md" + } + ] + }, + { + "title": "Variables", + "children": [ + { + "title": "_prop_with_underscore", + "kind": 32, + "path": "variables/prop_with_underscore.md" + }, + { + "title": "prop", + "kind": 32, + "path": "variables/prop.md" + }, + { + "title": "propb", + "kind": 32, + "path": "variables/propb.md" + }, + { + "title": "SameName", + "kind": 32, + "path": "variables/SameName.md" + }, + { + "title": "TypeDeclarationTable", + "kind": 32, + "path": "variables/TypeDeclarationTable.md" + } + ] + }, + { + "title": "Functions", + "children": [ + { + "title": "constFunction", + "kind": 64, + "path": "functions/constFunction.md" + }, + { + "title": "constFunctionWithReturns", + "kind": 64, + "path": "functions/constFunctionWithReturns.md" + }, + { + "title": "functionWithBlockTags", + "kind": 64, + "path": "functions/functionWithBlockTags.md" + }, + { + "title": "multipleExampleTags", + "kind": 64, + "path": "functions/multipleExampleTags.md" + }, + { + "title": "parametersTable", + "kind": 64, + "path": "functions/parametersTable.md" + }, + { + "title": "singleExampleTag", + "kind": 64, + "path": "functions/singleExampleTag.md" + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/type-aliases/TypeDeclarationTable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/type-aliases/TypeDeclarationTable.md new file mode 100644 index 000000000..df5dbb2d7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/type-aliases/TypeDeclarationTable.md @@ -0,0 +1,15 @@ +# Type Alias: TypeDeclarationTable + +> **TypeDeclarationTable**: `object` + +## Type declaration + +| Name | Type | Description | Source | +| ------ | ------ | ------ | ------ | +| `declaration1` | `boolean` | The subroutine recursively parsed the hexadecimal data. to generate the binary output for input validation. | [index.ts:1](http://source-url) | +| `declaration2` | `boolean` | The subroutine recursively parsed the hexadecimal data. to generate the binary output for input validation. | [index.ts:1](http://source-url) | +| `declaration4` | `100` | - | [index.ts:1](http://source-url) | + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/type-aliases/TypeWithGenerics.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/type-aliases/TypeWithGenerics.md new file mode 100644 index 000000000..98abf808c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/type-aliases/TypeWithGenerics.md @@ -0,0 +1,14 @@ +# Type Alias: TypeWithGenerics\ + +> **TypeWithGenerics**\<`C`, `D`\>: `C` \| `D` + +## Type Parameters + +| Type Parameter | +| ------ | +| `C` | +| `D` | + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/type-aliases/typeWithBlockTags.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/type-aliases/typeWithBlockTags.md new file mode 100644 index 000000000..41b9a0b72 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/type-aliases/typeWithBlockTags.md @@ -0,0 +1,25 @@ +# Type Alias: typeWithBlockTags + +> **typeWithBlockTags**: `object` + +Variable with block tags summary + +## Type declaration + +| Name | Type | Source | +| ------ | ------ | ------ | +| `x` | `string` | [index.ts:1](http://source-url) | + +## Example + +```ts +const x = 1; +``` + +## Remarks + +Other block tags + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/SameName.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/SameName.md new file mode 100644 index 000000000..8c7ec290e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/SameName.md @@ -0,0 +1,7 @@ +# Variable: SameName + +> **SameName**: `true` + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/TypeDeclarationTable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/TypeDeclarationTable.md new file mode 100644 index 000000000..f2f876298 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/TypeDeclarationTable.md @@ -0,0 +1,14 @@ +# Variable: TypeDeclarationTable + +> **TypeDeclarationTable**: `object` + +## Type declaration + +| Name | Type | Default value | Source | +| ------ | ------ | ------ | ------ | +| `declaration1` | `string` | 'declaration3' | [index.ts:1](http://source-url) | +| `declaration2` | `number` | 100 | [index.ts:1](http://source-url) | + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/prop.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/prop.md new file mode 100644 index 000000000..53fee385a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/prop.md @@ -0,0 +1,7 @@ +# Variable: prop + +> `const` **prop**: `true` = `true` + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/prop_with_underscore.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/prop_with_underscore.md new file mode 100644 index 000000000..85c4ba57d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/prop_with_underscore.md @@ -0,0 +1,7 @@ +# Variable: \_prop\_with\_underscore + +> `const` **\_prop\_with\_underscore**: `true` = `true` + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/propb.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/propb.md new file mode 100644 index 000000000..f6acbd6cf --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-1/variables/propb.md @@ -0,0 +1,7 @@ +# Variable: propb + +> `const` **propb**: `true` = `true` + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Class.BaseClassProperties.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Class.BaseClassProperties.md new file mode 100644 index 000000000..dea647264 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Class.BaseClassProperties.md @@ -0,0 +1,65 @@ +# Class: BaseClassProperties + +## Extended by + +- [`ClassPropertiesTable`](https://example.com/Class.ClassPropertiesTable.md) + +## Constructors + + + +### new BaseClassProperties() + +> **new BaseClassProperties**(): [`BaseClassProperties`](https://example.com/Class.BaseClassProperties.md) + +#### Returns + +[`BaseClassProperties`](https://example.com/Class.BaseClassProperties.md) + +## Properties + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescription
+ + ~~`propA`~~ + + + +`string` + + + +**Deprecated** + +
+ + `propB` + + + +`string` + + + +‐ + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Class.ClassPropertiesTable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Class.ClassPropertiesTable.md new file mode 100644 index 000000000..362fc147a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Class.ClassPropertiesTable.md @@ -0,0 +1,149 @@ +# Class: ClassPropertiesTable + +## Extends + +- [`BaseClassProperties`](https://example.com/Class.BaseClassProperties.md) + +## Constructors + + + +### new ClassPropertiesTable() + +> **new ClassPropertiesTable**(): [`ClassPropertiesTable`](https://example.com/Class.ClassPropertiesTable.md) + +#### Returns + +[`ClassPropertiesTable`](https://example.com/Class.ClassPropertiesTable.md) + +#### Inherited from + +[`BaseClassProperties`](https://example.com/Class.BaseClassProperties.md).[`constructor`](https://example.com/Class.BaseClassProperties.md#Constructors) + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescription
+ + `prop1` + + + +`boolean` + + + +The subroutine recursively parsed the hexadecimal data. +to generate the binary output for input validation. + +
+ + `prop2` + + + +`RegExp` + + + +Below is a breakdown of the notable performances: + +- The CPU executed the instruction set in parallel with the GPU computations. +- The RAM efficiently cached the frequently accessed data for faster retrieval. +- The SSD accessed the stored files with lightning speed due to its high read/write capabilities. + +
+ + `prop3?` + + + +`string` + + + +> Example of Triple Code Block + +```ts +def greet(name): +print("Hello, " + name + "!") +``` + +
+ + ~~`propA`~~ + + + +`string` + + + +**Deprecated** + +
+ + `propB` + + + +`string` + + + +‐ + +
+ + `propWithFlag` + + + +`string` + + + +**`Experimental`** + +Experimental flag comments + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Enumeration.CommentEnum.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Enumeration.CommentEnum.md new file mode 100644 index 000000000..647ec5996 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Enumeration.CommentEnum.md @@ -0,0 +1,59 @@ +# Enumeration: CommentEnum + +## Enumeration Members + + + + + + + + + + + + + + + + + + + + + +
Enumeration MemberValueDescription
+ + `Member` + + + +`0` + + + +Comment for Member + +Some \ html \ and \\. + +**Deprecated** + +Deprecated member + +**See** + +[SameName](https://example.com/Interface.SameName.md) + +
+ + `MemberB` + + + +`1` + + + +‐ + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Enumeration.EnumMembersTable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Enumeration.EnumMembersTable.md new file mode 100644 index 000000000..897764410 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Enumeration.EnumMembersTable.md @@ -0,0 +1,32 @@ +# Enumeration: EnumMembersTable + +## Enumeration Members + + + + + + + + + + + + + + + + +
Enumeration MemberValueDescription
+ + `member1` + + + +`"member1"` + + + +The subroutine recursively parsed the hexadecimal data. + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.constFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.constFunction.md new file mode 100644 index 000000000..4ca799bca --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.constFunction.md @@ -0,0 +1,48 @@ +# Function: constFunction() + +> **constFunction**(`text`): `boolean` + +constFunction comments + +## Parameters + + + + + + + + + + + + + + + + +
ParameterTypeDescription
+ +`text` + + + +`string` + + + +Some param + +
+ +## Returns + +`boolean` + +## Remarks + +Some remarks + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.constFunctionWithReturns.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.constFunctionWithReturns.md new file mode 100644 index 000000000..f83544a23 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.constFunctionWithReturns.md @@ -0,0 +1,50 @@ +# Function: constFunctionWithReturns() + +> **constFunctionWithReturns**(`text`): `boolean` + +constFunctionWithReturns comments + +## Parameters + + + + + + + + + + + + + + + + +
ParameterTypeDescription
+ +`text` + + + +`string` + + + +Some param + +
+ +## Returns + +`boolean` + +Return comments + +## Remarks + +Some remarks + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.functionWithBlockTags.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.functionWithBlockTags.md new file mode 100644 index 000000000..3eacfca36 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.functionWithBlockTags.md @@ -0,0 +1,64 @@ +# Function: functionWithBlockTags() + +> **functionWithBlockTags**(`x`, `y`): `void` + +Function with block tags summary + +## Example + +```ts +const x = 1; +``` + +## Parameters + + + + + + + + + + + + + + + + + + +
ParameterType
+ +`x` + + + +`string` + +
+ +`y` + + + +`string` + +
+ +## Returns + +`void` + +## See + +abc.com + +## Remarks + +Other block tags + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.multipleExampleTags.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.multipleExampleTags.md new file mode 100644 index 000000000..26ea45ff8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.multipleExampleTags.md @@ -0,0 +1,30 @@ +# Function: multipleExampleTags() + +> **multipleExampleTags**(): `boolean` + +Function with multiple example tags + +## Returns + +`boolean` + +## Examples + +```ts +// If there are no code blocks, TypeDoc assumes the whole tag +// should be a code block. This is not valid TSDoc, but is recognized +// by VSCode and enables better JSDoc support. + +factorial(1) +``` + +If there is a code block, then both TypeDoc and VSCode will treat +text outside of the code block as regular text. + +```ts +factorial(1) +``` + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.parametersTable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.parametersTable.md new file mode 100644 index 000000000..119bd56f6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.parametersTable.md @@ -0,0 +1,106 @@ +# Function: parametersTable() + +> **parametersTable**\<`T`\>(`param1`, `param2`, `param3`): `number` + +Adds two numbers together. + +## Type Parameters + + + + + + + + + + + + + + +
Type ParameterDescription
+ +`T` + + + +The type of the numbers to be added. + +
+ +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeDescription
+ +`param1` + + + +`number` + + + +The first param +to be added. + +
+ +`param2` + + + +`number` + + + +The second param to be added. + +Some additional text for num2. + +
+ +`param3` + + + +`number` + + + +The third param to be added. + +
+ +## Returns + +`number` + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.singleExampleTag.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.singleExampleTag.md new file mode 100644 index 000000000..7c1653047 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Function.singleExampleTag.md @@ -0,0 +1,24 @@ +# Function: singleExampleTag() + +> **singleExampleTag**(): `boolean` + +Function with single example tag + +## Example + +If there is a code block, then both TypeDoc and VSCode will treat +text outside of the code block as regular text. + +```ts +factorial(1) +``` + +## Returns + +`boolean` + +Return comments + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.BaseInterfaceProperties.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.BaseInterfaceProperties.md new file mode 100644 index 000000000..7e811817c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.BaseInterfaceProperties.md @@ -0,0 +1,53 @@ +# Interface: BaseInterfaceProperties + +## Extended by + +- [`InterfacePropertiesTable`](https://example.com/Interface.InterfacePropertiesTable.md) + +## Properties + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescription
+ + ~~`propA`~~ + + + +`string` + + + +**Deprecated** + +
+ + `propB` + + + +`string` + + + +‐ + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.CommentInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.CommentInterface.md new file mode 100644 index 000000000..b34ad2430 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.CommentInterface.md @@ -0,0 +1,42 @@ +# Interface: CommentInterface + +## Extended by + +- [`CommentInterfaceExtended`](https://example.com/Interface.CommentInterfaceExtended.md) + +## Properties + + + + + + + + + + + + + + + + + + +
PropertyType
+ + `prop` + + + +`string` + +
+ + `propb` + + + +`string` + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.CommentInterfaceExtended.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.CommentInterfaceExtended.md new file mode 100644 index 000000000..cbe0f01cb --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.CommentInterfaceExtended.md @@ -0,0 +1,54 @@ +# Interface: CommentInterfaceExtended + +## Extends + +- [`CommentInterface`](https://example.com/Interface.CommentInterface.md) + +## Properties + + + + + + + + + + + + + + + + + + + + + + +
PropertyType
+ + `prop` + + + +`string` + +
+ + `propb` + + + +`string` + +
+ + `propc` + + + +`string` + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.InterfacePropertiesTable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.InterfacePropertiesTable.md new file mode 100644 index 000000000..6aaaed12e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.InterfacePropertiesTable.md @@ -0,0 +1,165 @@ +# Interface: InterfacePropertiesTable + +## Extends + +- [`BaseInterfaceProperties`](https://example.com/Interface.BaseInterfaceProperties.md) + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescription
+ + `prop1` + + + +`boolean` + + + +The subroutine recursively parsed the hexadecimal data. +to generate the binary output for input validation. + +
+ + `prop2` + + + +`RegExp` + + + +Below is a breakdown of the notable performances: + +- The CPU executed the instruction set in parallel with the GPU computations. +- The RAM efficiently cached the frequently accessed data for faster retrieval. +- The SSD accessed the stored files with lightning speed due to its high read/write capabilities. + +
+ + `prop3?` + + + +`string` + + + +> Example of Triple Code Block + +```ts +def greet(name): +print("Hello, " + name + "!") +``` + +
+ + `prop4` + + + +\{`a`: `string`;`b`: `string`; \} + + + +‐ + +
+ + `prop4.a` + + + +`string` + + + +‐ + +
+ + `prop4.b` + + + +`string` + + + +‐ + +
+ + ~~`propA`~~ + + + +`string` + + + +**Deprecated** + +
+ + `propB` + + + +`string` + + + +‐ + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.SameName.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.SameName.md new file mode 100644 index 000000000..fa380fb73 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Interface.SameName.md @@ -0,0 +1,38 @@ +# Interface: SameName + +## Properties + + + + + + + + + + + + + + + + + + +
PropertyType
+ + `prop` + + + +`string` + +
+ + `propb` + + + +`string` + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/README.md new file mode 100644 index 000000000..08c038f74 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/README.md @@ -0,0 +1,111 @@ +# typedoc-stubs + +Comments form module comments + +> links + +Links using `{@link}` inline tags. + +- [CommentInterface](https://example.com/Interface.CommentInterface.md) - Links to CommentInterface +- [Links to CommentInterface.prop](https://example.com/Interface.CommentInterface.md#prop) +- [Links to CommentInterface.propb](https://example.com/Interface.CommentInterface.md#propb) +- [CommentEnum.MemberB](https://example.com/Enumeration.CommentEnum.md#MemberB) +- [SameName:var](https://example.com/Variable.SameName.md) +- [SameName:interface](https://example.com/Interface.SameName.md) +- [SameName.prop](https://example.com/Interface.SameName.md#prop) +- [prop:var](https://example.com/Variable.prop.md) +- [_prop_with_underscore:var](https://example.com/Variable._prop_with_underscore.md) +- [TypeWithGenerics](https://example.com/TypeAlias.TypeWithGenerics.md) + +External links: + +- [Google](https://www.google.com) +- [`https://www.google.com`](https://www.google.com) + +Relative Links: + +- [Relative Document](https://example.com/_media/PROJECT_DOC_1.md) +- [Relative Link](../../../groups/members/opts-1/index.md) + +Relative Image Links: + +\Logo + +![Logo](https://example.com/_media/logo.svg) + +## See + + - Comments for a tag + - Comments for tag written on same line + +## Html And Jsx + +A \\ in comments + +A `` in backticks + +Another object `{ x: 1 }`. + +\
+ \ +\ + +Some random \{\{braces\}\}. + +``` +A in a code block +Some

html

inside codeblock +``` + +> codeBlocks + +```css +.class {color:red} +``` + +```html +
x
y +``` + +`single line {block}` + +## Enumerations + +- [CommentEnum](https://example.com/Enumeration.CommentEnum.md) +- [EnumMembersTable](https://example.com/Enumeration.EnumMembersTable.md) + +## Classes + +- [BaseClassProperties](https://example.com/Class.BaseClassProperties.md) +- [ClassPropertiesTable](https://example.com/Class.ClassPropertiesTable.md) + +## Interfaces + +- [BaseInterfaceProperties](https://example.com/Interface.BaseInterfaceProperties.md) +- [CommentInterface](https://example.com/Interface.CommentInterface.md) +- [CommentInterfaceExtended](https://example.com/Interface.CommentInterfaceExtended.md) +- [InterfacePropertiesTable](https://example.com/Interface.InterfacePropertiesTable.md) +- [SameName](https://example.com/Interface.SameName.md) + +## Type Aliases + +- [TypeDeclarationTable](https://example.com/TypeAlias.TypeDeclarationTable.md) +- [typeWithBlockTags](https://example.com/TypeAlias.typeWithBlockTags.md) +- [TypeWithGenerics](https://example.com/TypeAlias.TypeWithGenerics.md) + +## Variables + +- [\_prop\_with\_underscore](https://example.com/Variable._prop_with_underscore.md) +- [prop](https://example.com/Variable.prop.md) +- [propb](https://example.com/Variable.propb.md) +- [SameName](https://example.com/Variable.SameName.md) +- [TypeDeclarationTable](https://example.com/Variable.TypeDeclarationTable.md) + +## Functions + +- [constFunction](https://example.com/Function.constFunction.md) +- [constFunctionWithReturns](https://example.com/Function.constFunctionWithReturns.md) +- [functionWithBlockTags](https://example.com/Function.functionWithBlockTags.md) +- [multipleExampleTags](https://example.com/Function.multipleExampleTags.md) +- [parametersTable](https://example.com/Function.parametersTable.md) +- [singleExampleTag](https://example.com/Function.singleExampleTag.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/TypeAlias.TypeDeclarationTable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/TypeAlias.TypeDeclarationTable.md new file mode 100644 index 000000000..36705770a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/TypeAlias.TypeDeclarationTable.md @@ -0,0 +1,74 @@ +# Type Alias: TypeDeclarationTable + +> **TypeDeclarationTable**: \{`declaration1`: `boolean`;`declaration2`: `boolean`;`declaration4`: `100`; \} + +## Type declaration + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
+ +`declaration1` + + + +`boolean` + + + +The subroutine recursively parsed the hexadecimal data. +to generate the binary output for input validation. + +
+ +`declaration2` + + + +`boolean` + + + +The subroutine recursively parsed the hexadecimal data. +to generate the binary output for input validation. + +
+ +`declaration4` + + + +`100` + + + +‐ + +
+ +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/TypeAlias.TypeWithGenerics.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/TypeAlias.TypeWithGenerics.md new file mode 100644 index 000000000..46ecc1c72 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/TypeAlias.TypeWithGenerics.md @@ -0,0 +1,33 @@ +# Type Alias: TypeWithGenerics\ + +> **TypeWithGenerics**\<`C`, `D`\>: `C` \| `D` + +## Type Parameters + + + + + + + + + + + + + + + +
Type Parameter
+ +`C` + +
+ +`D` + +
+ +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/TypeAlias.typeWithBlockTags.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/TypeAlias.typeWithBlockTags.md new file mode 100644 index 000000000..fddc269a3 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/TypeAlias.typeWithBlockTags.md @@ -0,0 +1,44 @@ +# Type Alias: typeWithBlockTags + +> **typeWithBlockTags**: \{`x`: `string`; \} + +Variable with block tags summary + +## Example + +```ts +const x = 1; +``` + +## Type declaration + + + + + + + + + + + + + + +
NameType
+ +`x` + + + +`string` + +
+ +## Remarks + +Other block tags + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable.SameName.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable.SameName.md new file mode 100644 index 000000000..8c7ec290e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable.SameName.md @@ -0,0 +1,7 @@ +# Variable: SameName + +> **SameName**: `true` + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable.TypeDeclarationTable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable.TypeDeclarationTable.md new file mode 100644 index 000000000..ed42f76fb --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable.TypeDeclarationTable.md @@ -0,0 +1,55 @@ +# Variable: TypeDeclarationTable + +> **TypeDeclarationTable**: \{`declaration1`: `string`;`declaration2`: `number`; \} + +## Type declaration + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
+ +`declaration1` + + + +`string` + + + +'declaration3' + +
+ +`declaration2` + + + +`number` + + + +100 + +
+ +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable._prop_with_underscore.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable._prop_with_underscore.md new file mode 100644 index 000000000..85c4ba57d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable._prop_with_underscore.md @@ -0,0 +1,7 @@ +# Variable: \_prop\_with\_underscore + +> `const` **\_prop\_with\_underscore**: `true` = `true` + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable.prop.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable.prop.md new file mode 100644 index 000000000..53fee385a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable.prop.md @@ -0,0 +1,7 @@ +# Variable: prop + +> `const` **prop**: `true` = `true` + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable.propb.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable.propb.md new file mode 100644 index 000000000..f6acbd6cf --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/Variable.propb.md @@ -0,0 +1,7 @@ +# Variable: propb + +> `const` **propb**: `true` = `true` + +## Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/_media/PROJECT_DOC_1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/_media/PROJECT_DOC_1.md new file mode 100644 index 000000000..5a3c556b5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/_media/PROJECT_DOC_1.md @@ -0,0 +1,8 @@ +--- +title: 'Project Document 1' +description: 'A description of the document' +--- + +## Project Document 1 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/_media/logo.png b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/_media/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..120c55ad67864cc4ef9a0231ebe19d718878ae36 GIT binary patch literal 1294 zcmc(eYg1Ea6oucDle-X)Tr}c9P7qLvK&lwLq!T zML@+G)IcPST;vXEwH<6i0jZ)wg-+2KC8!00mmuIEDt#OKC;DOS_3Zs=&ze~$q;Vo= zrUw%M;4BeGCODkOAAAjKvJP-bVa9^|2GdSIEl``1> zaHwyd(EE(oOSg4d^-gx{Znqnmi+)$J26CB?kJD^L=u8;}I^Mp>gqOOYjs!HCD8jR4$g+?8`at>Dc!Ri25eG1m{V66t$g}}O8Sg(Q&>tUk;Hig0F zG}y8kw(f#$BG{G)f86ph6OE-;=7=d+l@PZL01U%$9Ovj(g;R+*_!#; zO;NRmD~}#2{E~(asTV$0J^VS?f~*5H`Bi&v#Y7>hq^`D8@$P^tUjbwBp~eue(@vZu z4=1ei5N|2{w3_3-lx*Gjk7^77_saaU_JZ0}{`LvR^$m-sGed=|>u)D4Aq368)c{3Im_JAcW&J(O91?Am*aUYyk6DJj9Ww`WsC|I|=`Ofzs zfn1%4N=4a?b;zxL-QFkiexu?FxiP zpSQ&TpBnX~J5Ftu#O5%;EJpcbA6QGoGJ6M5wq|_h4RC3kMmExFkh6YCvaMkD;v!8l z!Utgqb0X0~jNCDB4N=aDv6KaDbSTXvI4peD({dnr_sboW6uiJtQ^c2~>q8!v?P;Kl zaH;Mm@KzU}XK>Tz<{bXjyRYWe>$`VV4LNgZmRPT0WSLfrT9^O*L#eC$w}66%o-y>g zM4Jzu9Q70mhoiqkXI3!CPJ0>TQ{`mR&F67G*3s8w{3jRE2?j)+vlAVUd(MbW2@4N#F&p3+VkEpa1UL^~l?CA<*U{h8|a-r6C#VNFoO* zO)B@2#+t)q+Flb8^?G{lSH*qgi|%9&doQ;lIztFHU;1)EG zwZs?SuyJK)m$>n|oun5;8%D(496Ub8`+QkDQq{cbY2|Ub$n2fA^RssFYICe4YQwFv z6|N3}C{##xsF1`!(om*gvEQ z^v|@t?Ri-}wG8K!KRI|`(kWmNi`AY-JOTaMe(+bvbRo^=lTyKw2l}Vl3V^Yc*W?d0 ymhn)EWuzd>!8%P&ATr6%oa=n5Po|9nPb>O-$sFt34~jHLV}T?pF0wH~uKpKvqB-UO literal 0 HcmV?d00001 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/_media/logo.svg b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/_media/logo.svg new file mode 100644 index 000000000..6c748a479 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/_media/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/sidebar.json new file mode 100644 index 000000000..edc133661 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/members/opts-2/sidebar.json @@ -0,0 +1,147 @@ +[ + { + "title": "Enumerations", + "children": [ + { + "title": "CommentEnum", + "kind": 8, + "path": "Enumeration.CommentEnum.md" + }, + { + "title": "EnumMembersTable", + "kind": 8, + "path": "Enumeration.EnumMembersTable.md" + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "BaseClassProperties", + "kind": 128, + "path": "Class.BaseClassProperties.md" + }, + { + "title": "ClassPropertiesTable", + "kind": 128, + "path": "Class.ClassPropertiesTable.md" + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "BaseInterfaceProperties", + "kind": 256, + "path": "Interface.BaseInterfaceProperties.md" + }, + { + "title": "CommentInterface", + "kind": 256, + "path": "Interface.CommentInterface.md" + }, + { + "title": "CommentInterfaceExtended", + "kind": 256, + "path": "Interface.CommentInterfaceExtended.md" + }, + { + "title": "InterfacePropertiesTable", + "kind": 256, + "path": "Interface.InterfacePropertiesTable.md" + }, + { + "title": "SameName", + "kind": 256, + "path": "Interface.SameName.md" + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeDeclarationTable", + "kind": 2097152, + "path": "TypeAlias.TypeDeclarationTable.md" + }, + { + "title": "typeWithBlockTags", + "kind": 2097152, + "path": "TypeAlias.typeWithBlockTags.md" + }, + { + "title": "TypeWithGenerics", + "kind": 2097152, + "path": "TypeAlias.TypeWithGenerics.md" + } + ] + }, + { + "title": "Variables", + "children": [ + { + "title": "_prop_with_underscore", + "kind": 32, + "path": "Variable._prop_with_underscore.md" + }, + { + "title": "prop", + "kind": 32, + "path": "Variable.prop.md" + }, + { + "title": "propb", + "kind": 32, + "path": "Variable.propb.md" + }, + { + "title": "SameName", + "kind": 32, + "path": "Variable.SameName.md" + }, + { + "title": "TypeDeclarationTable", + "kind": 32, + "path": "Variable.TypeDeclarationTable.md" + } + ] + }, + { + "title": "Functions", + "children": [ + { + "title": "constFunction", + "kind": 64, + "path": "Function.constFunction.md" + }, + { + "title": "constFunctionWithReturns", + "kind": 64, + "path": "Function.constFunctionWithReturns.md" + }, + { + "title": "functionWithBlockTags", + "kind": 64, + "path": "Function.functionWithBlockTags.md" + }, + { + "title": "multipleExampleTags", + "kind": 64, + "path": "Function.multipleExampleTags.md" + }, + { + "title": "parametersTable", + "kind": 64, + "path": "Function.parametersTable.md" + }, + { + "title": "singleExampleTag", + "kind": 64, + "path": "Function.singleExampleTag.md" + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/README.md new file mode 100644 index 000000000..0d25ad23d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/README.md @@ -0,0 +1,657 @@ +# typedoc-stubs + +Comments form module comments + +> links + +Links using `{@link}` inline tags. + +- [CommentInterface](README.md#commentinterface) - Links to CommentInterface +- [Links to CommentInterface.prop](README.md#prop) +- [Links to CommentInterface.propb](README.md#propb-1) +- [CommentEnum.MemberB](README.md#commentenum) +- [SameName:var](README.md#samename-1) +- [SameName:interface](README.md#samename) +- [SameName.prop](README.md#prop-2) +- [prop:var](README.md#prop-3) +- [_prop_with_underscore:var](README.md#_prop_with_underscore) +- [TypeWithGenerics](README.md#typewithgenericsc-d) + +External links: + +- [Google](https://www.google.com) +- [`https://www.google.com`](https://www.google.com) + +Relative Links: + +- [Relative Document](_media/PROJECT_DOC_1.md) +- [Relative Link](../../../groups/members/opts-1/index.md) + +Relative Image Links: + +Logo + +![Logo](_media/logo.svg) + +## See + + - Comments for a tag + - Comments for tag written on same line + +## Html And Jsx + +A in comments + +A `` in backticks + +Another object `{ x: 1 }`. + +
+ +
+ +Some random {{braces}}. + +``` +A in a code block +Some

html

inside codeblock +``` + +> codeBlocks + +```css +.class {color:red} +``` + +```html +
x
y +``` + +`single line {block}` + +## Enumerations + +### CommentEnum + +#### Enumeration Members + +| Enumeration Member | Value | Description | Source | +| ------ | ------ | ------ | ------ | +| `Member` | `0` | Comment for Member Some

html

and . **Deprecated** Deprecated member **See** [SameName](README.md#samename) | [index.ts:1](http://source-url) | +| `MemberB` | `1` | - | [index.ts:1](http://source-url) | + +*** + +### EnumMembersTable + +#### Enumeration Members + +| Enumeration Member | Value | Description | Source | +| ------ | ------ | ------ | ------ | +| `member1` | `"member1"` | The subroutine recursively parsed the hexadecimal data. | [index.ts:1](http://source-url) | + +## Classes + +### BaseClassProperties + +#### Extended by + +- [`ClassPropertiesTable`](README.md#classpropertiestable) + +#### Constructors + +##### new BaseClassProperties() + +> **new BaseClassProperties**(): [`BaseClassProperties`](README.md#baseclassproperties) + +###### Returns + +[`BaseClassProperties`](README.md#baseclassproperties) + +#### Properties + +| Property | Type | Description | Source | +| ------ | ------ | ------ | ------ | +| ~~`propA`~~ | `string` | **Deprecated** | [index.ts:1](http://source-url) | +| `propB` | `string` | - | [index.ts:1](http://source-url) | + +*** + +### ClassPropertiesTable + +#### Extends + +- [`BaseClassProperties`](README.md#baseclassproperties) + +#### Constructors + +##### new ClassPropertiesTable() + +> **new ClassPropertiesTable**(): [`ClassPropertiesTable`](README.md#classpropertiestable) + +###### Returns + +[`ClassPropertiesTable`](README.md#classpropertiestable) + +###### Inherited from + +[`BaseClassProperties`](README.md#baseclassproperties).[`constructor`](README.md#constructors) + +#### Properties + +| Property | Modifier | Type | Default value | Description | Overrides | Inherited from | Source | +| ------ | ------ | ------ | ------ | ------ | ------ | ------ | ------ | +| `prop1` | `private` | `boolean` | `undefined` | The subroutine recursively parsed the hexadecimal data. to generate the binary output for input validation. | - | - | [index.ts:1](http://source-url) | +| `prop2` | `readonly` | `RegExp` | `undefined` | Below is a breakdown of the notable performances: - The CPU executed the instruction set in parallel with the GPU computations. - The RAM efficiently cached the frequently accessed data for faster retrieval. - The SSD accessed the stored files with lightning speed due to its high read/write capabilities. | - | - | [index.ts:1](http://source-url) | +| `prop3?` | `public` | `string` | `undefined` | > Example of Triple Code Block `def greet(name): print("Hello, " + name + "!")` | - | - | [index.ts:1](http://source-url) | +| ~~`propA`~~ | `public` | `string` | `'propAValue'` | **Deprecated** | [`BaseClassProperties`](README.md#baseclassproperties).`propA` | - | [index.ts:1](http://source-url) | +| `propB` | `public` | `string` | `undefined` | - | - | [`BaseClassProperties`](README.md#baseclassproperties).`propB` | [index.ts:1](http://source-url) | +| `propWithFlag` | `public` | `string` | `undefined` | **`Experimental`** Experimental flag comments | - | - | [index.ts:1](http://source-url) | + +## Interfaces + +### BaseInterfaceProperties + +#### Extended by + +- [`InterfacePropertiesTable`](README.md#interfacepropertiestable) + +#### Properties + +##### ~~propA~~ + +> **propA**: `string` + +###### Deprecated + +###### Source + +[index.ts:1](http://source-url) + +##### propB + +> **propB**: `string` + +###### Source + +[index.ts:1](http://source-url) + +*** + +### CommentInterface + +#### Extended by + +- [`CommentInterfaceExtended`](README.md#commentinterfaceextended) + +#### Properties + +##### prop + +> **prop**: `string` + +###### Source + +[index.ts:1](http://source-url) + +##### propb + +> **propb**: `string` + +###### Source + +[index.ts:1](http://source-url) + +*** + +### CommentInterfaceExtended + +#### Extends + +- [`CommentInterface`](README.md#commentinterface) + +#### Properties + +##### prop + +> **prop**: `string` + +###### Inherited from + +[`CommentInterface`](README.md#commentinterface).[`prop`](README.md#prop) + +###### Source + +[index.ts:1](http://source-url) + +##### propb + +> **propb**: `string` + +###### Inherited from + +[`CommentInterface`](README.md#commentinterface).[`propb`](README.md#propb-1) + +###### Source + +[index.ts:1](http://source-url) + +##### propc + +> **propc**: `string` + +###### Source + +[index.ts:1](http://source-url) + +*** + +### InterfacePropertiesTable + +#### Extends + +- [`BaseInterfaceProperties`](README.md#baseinterfaceproperties) + +#### Properties + +##### prop1 + +> **prop1**: `boolean` + +The subroutine recursively parsed the hexadecimal data. +to generate the binary output for input validation. + +###### Source + +[index.ts:1](http://source-url) + +##### prop2 + +> **prop2**: `RegExp` + +Below is a breakdown of the notable performances: + +- The CPU executed the instruction set in parallel with the GPU computations. +- The RAM efficiently cached the frequently accessed data for faster retrieval. +- The SSD accessed the stored files with lightning speed due to its high read/write capabilities. + +###### Source + +[index.ts:1](http://source-url) + +##### prop3? + +> `optional` **prop3**: `string` + +> Example of Triple Code Block + +```ts +def greet(name): +print("Hello, " + name + "!") +``` + +###### Source + +[index.ts:1](http://source-url) + +##### prop4 + +> **prop4**: `object` + +| Name | Type | Source | +| ------ | ------ | ------ | +| `a` | `string` | [index.ts:1](http://source-url) | +| `b` | `string` | [index.ts:1](http://source-url) | + +###### Source + +[index.ts:1](http://source-url) + +##### ~~propA~~ + +> **propA**: `string` + +###### Deprecated + +###### Inherited from + +[`BaseInterfaceProperties`](README.md#baseinterfaceproperties).[`propA`](README.md#propa) + +###### Source + +[index.ts:1](http://source-url) + +##### propB + +> **propB**: `string` + +###### Inherited from + +[`BaseInterfaceProperties`](README.md#baseinterfaceproperties).[`propB`](README.md#propb) + +###### Source + +[index.ts:1](http://source-url) + +*** + +### SameName + +#### Properties + +##### prop + +> **prop**: `string` + +###### Source + +[index.ts:1](http://source-url) + +##### propb + +> **propb**: `string` + +###### Source + +[index.ts:1](http://source-url) + +## Type Aliases + +### TypeDeclarationTable + +> **TypeDeclarationTable**: `object` + +#### Type declaration + +| Name | Type | Description | Source | +| ------ | ------ | ------ | ------ | +| `declaration1` | `boolean` | The subroutine recursively parsed the hexadecimal data. to generate the binary output for input validation. | [index.ts:1](http://source-url) | +| `declaration2` | `boolean` | The subroutine recursively parsed the hexadecimal data. to generate the binary output for input validation. | [index.ts:1](http://source-url) | +| `declaration4` | `100` | - | [index.ts:1](http://source-url) | + +#### Source + +[index.ts:1](http://source-url) + +*** + +### typeWithBlockTags + +> **typeWithBlockTags**: `object` + +Variable with block tags summary + +#### Type declaration + +| Name | Type | Source | +| ------ | ------ | ------ | +| `x` | `string` | [index.ts:1](http://source-url) | + +#### Example + +```ts +const x = 1; +``` + +#### Remarks + +Other block tags + +#### Source + +[index.ts:1](http://source-url) + +*** + +### TypeWithGenerics\ + +> **TypeWithGenerics**\<`C`, `D`\>: `C` \| `D` + +#### Type Parameters + +| Type Parameter | +| ------ | +| `C` | +| `D` | + +#### Source + +[index.ts:1](http://source-url) + +## Variables + +### \_prop\_with\_underscore + +> `const` **\_prop\_with\_underscore**: `true` = `true` + +#### Source + +[index.ts:1](http://source-url) + +*** + +### prop + +> `const` **prop**: `true` = `true` + +#### Source + +[index.ts:1](http://source-url) + +*** + +### propb + +> `const` **propb**: `true` = `true` + +#### Source + +[index.ts:1](http://source-url) + +*** + +### SameName + +> **SameName**: `true` + +#### Source + +[index.ts:1](http://source-url) + +*** + +### TypeDeclarationTable + +> **TypeDeclarationTable**: `object` + +#### Type declaration + +| Name | Type | Default value | Source | +| ------ | ------ | ------ | ------ | +| `declaration1` | `string` | 'declaration3' | [index.ts:1](http://source-url) | +| `declaration2` | `number` | 100 | [index.ts:1](http://source-url) | + +#### Source + +[index.ts:1](http://source-url) + +## Functions + +### constFunction() + +> **constFunction**(`text`): `boolean` + +constFunction comments + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | Some param | + +#### Returns + +`boolean` + +#### Remarks + +Some remarks + +#### Source + +[index.ts:1](http://source-url) + +*** + +### constFunctionWithReturns() + +> **constFunctionWithReturns**(`text`): `boolean` + +constFunctionWithReturns comments + +#### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | Some param | + +#### Returns + +`boolean` + +Return comments + +#### Remarks + +Some remarks + +#### Source + +[index.ts:1](http://source-url) + +*** + +### functionWithBlockTags() + +> **functionWithBlockTags**(`x`, `y`): `void` + +Function with block tags summary + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x` | `string` | +| `y` | `string` | + +#### Returns + +`void` + +#### Example + +```ts +const x = 1; +``` + +#### See + +abc.com + +#### Remarks + +Other block tags + +#### Source + +[index.ts:1](http://source-url) + +*** + +### multipleExampleTags() + +> **multipleExampleTags**(): `boolean` + +Function with multiple example tags + +#### Returns + +`boolean` + +#### Examples + +```ts +// If there are no code blocks, TypeDoc assumes the whole tag +// should be a code block. This is not valid TSDoc, but is recognized +// by VSCode and enables better JSDoc support. + +factorial(1) +``` + +If there is a code block, then both TypeDoc and VSCode will treat +text outside of the code block as regular text. + +```ts +factorial(1) +``` + +#### Source + +[index.ts:1](http://source-url) + +*** + +### parametersTable() + +> **parametersTable**\<`T`\>(`param1`, `param2`, `param3`): `number` + +Adds two numbers together. + +#### Type Parameters + +| Type Parameter | Default type | Description | +| ------ | ------ | ------ | +| `T` | `string` | The type of the numbers to be added. | + +#### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `param1` | `number` | `undefined` | The first param to be added. | +| `param2` | `number` | `undefined` | The second param to be added. Some additional text for num2. | +| `param3` | `number` | `4` | The third param to be added. | + +#### Returns + +`number` + +#### Source + +[index.ts:1](http://source-url) + +*** + +### singleExampleTag() + +> **singleExampleTag**(): `boolean` + +Function with single example tag + +#### Returns + +`boolean` + +Return comments + +#### Example + +If there is a code block, then both TypeDoc and VSCode will treat +text outside of the code block as regular text. + +```ts +factorial(1) +``` + +#### Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/_media/PROJECT_DOC_1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/_media/PROJECT_DOC_1.md new file mode 100644 index 000000000..5a3c556b5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/_media/PROJECT_DOC_1.md @@ -0,0 +1,8 @@ +--- +title: 'Project Document 1' +description: 'A description of the document' +--- + +## Project Document 1 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/_media/logo.png b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/_media/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..120c55ad67864cc4ef9a0231ebe19d718878ae36 GIT binary patch literal 1294 zcmc(eYg1Ea6oucDle-X)Tr}c9P7qLvK&lwLq!T zML@+G)IcPST;vXEwH<6i0jZ)wg-+2KC8!00mmuIEDt#OKC;DOS_3Zs=&ze~$q;Vo= zrUw%M;4BeGCODkOAAAjKvJP-bVa9^|2GdSIEl``1> zaHwyd(EE(oOSg4d^-gx{Znqnmi+)$J26CB?kJD^L=u8;}I^Mp>gqOOYjs!HCD8jR4$g+?8`at>Dc!Ri25eG1m{V66t$g}}O8Sg(Q&>tUk;Hig0F zG}y8kw(f#$BG{G)f86ph6OE-;=7=d+l@PZL01U%$9Ovj(g;R+*_!#; zO;NRmD~}#2{E~(asTV$0J^VS?f~*5H`Bi&v#Y7>hq^`D8@$P^tUjbwBp~eue(@vZu z4=1ei5N|2{w3_3-lx*Gjk7^77_saaU_JZ0}{`LvR^$m-sGed=|>u)D4Aq368)c{3Im_JAcW&J(O91?Am*aUYyk6DJj9Ww`WsC|I|=`Ofzs zfn1%4N=4a?b;zxL-QFkiexu?FxiP zpSQ&TpBnX~J5Ftu#O5%;EJpcbA6QGoGJ6M5wq|_h4RC3kMmExFkh6YCvaMkD;v!8l z!Utgqb0X0~jNCDB4N=aDv6KaDbSTXvI4peD({dnr_sboW6uiJtQ^c2~>q8!v?P;Kl zaH;Mm@KzU}XK>Tz<{bXjyRYWe>$`VV4LNgZmRPT0WSLfrT9^O*L#eC$w}66%o-y>g zM4Jzu9Q70mhoiqkXI3!CPJ0>TQ{`mR&F67G*3s8w{3jRE2?j)+vlAVUd(MbW2@4N#F&p3+VkEpa1UL^~l?CA<*U{h8|a-r6C#VNFoO* zO)B@2#+t)q+Flb8^?G{lSH*qgi|%9&doQ;lIztFHU;1)EG zwZs?SuyJK)m$>n|oun5;8%D(496Ub8`+QkDQq{cbY2|Ub$n2fA^RssFYICe4YQwFv z6|N3}C{##xsF1`!(om*gvEQ z^v|@t?Ri-}wG8K!KRI|`(kWmNi`AY-JOTaMe(+bvbRo^=lTyKw2l}Vl3V^Yc*W?d0 ymhn)EWuzd>!8%P&ATr6%oa=n5Po|9nPb>O-$sFt34~jHLV}T?pF0wH~uKpKvqB-UO literal 0 HcmV?d00001 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/_media/logo.svg b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/_media/logo.svg new file mode 100644 index 000000000..6c748a479 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/_media/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/sidebar.json new file mode 100644 index 000000000..0637a088a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-1/sidebar.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/README.md new file mode 100644 index 000000000..81595cdaf --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/README.md @@ -0,0 +1,1398 @@ +# typedoc-stubs + +Comments form module comments + +> links + +Links using `{@link}` inline tags. + +- [CommentInterface](https://example.com/README.md#CommentInterface) - Links to CommentInterface +- [Links to CommentInterface.prop](https://example.com/README.md#prop) +- [Links to CommentInterface.propb](https://example.com/README.md#propb) +- [CommentEnum.MemberB](https://example.com/README.md#MemberB) +- [SameName:var](https://example.com/README.md#SameName-1) +- [SameName:interface](https://example.com/README.md#SameName) +- [SameName.prop](https://example.com/README.md#prop-2) +- [prop:var](https://example.com/README.md#prop-3) +- [_prop_with_underscore:var](https://example.com/README.md#_prop_with_underscore) +- [TypeWithGenerics](https://example.com/README.md#TypeWithGenericsC-D) + +External links: + +- [Google](https://www.google.com) +- [`https://www.google.com`](https://www.google.com) + +Relative Links: + +- [Relative Document](https://example.com/_media/PROJECT_DOC_1.md) +- [Relative Link](../../../groups/members/opts-1/index.md) + +Relative Image Links: + +\Logo + +![Logo](https://example.com/_media/logo.svg) + +## See + + - Comments for a tag + - Comments for tag written on same line + +## Html And Jsx + +A \\ in comments + +A `` in backticks + +Another object `{ x: 1 }`. + +\
+ \ +\ + +Some random \{\{braces\}\}. + +``` +A in a code block +Some

html

inside codeblock +``` + +> codeBlocks + +```css +.class {color:red} +``` + +```html +
x
y +``` + +`single line {block}` + +## Enumerations + + + +### CommentEnum + +#### Enumeration Members + + + + + + + + + + + + + + + + + + + + + +
Enumeration MemberValueDescription
+ + `Member` + + + +`0` + + + +Comment for Member + +Some \ html \ and \\. + +**Deprecated** + +Deprecated member + +**See** + +[SameName](https://example.com/README.md#SameName) + +
+ + `MemberB` + + + +`1` + + + +‐ + +
+ +*** + + + +### EnumMembersTable + +#### Enumeration Members + + + + + + + + + + + + + + + + +
Enumeration MemberValueDescription
+ + `member1` + + + +`"member1"` + + + +The subroutine recursively parsed the hexadecimal data. + +
+ +## Classes + + + +### BaseClassProperties + +#### Extended by + +- [`ClassPropertiesTable`](https://example.com/README.md#ClassPropertiesTable) + +#### Constructors + + + +##### new BaseClassProperties() + +> **new BaseClassProperties**(): [`BaseClassProperties`](https://example.com/README.md#BaseClassProperties) + +###### Returns + +[`BaseClassProperties`](https://example.com/README.md#BaseClassProperties) + +#### Properties + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescription
+ + ~~`propA`~~ + + + +`string` + + + +**Deprecated** + +
+ + `propB` + + + +`string` + + + +‐ + +
+ +*** + + + +### ClassPropertiesTable + +#### Extends + +- [`BaseClassProperties`](https://example.com/README.md#BaseClassProperties) + +#### Constructors + + + +##### new ClassPropertiesTable() + +> **new ClassPropertiesTable**(): [`ClassPropertiesTable`](https://example.com/README.md#ClassPropertiesTable) + +###### Returns + +[`ClassPropertiesTable`](https://example.com/README.md#ClassPropertiesTable) + +###### Inherited from + +[`BaseClassProperties`](https://example.com/README.md#BaseClassProperties).[`constructor`](https://example.com/README.md#Constructors) + +#### Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescription
+ + `prop1` + + + +`boolean` + + + +The subroutine recursively parsed the hexadecimal data. +to generate the binary output for input validation. + +
+ + `prop2` + + + +`RegExp` + + + +Below is a breakdown of the notable performances: + +- The CPU executed the instruction set in parallel with the GPU computations. +- The RAM efficiently cached the frequently accessed data for faster retrieval. +- The SSD accessed the stored files with lightning speed due to its high read/write capabilities. + +
+ + `prop3?` + + + +`string` + + + +> Example of Triple Code Block + +```ts +def greet(name): +print("Hello, " + name + "!") +``` + +
+ + ~~`propA`~~ + + + +`string` + + + +**Deprecated** + +
+ + `propB` + + + +`string` + + + +‐ + +
+ + `propWithFlag` + + + +`string` + + + +**`Experimental`** + +Experimental flag comments + +
+ +## Interfaces + + + +### BaseInterfaceProperties + +#### Extended by + +- [`InterfacePropertiesTable`](https://example.com/README.md#InterfacePropertiesTable) + +#### Properties + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescription
+ + ~~`propA`~~ + + + +`string` + + + +**Deprecated** + +
+ + `propB` + + + +`string` + + + +‐ + +
+ +*** + + + +### CommentInterface + +#### Extended by + +- [`CommentInterfaceExtended`](https://example.com/README.md#CommentInterfaceExtended) + +#### Properties + + + + + + + + + + + + + + + + + + +
PropertyType
+ + `prop` + + + +`string` + +
+ + `propb` + + + +`string` + +
+ +*** + + + +### CommentInterfaceExtended + +#### Extends + +- [`CommentInterface`](https://example.com/README.md#CommentInterface) + +#### Properties + + + + + + + + + + + + + + + + + + + + + + +
PropertyType
+ + `prop` + + + +`string` + +
+ + `propb` + + + +`string` + +
+ + `propc` + + + +`string` + +
+ +*** + + + +### InterfacePropertiesTable + +#### Extends + +- [`BaseInterfaceProperties`](https://example.com/README.md#BaseInterfaceProperties) + +#### Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyTypeDescription
+ + `prop1` + + + +`boolean` + + + +The subroutine recursively parsed the hexadecimal data. +to generate the binary output for input validation. + +
+ + `prop2` + + + +`RegExp` + + + +Below is a breakdown of the notable performances: + +- The CPU executed the instruction set in parallel with the GPU computations. +- The RAM efficiently cached the frequently accessed data for faster retrieval. +- The SSD accessed the stored files with lightning speed due to its high read/write capabilities. + +
+ + `prop3?` + + + +`string` + + + +> Example of Triple Code Block + +```ts +def greet(name): +print("Hello, " + name + "!") +``` + +
+ + `prop4` + + + +\{`a`: `string`;`b`: `string`; \} + + + +‐ + +
+ + `prop4.a` + + + +`string` + + + +‐ + +
+ + `prop4.b` + + + +`string` + + + +‐ + +
+ + ~~`propA`~~ + + + +`string` + + + +**Deprecated** + +
+ + `propB` + + + +`string` + + + +‐ + +
+ +*** + + + +### SameName + +#### Properties + + + + + + + + + + + + + + + + + + +
PropertyType
+ + `prop` + + + +`string` + +
+ + `propb` + + + +`string` + +
+ +## Type Aliases + + + +### TypeDeclarationTable + +> **TypeDeclarationTable**: \{`declaration1`: `boolean`;`declaration2`: `boolean`;`declaration4`: `100`; \} + +#### Type declaration + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
+ +`declaration1` + + + +`boolean` + + + +The subroutine recursively parsed the hexadecimal data. +to generate the binary output for input validation. + +
+ +`declaration2` + + + +`boolean` + + + +The subroutine recursively parsed the hexadecimal data. +to generate the binary output for input validation. + +
+ +`declaration4` + + + +`100` + + + +‐ + +
+ +#### Source + +[index.ts:1](http://source-url) + +*** + + + +### typeWithBlockTags + +> **typeWithBlockTags**: \{`x`: `string`; \} + +Variable with block tags summary + +#### Example + +```ts +const x = 1; +``` + +#### Type declaration + + + + + + + + + + + + + + +
NameType
+ +`x` + + + +`string` + +
+ +#### Remarks + +Other block tags + +#### Source + +[index.ts:1](http://source-url) + +*** + + + +### TypeWithGenerics\ + +> **TypeWithGenerics**\<`C`, `D`\>: `C` \| `D` + +#### Type Parameters + + + + + + + + + + + + + + + +
Type Parameter
+ +`C` + +
+ +`D` + +
+ +#### Source + +[index.ts:1](http://source-url) + +## Variables + + + +### \_prop\_with\_underscore + +> `const` **\_prop\_with\_underscore**: `true` = `true` + +#### Source + +[index.ts:1](http://source-url) + +*** + + + +### prop + +> `const` **prop**: `true` = `true` + +#### Source + +[index.ts:1](http://source-url) + +*** + + + +### propb + +> `const` **propb**: `true` = `true` + +#### Source + +[index.ts:1](http://source-url) + +*** + + + +### SameName + +> **SameName**: `true` + +#### Source + +[index.ts:1](http://source-url) + +*** + + + +### TypeDeclarationTable + +> **TypeDeclarationTable**: \{`declaration1`: `string`;`declaration2`: `number`; \} + +#### Type declaration + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault value
+ +`declaration1` + + + +`string` + + + +'declaration3' + +
+ +`declaration2` + + + +`number` + + + +100 + +
+ +#### Source + +[index.ts:1](http://source-url) + +## Functions + + + +### constFunction() + +> **constFunction**(`text`): `boolean` + +constFunction comments + +#### Parameters + + + + + + + + + + + + + + + + +
ParameterTypeDescription
+ +`text` + + + +`string` + + + +Some param + +
+ +#### Returns + +`boolean` + +#### Remarks + +Some remarks + +#### Source + +[index.ts:1](http://source-url) + +*** + + + +### constFunctionWithReturns() + +> **constFunctionWithReturns**(`text`): `boolean` + +constFunctionWithReturns comments + +#### Parameters + + + + + + + + + + + + + + + + +
ParameterTypeDescription
+ +`text` + + + +`string` + + + +Some param + +
+ +#### Returns + +`boolean` + +Return comments + +#### Remarks + +Some remarks + +#### Source + +[index.ts:1](http://source-url) + +*** + + + +### functionWithBlockTags() + +> **functionWithBlockTags**(`x`, `y`): `void` + +Function with block tags summary + +#### Example + +```ts +const x = 1; +``` + +#### Parameters + + + + + + + + + + + + + + + + + + +
ParameterType
+ +`x` + + + +`string` + +
+ +`y` + + + +`string` + +
+ +#### Returns + +`void` + +#### See + +abc.com + +#### Remarks + +Other block tags + +#### Source + +[index.ts:1](http://source-url) + +*** + + + +### multipleExampleTags() + +> **multipleExampleTags**(): `boolean` + +Function with multiple example tags + +#### Returns + +`boolean` + +#### Examples + +```ts +// If there are no code blocks, TypeDoc assumes the whole tag +// should be a code block. This is not valid TSDoc, but is recognized +// by VSCode and enables better JSDoc support. + +factorial(1) +``` + +If there is a code block, then both TypeDoc and VSCode will treat +text outside of the code block as regular text. + +```ts +factorial(1) +``` + +#### Source + +[index.ts:1](http://source-url) + +*** + + + +### parametersTable() + +> **parametersTable**\<`T`\>(`param1`, `param2`, `param3`): `number` + +Adds two numbers together. + +#### Type Parameters + + + + + + + + + + + + + + +
Type ParameterDescription
+ +`T` + + + +The type of the numbers to be added. + +
+ +#### Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeDescription
+ +`param1` + + + +`number` + + + +The first param +to be added. + +
+ +`param2` + + + +`number` + + + +The second param to be added. + +Some additional text for num2. + +
+ +`param3` + + + +`number` + + + +The third param to be added. + +
+ +#### Returns + +`number` + +#### Source + +[index.ts:1](http://source-url) + +*** + + + +### singleExampleTag() + +> **singleExampleTag**(): `boolean` + +Function with single example tag + +#### Example + +If there is a code block, then both TypeDoc and VSCode will treat +text outside of the code block as regular text. + +```ts +factorial(1) +``` + +#### Returns + +`boolean` + +Return comments + +#### Source + +[index.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/_media/PROJECT_DOC_1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/_media/PROJECT_DOC_1.md new file mode 100644 index 000000000..5a3c556b5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/_media/PROJECT_DOC_1.md @@ -0,0 +1,8 @@ +--- +title: 'Project Document 1' +description: 'A description of the document' +--- + +## Project Document 1 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/_media/logo.png b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/_media/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..120c55ad67864cc4ef9a0231ebe19d718878ae36 GIT binary patch literal 1294 zcmc(eYg1Ea6oucDle-X)Tr}c9P7qLvK&lwLq!T zML@+G)IcPST;vXEwH<6i0jZ)wg-+2KC8!00mmuIEDt#OKC;DOS_3Zs=&ze~$q;Vo= zrUw%M;4BeGCODkOAAAjKvJP-bVa9^|2GdSIEl``1> zaHwyd(EE(oOSg4d^-gx{Znqnmi+)$J26CB?kJD^L=u8;}I^Mp>gqOOYjs!HCD8jR4$g+?8`at>Dc!Ri25eG1m{V66t$g}}O8Sg(Q&>tUk;Hig0F zG}y8kw(f#$BG{G)f86ph6OE-;=7=d+l@PZL01U%$9Ovj(g;R+*_!#; zO;NRmD~}#2{E~(asTV$0J^VS?f~*5H`Bi&v#Y7>hq^`D8@$P^tUjbwBp~eue(@vZu z4=1ei5N|2{w3_3-lx*Gjk7^77_saaU_JZ0}{`LvR^$m-sGed=|>u)D4Aq368)c{3Im_JAcW&J(O91?Am*aUYyk6DJj9Ww`WsC|I|=`Ofzs zfn1%4N=4a?b;zxL-QFkiexu?FxiP zpSQ&TpBnX~J5Ftu#O5%;EJpcbA6QGoGJ6M5wq|_h4RC3kMmExFkh6YCvaMkD;v!8l z!Utgqb0X0~jNCDB4N=aDv6KaDbSTXvI4peD({dnr_sboW6uiJtQ^c2~>q8!v?P;Kl zaH;Mm@KzU}XK>Tz<{bXjyRYWe>$`VV4LNgZmRPT0WSLfrT9^O*L#eC$w}66%o-y>g zM4Jzu9Q70mhoiqkXI3!CPJ0>TQ{`mR&F67G*3s8w{3jRE2?j)+vlAVUd(MbW2@4N#F&p3+VkEpa1UL^~l?CA<*U{h8|a-r6C#VNFoO* zO)B@2#+t)q+Flb8^?G{lSH*qgi|%9&doQ;lIztFHU;1)EG zwZs?SuyJK)m$>n|oun5;8%D(496Ub8`+QkDQq{cbY2|Ub$n2fA^RssFYICe4YQwFv z6|N3}C{##xsF1`!(om*gvEQ z^v|@t?Ri-}wG8K!KRI|`(kWmNi`AY-JOTaMe(+bvbRo^=lTyKw2l}Vl3V^Yc*W?d0 ymhn)EWuzd>!8%P&ATr6%oa=n5Po|9nPb>O-$sFt34~jHLV}T?pF0wH~uKpKvqB-UO literal 0 HcmV?d00001 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/_media/logo.svg b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/_media/logo.svg new file mode 100644 index 000000000..6c748a479 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/_media/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/sidebar.json new file mode 100644 index 000000000..0637a088a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/comments/modules/opts-2/sidebar.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/README.md new file mode 100644 index 000000000..449ee24fd --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/README.md @@ -0,0 +1,25 @@ +PAGE_BEGIN +> `page.index.begin` hook + +
+ My logo + Welcome to typedoc-stubs with a customised header partial!! +
+ +# typedoc-stubs + +> `content.begin` hook + +Module commments + +**Experimental** `my-package` is under active development. + +Some other comments + +## Functions + +- [someFunction](functions/someFunction.md) + +> **Generated using `page.index.end` hook** + +PAGE_END diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/functions/someFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/functions/someFunction.md new file mode 100644 index 000000000..f06f1067d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/functions/someFunction.md @@ -0,0 +1,23 @@ +PAGE_BEGIN +> `page.begin` hook + +
+ My logo + Welcome to typedoc-stubs with a customised header partial!! +
+ +[typedoc-stubs](../README.md) / someFunction + +# Function: someFunction() + +> `content.begin` hook + +> **someFunction**(): `void` + +## Returns + +`void` + +**Generated using `page.end` hook** + +PAGE_END diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/post-render-async-job.txt b/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/post-render-async-job.txt new file mode 100644 index 000000000..7e47f9cad --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/post-render-async-job.txt @@ -0,0 +1 @@ +post-render-async-job success \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/pre-render-async-job.txt b/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/pre-render-async-job.txt new file mode 100644 index 000000000..f0869934f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/pre-render-async-job.txt @@ -0,0 +1 @@ +pre-render-async-job success \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/renderer-event-begin.txt b/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/renderer-event-begin.txt new file mode 100644 index 000000000..ca6e3a65e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/renderer-event-begin.txt @@ -0,0 +1 @@ +renderer-event-begin success \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/renderer-event-end.txt b/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/renderer-event-end.txt new file mode 100644 index 000000000..449405128 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/renderer-event-end.txt @@ -0,0 +1 @@ +renderer-event-end success \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/sidebar.json new file mode 100644 index 000000000..4980abdda --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/customize/members/opts-1/sidebar.json @@ -0,0 +1,12 @@ +[ + { + "title": "Functions", + "children": [ + { + "title": "someFunction", + "kind": 64, + "path": "functions/someFunction.md" + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/README.md new file mode 100644 index 000000000..83eb0a240 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/README.md @@ -0,0 +1,36 @@ +[typedoc-stubs](../README.md) / ModuleWithDocuments1 + +# ModuleWithDocuments1 + +## Documents + +- [MODULE\_DOC](documents/MODULE_DOC.md) + +## Namespaces + +- [NamespaceWithDocuments](namespaces/NamespaceWithDocuments/README.md) + +## Enumerations + +- [EnumWithDocuments](enumerations/EnumWithDocuments.md) + +## Classes + +- [ClassWithDocuments](classes/ClassWithDocuments.md) + +## Interfaces + +- [InterfaceWithDocuments](interfaces/InterfaceWithDocuments.md) + +## Type Aliases + +- [TypeWithDocuments](type-aliases/TypeWithDocuments.md) + +## Variables + +- [variableWithDocuments](variables/variableWithDocuments.md) + +## Functions + +- [functionWithDocuments](functions/functionWithDocuments.md) +- [multipleFunctionWithDocuments](functions/multipleFunctionWithDocuments.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/classes/ClassWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/classes/ClassWithDocuments.md new file mode 100644 index 000000000..1783eafea --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/classes/ClassWithDocuments.md @@ -0,0 +1,11 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / ClassWithDocuments + +# Class: ClassWithDocuments + +## Documents + +- [CLASS\_DOC](documents/CLASS_DOC.md) + +## Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/classes/documents/CLASS_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/classes/documents/CLASS_DOC.md new file mode 100644 index 000000000..108646210 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/classes/documents/CLASS_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [ClassWithDocuments](../ClassWithDocuments.md) / CLASS\_DOC + +> Class Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/documents/MODULE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/documents/MODULE_DOC.md new file mode 100644 index 000000000..d6ea144e7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/documents/MODULE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / MODULE\_DOC + +> Module Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/enumerations/EnumWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/enumerations/EnumWithDocuments.md new file mode 100644 index 000000000..118e6f629 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/enumerations/EnumWithDocuments.md @@ -0,0 +1,13 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / EnumWithDocuments + +# Enumeration: EnumWithDocuments + +## Documents + +- [ENUM\_DOC](documents/ENUM_DOC.md) + +## Enumeration Members + +### EnumMember + +_DECLARATION_TITLE_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/enumerations/documents/ENUM_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/enumerations/documents/ENUM_DOC.md new file mode 100644 index 000000000..977641737 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/enumerations/documents/ENUM_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [EnumWithDocuments](../EnumWithDocuments.md) / ENUM\_DOC + +> Enum Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_1.md new file mode 100644 index 000000000..16a0aea49 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [multipleFunctionWithDocuments](../multipleFunctionWithDocuments.md) / FUNCTION\_DOC\_1 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_2.md new file mode 100644 index 000000000..f2896d520 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_2.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [multipleFunctionWithDocuments](../multipleFunctionWithDocuments.md) / FUNCTION\_DOC\_2 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_3.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_3.md new file mode 100644 index 000000000..d7ab672f0 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_3.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [multipleFunctionWithDocuments](../multipleFunctionWithDocuments.md) / FUNCTION\_DOC\_3 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/functionWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/functionWithDocuments.md new file mode 100644 index 000000000..ea7b41223 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/functionWithDocuments.md @@ -0,0 +1,13 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / functionWithDocuments + +# Function: functionWithDocuments() + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for functionWithDocuments + +## Documents + +- [FUNCTION\_DOC\_1](documents/FUNCTION_DOC_1.md) + +_SIGNATURE_RETURNS_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/multipleFunctionWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/multipleFunctionWithDocuments.md new file mode 100644 index 000000000..bec3fa11d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/functions/multipleFunctionWithDocuments.md @@ -0,0 +1,35 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / multipleFunctionWithDocuments + +# Function: multipleFunctionWithDocuments() + +Comments for multipleFunctionWithDocuments + +## Documents + +- [FUNCTION\_DOC\_3](documents/FUNCTION_DOC_3.md) +- [FUNCTION\_DOC\_1](documents/FUNCTION_DOC_1.md) +- [FUNCTION\_DOC\_2](documents/FUNCTION_DOC_2.md) + +## Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsA + +### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ + +## Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsB + +### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/interfaces/InterfaceWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/interfaces/InterfaceWithDocuments.md new file mode 100644 index 000000000..71a35e667 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/interfaces/InterfaceWithDocuments.md @@ -0,0 +1,13 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / InterfaceWithDocuments + +# Interface: InterfaceWithDocuments + +## Documents + +- [INTERFACE\_DOC](documents/INTERFACE_DOC.md) + +## Properties + +### prop + +_DECLARATION_TITLE_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/interfaces/documents/INTERFACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/interfaces/documents/INTERFACE_DOC.md new file mode 100644 index 000000000..2250a3def --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/interfaces/documents/INTERFACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [InterfaceWithDocuments](../InterfaceWithDocuments.md) / INTERFACE\_DOC + +> Interface Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md new file mode 100644 index 000000000..070169d87 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md @@ -0,0 +1,11 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / NamespaceWithDocuments + +# NamespaceWithDocuments + +## Documents + +- [NAMESPACE\_DOC](documents/NAMESPACE_DOC.md) + +## Classes + +- [NamespaceClassWithDocuments](classes/NamespaceClassWithDocuments.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/NamespaceClassWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/NamespaceClassWithDocuments.md new file mode 100644 index 000000000..3f84f9d22 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/NamespaceClassWithDocuments.md @@ -0,0 +1,11 @@ +[typedoc-stubs](../../../../README.md) / [ModuleWithDocuments1](../../../README.md) / [NamespaceWithDocuments](../README.md) / NamespaceClassWithDocuments + +# Class: NamespaceClassWithDocuments + +## Documents + +- [CLASS\_DOC](documents/CLASS_DOC.md) + +## Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/documents/CLASS_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/documents/CLASS_DOC.md new file mode 100644 index 000000000..b25c1708c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/documents/CLASS_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../../../README.md) / [ModuleWithDocuments1](../../../../README.md) / [NamespaceWithDocuments](../../README.md) / [NamespaceClassWithDocuments](../NamespaceClassWithDocuments.md) / CLASS\_DOC + +> Class Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md new file mode 100644 index 000000000..a6fb21660 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../../README.md) / [ModuleWithDocuments1](../../../README.md) / [NamespaceWithDocuments](../README.md) / NAMESPACE\_DOC + +> Namespace Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/type-aliases/TypeWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/type-aliases/TypeWithDocuments.md new file mode 100644 index 000000000..410714de6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/type-aliases/TypeWithDocuments.md @@ -0,0 +1,9 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / TypeWithDocuments + +# Type Alias: TypeWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +## Documents + +- [TYPE\_DOC](documents/TYPE_DOC.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/type-aliases/documents/TYPE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/type-aliases/documents/TYPE_DOC.md new file mode 100644 index 000000000..771e62641 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/type-aliases/documents/TYPE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [TypeWithDocuments](../TypeWithDocuments.md) / TYPE\_DOC + +> Type Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/variables/documents/VARIABLE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/variables/documents/VARIABLE_DOC.md new file mode 100644 index 000000000..6623c4476 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/variables/documents/VARIABLE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [variableWithDocuments](../variableWithDocuments.md) / VARIABLE\_DOC + +> Variable Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/variables/variableWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/variables/variableWithDocuments.md new file mode 100644 index 000000000..2a047a6c9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments1/variables/variableWithDocuments.md @@ -0,0 +1,9 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / variableWithDocuments + +# Variable: variableWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +## Documents + +- [VARIABLE\_DOC](documents/VARIABLE_DOC.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/README.md new file mode 100644 index 000000000..fb9c28e4f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/README.md @@ -0,0 +1,32 @@ +[typedoc-stubs](../README.md) / ModuleWithDocuments2 + +# ModuleWithDocuments2 + +## Documents + +- [MODULE\_DOC](documents/MODULE_DOC.md) + +## Enumerations + +- [EnumWithDocuments](enumerations/EnumWithDocuments.md) + +## Classes + +- [ClassWithDocuments](classes/ClassWithDocuments.md) + +## Interfaces + +- [InterfaceWithDocuments](interfaces/InterfaceWithDocuments.md) + +## Type Aliases + +- [TypeWithDocuments](type-aliases/TypeWithDocuments.md) + +## Variables + +- [variableWithDocuments](variables/variableWithDocuments.md) + +## Functions + +- [functionWithDocuments](functions/functionWithDocuments.md) +- [multipleFunctionWithDocuments](functions/multipleFunctionWithDocuments.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/classes/ClassWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/classes/ClassWithDocuments.md new file mode 100644 index 000000000..e2802e751 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/classes/ClassWithDocuments.md @@ -0,0 +1,11 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments2](../README.md) / ClassWithDocuments + +# Class: ClassWithDocuments + +## Documents + +- [CLASS\_DOC](documents/CLASS_DOC.md) + +## Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/classes/documents/CLASS_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/classes/documents/CLASS_DOC.md new file mode 100644 index 000000000..fadf63c43 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/classes/documents/CLASS_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments2](../../README.md) / [ClassWithDocuments](../ClassWithDocuments.md) / CLASS\_DOC + +> Class Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/documents/MODULE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/documents/MODULE_DOC.md new file mode 100644 index 000000000..bad42e225 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/documents/MODULE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments2](../README.md) / MODULE\_DOC + +> Module Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/enumerations/EnumWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/enumerations/EnumWithDocuments.md new file mode 100644 index 000000000..2e289c72e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/enumerations/EnumWithDocuments.md @@ -0,0 +1,13 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments2](../README.md) / EnumWithDocuments + +# Enumeration: EnumWithDocuments + +## Documents + +- [ENUM\_DOC](documents/ENUM_DOC.md) + +## Enumeration Members + +### EnumMember + +_DECLARATION_TITLE_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/enumerations/documents/ENUM_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/enumerations/documents/ENUM_DOC.md new file mode 100644 index 000000000..f2a44d7a7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/enumerations/documents/ENUM_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments2](../../README.md) / [EnumWithDocuments](../EnumWithDocuments.md) / ENUM\_DOC + +> Enum Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/documents/FUNCTION_DOC_1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/documents/FUNCTION_DOC_1.md new file mode 100644 index 000000000..b0b90cbb0 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/documents/FUNCTION_DOC_1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments2](../../README.md) / [multipleFunctionWithDocuments](../multipleFunctionWithDocuments.md) / FUNCTION\_DOC\_1 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/documents/FUNCTION_DOC_2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/documents/FUNCTION_DOC_2.md new file mode 100644 index 000000000..6ec8dbe7b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/documents/FUNCTION_DOC_2.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments2](../../README.md) / [multipleFunctionWithDocuments](../multipleFunctionWithDocuments.md) / FUNCTION\_DOC\_2 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/documents/FUNCTION_DOC_3.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/documents/FUNCTION_DOC_3.md new file mode 100644 index 000000000..5ece5ec3f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/documents/FUNCTION_DOC_3.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments2](../../README.md) / [multipleFunctionWithDocuments](../multipleFunctionWithDocuments.md) / FUNCTION\_DOC\_3 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/functionWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/functionWithDocuments.md new file mode 100644 index 000000000..a67d9555f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/functionWithDocuments.md @@ -0,0 +1,13 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments2](../README.md) / functionWithDocuments + +# Function: functionWithDocuments() + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for functionWithDocuments + +## Documents + +- [FUNCTION\_DOC\_1](documents/FUNCTION_DOC_1.md) + +_SIGNATURE_RETURNS_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/multipleFunctionWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/multipleFunctionWithDocuments.md new file mode 100644 index 000000000..632d7f381 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/functions/multipleFunctionWithDocuments.md @@ -0,0 +1,35 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments2](../README.md) / multipleFunctionWithDocuments + +# Function: multipleFunctionWithDocuments() + +Comments for multipleFunctionWithDocuments + +## Documents + +- [FUNCTION\_DOC\_3](documents/FUNCTION_DOC_3.md) +- [FUNCTION\_DOC\_1](documents/FUNCTION_DOC_1.md) +- [FUNCTION\_DOC\_2](documents/FUNCTION_DOC_2.md) + +## Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsA + +### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ + +## Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsB + +### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/interfaces/InterfaceWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/interfaces/InterfaceWithDocuments.md new file mode 100644 index 000000000..5e0796b8b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/interfaces/InterfaceWithDocuments.md @@ -0,0 +1,13 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments2](../README.md) / InterfaceWithDocuments + +# Interface: InterfaceWithDocuments + +## Documents + +- [INTERFACE\_DOC](documents/INTERFACE_DOC.md) + +## Properties + +### prop + +_DECLARATION_TITLE_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/interfaces/documents/INTERFACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/interfaces/documents/INTERFACE_DOC.md new file mode 100644 index 000000000..13cb204f4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/interfaces/documents/INTERFACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments2](../../README.md) / [InterfaceWithDocuments](../InterfaceWithDocuments.md) / INTERFACE\_DOC + +> Interface Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/type-aliases/TypeWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/type-aliases/TypeWithDocuments.md new file mode 100644 index 000000000..5aca1044c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/type-aliases/TypeWithDocuments.md @@ -0,0 +1,9 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments2](../README.md) / TypeWithDocuments + +# Type Alias: TypeWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +## Documents + +- [TYPE\_DOC](documents/TYPE_DOC.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/type-aliases/documents/TYPE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/type-aliases/documents/TYPE_DOC.md new file mode 100644 index 000000000..c1c4cb9c3 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/type-aliases/documents/TYPE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments2](../../README.md) / [TypeWithDocuments](../TypeWithDocuments.md) / TYPE\_DOC + +> Type Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/variables/documents/VARIABLE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/variables/documents/VARIABLE_DOC.md new file mode 100644 index 000000000..87e58de1a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/variables/documents/VARIABLE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments2](../../README.md) / [variableWithDocuments](../variableWithDocuments.md) / VARIABLE\_DOC + +> Variable Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/variables/variableWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/variables/variableWithDocuments.md new file mode 100644 index 000000000..2ebba4b51 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/ModuleWithDocuments2/variables/variableWithDocuments.md @@ -0,0 +1,9 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments2](../README.md) / variableWithDocuments + +# Variable: variableWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +## Documents + +- [VARIABLE\_DOC](documents/VARIABLE_DOC.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/README.md new file mode 100644 index 000000000..111eeea02 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/README.md @@ -0,0 +1,12 @@ +# typedoc-stubs + +## Documents + +- [Project Document 1](documents/Project-Document-1.md) +- [docs/project/PROJECT\_DOC\_2](documents/docs/project/PROJECT_DOC_2.md) +- [docs/project/PROJECT\_DOC\_3](documents/docs/project/PROJECT_DOC_3.md) + +## Modules + +- [ModuleWithDocuments1](ModuleWithDocuments1/README.md) +- [ModuleWithDocuments2](ModuleWithDocuments2/README.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/documents/Project-Document-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/documents/Project-Document-1.md new file mode 100644 index 000000000..bee850405 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/documents/Project-Document-1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../README.md) / Project Document 1 + +## Project Document 1 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/documents/docs/project/PROJECT_DOC_2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/documents/docs/project/PROJECT_DOC_2.md new file mode 100644 index 000000000..01cc00688 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/documents/docs/project/PROJECT_DOC_2.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / docs/project/PROJECT\_DOC\_2 + +## Project Document 2 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/documents/docs/project/PROJECT_DOC_3.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/documents/docs/project/PROJECT_DOC_3.md new file mode 100644 index 000000000..9a398c908 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/documents/docs/project/PROJECT_DOC_3.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / docs/project/PROJECT\_DOC\_3 + +## Project Document 3 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/sidebar.json new file mode 100644 index 000000000..4ebd289b4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-1/sidebar.json @@ -0,0 +1,308 @@ +[ + { + "title": "Documents", + "children": [ + { + "title": "Project Document 1", + "kind": 8388608, + "path": "documents/Project-Document-1.md" + }, + { + "title": "docs/project/PROJECT_DOC_2", + "kind": 8388608, + "path": "documents/docs/project/PROJECT_DOC_2.md" + }, + { + "title": "docs/project/PROJECT_DOC_3", + "kind": 8388608, + "path": "documents/docs/project/PROJECT_DOC_3.md" + } + ] + }, + { + "title": "ModuleWithDocuments1", + "kind": 2, + "path": "ModuleWithDocuments1/README.md", + "children": [ + { + "title": "MODULE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/documents/MODULE_DOC.md" + }, + { + "title": "Namespaces", + "children": [ + { + "title": "NamespaceWithDocuments", + "kind": 4, + "path": "ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md", + "children": [ + { + "title": "NAMESPACE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md" + }, + { + "title": "Classes", + "children": [ + { + "title": "NamespaceClassWithDocuments", + "kind": 128, + "path": "ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/NamespaceClassWithDocuments.md", + "children": [ + { + "title": "CLASS_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/documents/CLASS_DOC.md" + } + ] + } + ] + } + ] + } + ] + }, + { + "title": "Enumerations", + "children": [ + { + "title": "EnumWithDocuments", + "kind": 8, + "path": "ModuleWithDocuments1/enumerations/EnumWithDocuments.md", + "children": [ + { + "title": "ENUM_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/enumerations/documents/ENUM_DOC.md" + } + ] + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassWithDocuments", + "kind": 128, + "path": "ModuleWithDocuments1/classes/ClassWithDocuments.md", + "children": [ + { + "title": "CLASS_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/classes/documents/CLASS_DOC.md" + } + ] + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceWithDocuments", + "kind": 256, + "path": "ModuleWithDocuments1/interfaces/InterfaceWithDocuments.md", + "children": [ + { + "title": "INTERFACE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/interfaces/documents/INTERFACE_DOC.md" + } + ] + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeWithDocuments", + "kind": 2097152, + "path": "ModuleWithDocuments1/type-aliases/TypeWithDocuments.md", + "children": [ + { + "title": "TYPE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/type-aliases/documents/TYPE_DOC.md" + } + ] + } + ] + }, + { + "title": "Variables", + "children": [ + { + "title": "variableWithDocuments", + "kind": 32, + "path": "ModuleWithDocuments1/variables/variableWithDocuments.md", + "children": [ + { + "title": "VARIABLE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/variables/documents/VARIABLE_DOC.md" + } + ] + } + ] + }, + { + "title": "Functions", + "children": [ + { + "title": "functionWithDocuments", + "kind": 64, + "path": "ModuleWithDocuments1/functions/functionWithDocuments.md", + "children": [ + { + "title": "FUNCTION_DOC_1", + "kind": 8388608, + "path": "ModuleWithDocuments1/functions/documents/FUNCTION_DOC_1.md" + } + ] + }, + { + "title": "multipleFunctionWithDocuments", + "kind": 64, + "path": "ModuleWithDocuments1/functions/multipleFunctionWithDocuments.md", + "children": [ + { + "title": "FUNCTION_DOC_3", + "kind": 8388608, + "path": "ModuleWithDocuments1/functions/documents/FUNCTION_DOC_3.md" + } + ] + } + ] + } + ] + }, + { + "title": "ModuleWithDocuments2", + "kind": 2, + "path": "ModuleWithDocuments2/README.md", + "children": [ + { + "title": "MODULE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments2/documents/MODULE_DOC.md" + }, + { + "title": "Enumerations", + "children": [ + { + "title": "EnumWithDocuments", + "kind": 8, + "path": "ModuleWithDocuments2/enumerations/EnumWithDocuments.md", + "children": [ + { + "title": "ENUM_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments2/enumerations/documents/ENUM_DOC.md" + } + ] + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassWithDocuments", + "kind": 128, + "path": "ModuleWithDocuments2/classes/ClassWithDocuments.md", + "children": [ + { + "title": "CLASS_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments2/classes/documents/CLASS_DOC.md" + } + ] + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceWithDocuments", + "kind": 256, + "path": "ModuleWithDocuments2/interfaces/InterfaceWithDocuments.md", + "children": [ + { + "title": "INTERFACE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments2/interfaces/documents/INTERFACE_DOC.md" + } + ] + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeWithDocuments", + "kind": 2097152, + "path": "ModuleWithDocuments2/type-aliases/TypeWithDocuments.md", + "children": [ + { + "title": "TYPE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments2/type-aliases/documents/TYPE_DOC.md" + } + ] + } + ] + }, + { + "title": "Variables", + "children": [ + { + "title": "variableWithDocuments", + "kind": 32, + "path": "ModuleWithDocuments2/variables/variableWithDocuments.md", + "children": [ + { + "title": "VARIABLE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments2/variables/documents/VARIABLE_DOC.md" + } + ] + } + ] + }, + { + "title": "Functions", + "children": [ + { + "title": "functionWithDocuments", + "kind": 64, + "path": "ModuleWithDocuments2/functions/functionWithDocuments.md", + "children": [ + { + "title": "FUNCTION_DOC_1", + "kind": 8388608, + "path": "ModuleWithDocuments2/functions/documents/FUNCTION_DOC_1.md" + } + ] + }, + { + "title": "multipleFunctionWithDocuments", + "kind": 64, + "path": "ModuleWithDocuments2/functions/multipleFunctionWithDocuments.md", + "children": [ + { + "title": "FUNCTION_DOC_3", + "kind": 8388608, + "path": "ModuleWithDocuments2/functions/documents/FUNCTION_DOC_3.md" + } + ] + } + ] + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/Document.Project-Document-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/Document.Project-Document-1.md new file mode 100644 index 000000000..2c77ac53b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/Document.Project-Document-1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / Project Document 1 + +## Project Document 1 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/Document.docs.project.PROJECT_DOC_2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/Document.docs.project.PROJECT_DOC_2.md new file mode 100644 index 000000000..36e5ebfc4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/Document.docs.project.PROJECT_DOC_2.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / docs/project/PROJECT\_DOC\_2 + +## Project Document 2 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/Document.docs.project.PROJECT_DOC_3.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/Document.docs.project.PROJECT_DOC_3.md new file mode 100644 index 000000000..a1b8df5f1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/Document.docs.project.PROJECT_DOC_3.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / docs/project/PROJECT\_DOC\_3 + +## Project Document 3 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Class.ClassWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Class.ClassWithDocuments.md new file mode 100644 index 000000000..3d05b184a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Class.ClassWithDocuments.md @@ -0,0 +1,32 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / ClassWithDocuments + +# Class: ClassWithDocuments + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[CLASS\_DOC](ModuleWithDocuments1.ClassWithDocuments.Document.CLASS_DOC.md) + + + +‐ + +
+ +## Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.ClassWithDocuments.Document.CLASS_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.ClassWithDocuments.Document.CLASS_DOC.md new file mode 100644 index 000000000..6a2419b93 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.ClassWithDocuments.Document.CLASS_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / [ClassWithDocuments](ModuleWithDocuments1.Class.ClassWithDocuments.md) / CLASS\_DOC + +> Class Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Document.MODULE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Document.MODULE_DOC.md new file mode 100644 index 000000000..5578c6258 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Document.MODULE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / MODULE\_DOC + +> Module Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.EnumWithDocuments.Document.ENUM_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.EnumWithDocuments.Document.ENUM_DOC.md new file mode 100644 index 000000000..495629ab5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.EnumWithDocuments.Document.ENUM_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / [EnumWithDocuments](ModuleWithDocuments1.Enumeration.EnumWithDocuments.md) / ENUM\_DOC + +> Enum Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Enumeration.EnumWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Enumeration.EnumWithDocuments.md new file mode 100644 index 000000000..d8fe665bb --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Enumeration.EnumWithDocuments.md @@ -0,0 +1,34 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / EnumWithDocuments + +# Enumeration: EnumWithDocuments + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[ENUM\_DOC](ModuleWithDocuments1.EnumWithDocuments.Document.ENUM_DOC.md) + + + +‐ + +
+ +## Enumeration Members + +### EnumMember + +_DECLARATION_TITLE_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Function.functionWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Function.functionWithDocuments.md new file mode 100644 index 000000000..6d2615983 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Function.functionWithDocuments.md @@ -0,0 +1,34 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / functionWithDocuments + +# Function: functionWithDocuments() + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for functionWithDocuments + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[FUNCTION\_DOC\_1](ModuleWithDocuments1.functionWithDocuments.Document.FUNCTION_DOC_1.md) + + + +‐ + +
+ +_SIGNATURE_RETURNS_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Function.multipleFunctionWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Function.multipleFunctionWithDocuments.md new file mode 100644 index 000000000..e2d6078f9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Function.multipleFunctionWithDocuments.md @@ -0,0 +1,78 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / multipleFunctionWithDocuments + +# Function: multipleFunctionWithDocuments() + +Comments for multipleFunctionWithDocuments + +## Documents + + + + + + + + + + + + + + + + + + + + + + +
DocumentDescription
+ +[FUNCTION\_DOC\_3](ModuleWithDocuments1.multipleFunctionWithDocuments.Document.FUNCTION_DOC_3.md) + + + +‐ + +
+ +[FUNCTION\_DOC\_1](ModuleWithDocuments1.multipleFunctionWithDocuments.Document.FUNCTION_DOC_1.md) + + + +‐ + +
+ +[FUNCTION\_DOC\_2](ModuleWithDocuments1.multipleFunctionWithDocuments.Document.FUNCTION_DOC_2.md) + + + +‐ + +
+ +## Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsA + +### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ + +## Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsB + +### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Interface.InterfaceWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Interface.InterfaceWithDocuments.md new file mode 100644 index 000000000..73f95c8ff --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Interface.InterfaceWithDocuments.md @@ -0,0 +1,34 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / InterfaceWithDocuments + +# Interface: InterfaceWithDocuments + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[INTERFACE\_DOC](ModuleWithDocuments1.InterfaceWithDocuments.Document.INTERFACE_DOC.md) + + + +‐ + +
+ +## Properties + +### prop + +_DECLARATION_TITLE_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.InterfaceWithDocuments.Document.INTERFACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.InterfaceWithDocuments.Document.INTERFACE_DOC.md new file mode 100644 index 000000000..899e82ea2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.InterfaceWithDocuments.Document.INTERFACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / [InterfaceWithDocuments](ModuleWithDocuments1.Interface.InterfaceWithDocuments.md) / INTERFACE\_DOC + +> Interface Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Namespace.NamespaceWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Namespace.NamespaceWithDocuments.md new file mode 100644 index 000000000..9c773c065 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Namespace.NamespaceWithDocuments.md @@ -0,0 +1,53 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / NamespaceWithDocuments + +# NamespaceWithDocuments + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[NAMESPACE\_DOC](ModuleWithDocuments1.NamespaceWithDocuments.Document.NAMESPACE_DOC.md) + + + +‐ + +
+ +## Classes + + + + + + + + + + + + + + +
ClassDescription
+ +[NamespaceClassWithDocuments](ModuleWithDocuments1.NamespaceWithDocuments.Class.NamespaceClassWithDocuments.md) + + + +‐ + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.NamespaceWithDocuments.Class.NamespaceClassWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.NamespaceWithDocuments.Class.NamespaceClassWithDocuments.md new file mode 100644 index 000000000..0e3c722d2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.NamespaceWithDocuments.Class.NamespaceClassWithDocuments.md @@ -0,0 +1,32 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / [NamespaceWithDocuments](ModuleWithDocuments1.Namespace.NamespaceWithDocuments.md) / NamespaceClassWithDocuments + +# Class: NamespaceClassWithDocuments + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[CLASS\_DOC](ModuleWithDocuments1.NamespaceWithDocuments.NamespaceClassWithDocuments.Document.CLASS_DOC.md) + + + +‐ + +
+ +## Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.NamespaceWithDocuments.Document.NAMESPACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.NamespaceWithDocuments.Document.NAMESPACE_DOC.md new file mode 100644 index 000000000..30b38128c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.NamespaceWithDocuments.Document.NAMESPACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / [NamespaceWithDocuments](ModuleWithDocuments1.Namespace.NamespaceWithDocuments.md) / NAMESPACE\_DOC + +> Namespace Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.NamespaceWithDocuments.NamespaceClassWithDocuments.Document.CLASS_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.NamespaceWithDocuments.NamespaceClassWithDocuments.Document.CLASS_DOC.md new file mode 100644 index 000000000..904b1461a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.NamespaceWithDocuments.NamespaceClassWithDocuments.Document.CLASS_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / [NamespaceWithDocuments](ModuleWithDocuments1.Namespace.NamespaceWithDocuments.md) / [NamespaceClassWithDocuments](ModuleWithDocuments1.NamespaceWithDocuments.Class.NamespaceClassWithDocuments.md) / CLASS\_DOC + +> Class Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.TypeAlias.TypeWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.TypeAlias.TypeWithDocuments.md new file mode 100644 index 000000000..9aee4b127 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.TypeAlias.TypeWithDocuments.md @@ -0,0 +1,30 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / TypeWithDocuments + +# Type Alias: TypeWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[TYPE\_DOC](ModuleWithDocuments1.TypeWithDocuments.Document.TYPE_DOC.md) + + + +‐ + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.TypeWithDocuments.Document.TYPE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.TypeWithDocuments.Document.TYPE_DOC.md new file mode 100644 index 000000000..7a33a3b51 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.TypeWithDocuments.Document.TYPE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / [TypeWithDocuments](ModuleWithDocuments1.TypeAlias.TypeWithDocuments.md) / TYPE\_DOC + +> Type Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Variable.variableWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Variable.variableWithDocuments.md new file mode 100644 index 000000000..de93c140e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.Variable.variableWithDocuments.md @@ -0,0 +1,30 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / variableWithDocuments + +# Variable: variableWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[VARIABLE\_DOC](ModuleWithDocuments1.variableWithDocuments.Document.VARIABLE_DOC.md) + + + +‐ + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.functionWithDocuments.Document.FUNCTION_DOC_1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.functionWithDocuments.Document.FUNCTION_DOC_1.md new file mode 100644 index 000000000..9083d6f5f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.functionWithDocuments.Document.FUNCTION_DOC_1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / [functionWithDocuments](ModuleWithDocuments1.Function.functionWithDocuments.md) / FUNCTION\_DOC\_1 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.md new file mode 100644 index 000000000..4f16fe724 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.md @@ -0,0 +1,215 @@ +[typedoc-stubs](README.md) / ModuleWithDocuments1 + +# ModuleWithDocuments1 + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[MODULE\_DOC](ModuleWithDocuments1.Document.MODULE_DOC.md) + + + +‐ + +
+ +## Namespaces + + + + + + + + + + + + + + +
NamespaceDescription
+ +[NamespaceWithDocuments](ModuleWithDocuments1.Namespace.NamespaceWithDocuments.md) + + + +‐ + +
+ +## Enumerations + + + + + + + + + + + + + + +
EnumerationDescription
+ +[EnumWithDocuments](ModuleWithDocuments1.Enumeration.EnumWithDocuments.md) + + + +‐ + +
+ +## Classes + + + + + + + + + + + + + + +
ClassDescription
+ +[ClassWithDocuments](ModuleWithDocuments1.Class.ClassWithDocuments.md) + + + +‐ + +
+ +## Interfaces + + + + + + + + + + + + + + +
InterfaceDescription
+ +[InterfaceWithDocuments](ModuleWithDocuments1.Interface.InterfaceWithDocuments.md) + + + +‐ + +
+ +## Type Aliases + + + + + + + + + + + + + + +
Type aliasDescription
+ +[TypeWithDocuments](ModuleWithDocuments1.TypeAlias.TypeWithDocuments.md) + + + +‐ + +
+ +## Variables + + + + + + + + + + + + + + +
VariableDescription
+ +[variableWithDocuments](ModuleWithDocuments1.Variable.variableWithDocuments.md) + + + +‐ + +
+ +## Functions + + + + + + + + + + + + + + + + + + +
FunctionDescription
+ +[functionWithDocuments](ModuleWithDocuments1.Function.functionWithDocuments.md) + + + +Comments for functionWithDocuments + +
+ +[multipleFunctionWithDocuments](ModuleWithDocuments1.Function.multipleFunctionWithDocuments.md) + + + +Comments for multipleFunctionWithDocuments + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.multipleFunctionWithDocuments.Document.FUNCTION_DOC_1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.multipleFunctionWithDocuments.Document.FUNCTION_DOC_1.md new file mode 100644 index 000000000..9a5b0108e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.multipleFunctionWithDocuments.Document.FUNCTION_DOC_1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / [multipleFunctionWithDocuments](ModuleWithDocuments1.Function.multipleFunctionWithDocuments.md) / FUNCTION\_DOC\_1 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.multipleFunctionWithDocuments.Document.FUNCTION_DOC_2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.multipleFunctionWithDocuments.Document.FUNCTION_DOC_2.md new file mode 100644 index 000000000..2cbd749bf --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.multipleFunctionWithDocuments.Document.FUNCTION_DOC_2.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / [multipleFunctionWithDocuments](ModuleWithDocuments1.Function.multipleFunctionWithDocuments.md) / FUNCTION\_DOC\_2 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.multipleFunctionWithDocuments.Document.FUNCTION_DOC_3.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.multipleFunctionWithDocuments.Document.FUNCTION_DOC_3.md new file mode 100644 index 000000000..c9e1d27f6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.multipleFunctionWithDocuments.Document.FUNCTION_DOC_3.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / [multipleFunctionWithDocuments](ModuleWithDocuments1.Function.multipleFunctionWithDocuments.md) / FUNCTION\_DOC\_3 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.variableWithDocuments.Document.VARIABLE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.variableWithDocuments.Document.VARIABLE_DOC.md new file mode 100644 index 000000000..233e9558d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments1.variableWithDocuments.Document.VARIABLE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / [variableWithDocuments](ModuleWithDocuments1.Variable.variableWithDocuments.md) / VARIABLE\_DOC + +> Variable Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Class.ClassWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Class.ClassWithDocuments.md new file mode 100644 index 000000000..1438d5d69 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Class.ClassWithDocuments.md @@ -0,0 +1,32 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / ClassWithDocuments + +# Class: ClassWithDocuments + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[CLASS\_DOC](ModuleWithDocuments2.ClassWithDocuments.Document.CLASS_DOC.md) + + + +‐ + +
+ +## Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.ClassWithDocuments.Document.CLASS_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.ClassWithDocuments.Document.CLASS_DOC.md new file mode 100644 index 000000000..4a2a10f62 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.ClassWithDocuments.Document.CLASS_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / [ClassWithDocuments](ModuleWithDocuments2.Class.ClassWithDocuments.md) / CLASS\_DOC + +> Class Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Document.MODULE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Document.MODULE_DOC.md new file mode 100644 index 000000000..0405e97ff --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Document.MODULE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / MODULE\_DOC + +> Module Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.EnumWithDocuments.Document.ENUM_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.EnumWithDocuments.Document.ENUM_DOC.md new file mode 100644 index 000000000..b20f9ee98 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.EnumWithDocuments.Document.ENUM_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / [EnumWithDocuments](ModuleWithDocuments2.Enumeration.EnumWithDocuments.md) / ENUM\_DOC + +> Enum Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Enumeration.EnumWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Enumeration.EnumWithDocuments.md new file mode 100644 index 000000000..46ec4981c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Enumeration.EnumWithDocuments.md @@ -0,0 +1,34 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / EnumWithDocuments + +# Enumeration: EnumWithDocuments + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[ENUM\_DOC](ModuleWithDocuments2.EnumWithDocuments.Document.ENUM_DOC.md) + + + +‐ + +
+ +## Enumeration Members + +### EnumMember + +_DECLARATION_TITLE_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Function.functionWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Function.functionWithDocuments.md new file mode 100644 index 000000000..30147b066 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Function.functionWithDocuments.md @@ -0,0 +1,34 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / functionWithDocuments + +# Function: functionWithDocuments() + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for functionWithDocuments + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[FUNCTION\_DOC\_1](ModuleWithDocuments2.functionWithDocuments.Document.FUNCTION_DOC_1.md) + + + +‐ + +
+ +_SIGNATURE_RETURNS_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Function.multipleFunctionWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Function.multipleFunctionWithDocuments.md new file mode 100644 index 000000000..d8a2a4cf4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Function.multipleFunctionWithDocuments.md @@ -0,0 +1,78 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / multipleFunctionWithDocuments + +# Function: multipleFunctionWithDocuments() + +Comments for multipleFunctionWithDocuments + +## Documents + + + + + + + + + + + + + + + + + + + + + + +
DocumentDescription
+ +[FUNCTION\_DOC\_3](ModuleWithDocuments2.multipleFunctionWithDocuments.Document.FUNCTION_DOC_3.md) + + + +‐ + +
+ +[FUNCTION\_DOC\_1](ModuleWithDocuments2.multipleFunctionWithDocuments.Document.FUNCTION_DOC_1.md) + + + +‐ + +
+ +[FUNCTION\_DOC\_2](ModuleWithDocuments2.multipleFunctionWithDocuments.Document.FUNCTION_DOC_2.md) + + + +‐ + +
+ +## Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsA + +### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ + +## Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsB + +### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Interface.InterfaceWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Interface.InterfaceWithDocuments.md new file mode 100644 index 000000000..9036b9a62 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Interface.InterfaceWithDocuments.md @@ -0,0 +1,34 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / InterfaceWithDocuments + +# Interface: InterfaceWithDocuments + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[INTERFACE\_DOC](ModuleWithDocuments2.InterfaceWithDocuments.Document.INTERFACE_DOC.md) + + + +‐ + +
+ +## Properties + +### prop + +_DECLARATION_TITLE_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.InterfaceWithDocuments.Document.INTERFACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.InterfaceWithDocuments.Document.INTERFACE_DOC.md new file mode 100644 index 000000000..d30222bce --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.InterfaceWithDocuments.Document.INTERFACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / [InterfaceWithDocuments](ModuleWithDocuments2.Interface.InterfaceWithDocuments.md) / INTERFACE\_DOC + +> Interface Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.TypeAlias.TypeWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.TypeAlias.TypeWithDocuments.md new file mode 100644 index 000000000..c84f27e75 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.TypeAlias.TypeWithDocuments.md @@ -0,0 +1,30 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / TypeWithDocuments + +# Type Alias: TypeWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[TYPE\_DOC](ModuleWithDocuments2.TypeWithDocuments.Document.TYPE_DOC.md) + + + +‐ + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.TypeWithDocuments.Document.TYPE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.TypeWithDocuments.Document.TYPE_DOC.md new file mode 100644 index 000000000..938db20c5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.TypeWithDocuments.Document.TYPE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / [TypeWithDocuments](ModuleWithDocuments2.TypeAlias.TypeWithDocuments.md) / TYPE\_DOC + +> Type Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Variable.variableWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Variable.variableWithDocuments.md new file mode 100644 index 000000000..ad7a8b05b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.Variable.variableWithDocuments.md @@ -0,0 +1,30 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / variableWithDocuments + +# Variable: variableWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[VARIABLE\_DOC](ModuleWithDocuments2.variableWithDocuments.Document.VARIABLE_DOC.md) + + + +‐ + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.functionWithDocuments.Document.FUNCTION_DOC_1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.functionWithDocuments.Document.FUNCTION_DOC_1.md new file mode 100644 index 000000000..f2865f5c4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.functionWithDocuments.Document.FUNCTION_DOC_1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / [functionWithDocuments](ModuleWithDocuments2.Function.functionWithDocuments.md) / FUNCTION\_DOC\_1 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.md new file mode 100644 index 000000000..4c6b92b32 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.md @@ -0,0 +1,190 @@ +[typedoc-stubs](README.md) / ModuleWithDocuments2 + +# ModuleWithDocuments2 + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[MODULE\_DOC](ModuleWithDocuments2.Document.MODULE_DOC.md) + + + +‐ + +
+ +## Enumerations + + + + + + + + + + + + + + +
EnumerationDescription
+ +[EnumWithDocuments](ModuleWithDocuments2.Enumeration.EnumWithDocuments.md) + + + +‐ + +
+ +## Classes + + + + + + + + + + + + + + +
ClassDescription
+ +[ClassWithDocuments](ModuleWithDocuments2.Class.ClassWithDocuments.md) + + + +‐ + +
+ +## Interfaces + + + + + + + + + + + + + + +
InterfaceDescription
+ +[InterfaceWithDocuments](ModuleWithDocuments2.Interface.InterfaceWithDocuments.md) + + + +‐ + +
+ +## Type Aliases + + + + + + + + + + + + + + +
Type aliasDescription
+ +[TypeWithDocuments](ModuleWithDocuments2.TypeAlias.TypeWithDocuments.md) + + + +‐ + +
+ +## Variables + + + + + + + + + + + + + + +
VariableDescription
+ +[variableWithDocuments](ModuleWithDocuments2.Variable.variableWithDocuments.md) + + + +‐ + +
+ +## Functions + + + + + + + + + + + + + + + + + + +
FunctionDescription
+ +[functionWithDocuments](ModuleWithDocuments2.Function.functionWithDocuments.md) + + + +Comments for functionWithDocuments + +
+ +[multipleFunctionWithDocuments](ModuleWithDocuments2.Function.multipleFunctionWithDocuments.md) + + + +Comments for multipleFunctionWithDocuments + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.multipleFunctionWithDocuments.Document.FUNCTION_DOC_1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.multipleFunctionWithDocuments.Document.FUNCTION_DOC_1.md new file mode 100644 index 000000000..b22ca0112 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.multipleFunctionWithDocuments.Document.FUNCTION_DOC_1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / [multipleFunctionWithDocuments](ModuleWithDocuments2.Function.multipleFunctionWithDocuments.md) / FUNCTION\_DOC\_1 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.multipleFunctionWithDocuments.Document.FUNCTION_DOC_2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.multipleFunctionWithDocuments.Document.FUNCTION_DOC_2.md new file mode 100644 index 000000000..b33ba04c7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.multipleFunctionWithDocuments.Document.FUNCTION_DOC_2.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / [multipleFunctionWithDocuments](ModuleWithDocuments2.Function.multipleFunctionWithDocuments.md) / FUNCTION\_DOC\_2 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.multipleFunctionWithDocuments.Document.FUNCTION_DOC_3.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.multipleFunctionWithDocuments.Document.FUNCTION_DOC_3.md new file mode 100644 index 000000000..a71f28410 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.multipleFunctionWithDocuments.Document.FUNCTION_DOC_3.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / [multipleFunctionWithDocuments](ModuleWithDocuments2.Function.multipleFunctionWithDocuments.md) / FUNCTION\_DOC\_3 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.variableWithDocuments.Document.VARIABLE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.variableWithDocuments.Document.VARIABLE_DOC.md new file mode 100644 index 000000000..102a95b0b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/ModuleWithDocuments2.variableWithDocuments.Document.VARIABLE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / [variableWithDocuments](ModuleWithDocuments2.Variable.variableWithDocuments.md) / VARIABLE\_DOC + +> Variable Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/README.md new file mode 100644 index 000000000..74664dd77 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/README.md @@ -0,0 +1,87 @@ +# typedoc-stubs + +## Documents + + + + + + + + + + + + + + + + + + + + + + +
DocumentDescription
+ +[Project Document 1](Document.Project-Document-1.md) + + + +A description of the document + +
+ +[docs/project/PROJECT\_DOC\_2](Document.docs.project.PROJECT_DOC_2.md) + + + +‐ + +
+ +[docs/project/PROJECT\_DOC\_3](Document.docs.project.PROJECT_DOC_3.md) + + + +‐ + +
+ +## Modules + + + + + + + + + + + + + + + + + + +
ModuleDescription
+ +[ModuleWithDocuments1](ModuleWithDocuments1.md) + + + +‐ + +
+ +[ModuleWithDocuments2](ModuleWithDocuments2.md) + + + +‐ + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/sidebar.json new file mode 100644 index 000000000..490810472 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/members/opts-2/sidebar.json @@ -0,0 +1,308 @@ +[ + { + "title": "Documents", + "children": [ + { + "title": "Project Document 1", + "kind": 8388608, + "path": "Document.Project-Document-1.md" + }, + { + "title": "docs/project/PROJECT_DOC_2", + "kind": 8388608, + "path": "Document.docs.project.PROJECT_DOC_2.md" + }, + { + "title": "docs/project/PROJECT_DOC_3", + "kind": 8388608, + "path": "Document.docs.project.PROJECT_DOC_3.md" + } + ] + }, + { + "title": "ModuleWithDocuments1", + "kind": 2, + "path": "ModuleWithDocuments1.md", + "children": [ + { + "title": "MODULE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1.Document.MODULE_DOC.md" + }, + { + "title": "Namespaces", + "children": [ + { + "title": "NamespaceWithDocuments", + "kind": 4, + "path": "ModuleWithDocuments1.Namespace.NamespaceWithDocuments.md", + "children": [ + { + "title": "NAMESPACE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1.NamespaceWithDocuments.Document.NAMESPACE_DOC.md" + }, + { + "title": "Classes", + "children": [ + { + "title": "NamespaceClassWithDocuments", + "kind": 128, + "path": "ModuleWithDocuments1.NamespaceWithDocuments.Class.NamespaceClassWithDocuments.md", + "children": [ + { + "title": "CLASS_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1.NamespaceWithDocuments.NamespaceClassWithDocuments.Document.CLASS_DOC.md" + } + ] + } + ] + } + ] + } + ] + }, + { + "title": "Enumerations", + "children": [ + { + "title": "EnumWithDocuments", + "kind": 8, + "path": "ModuleWithDocuments1.Enumeration.EnumWithDocuments.md", + "children": [ + { + "title": "ENUM_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1.EnumWithDocuments.Document.ENUM_DOC.md" + } + ] + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassWithDocuments", + "kind": 128, + "path": "ModuleWithDocuments1.Class.ClassWithDocuments.md", + "children": [ + { + "title": "CLASS_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1.ClassWithDocuments.Document.CLASS_DOC.md" + } + ] + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceWithDocuments", + "kind": 256, + "path": "ModuleWithDocuments1.Interface.InterfaceWithDocuments.md", + "children": [ + { + "title": "INTERFACE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1.InterfaceWithDocuments.Document.INTERFACE_DOC.md" + } + ] + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeWithDocuments", + "kind": 2097152, + "path": "ModuleWithDocuments1.TypeAlias.TypeWithDocuments.md", + "children": [ + { + "title": "TYPE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1.TypeWithDocuments.Document.TYPE_DOC.md" + } + ] + } + ] + }, + { + "title": "Variables", + "children": [ + { + "title": "variableWithDocuments", + "kind": 32, + "path": "ModuleWithDocuments1.Variable.variableWithDocuments.md", + "children": [ + { + "title": "VARIABLE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1.variableWithDocuments.Document.VARIABLE_DOC.md" + } + ] + } + ] + }, + { + "title": "Functions", + "children": [ + { + "title": "functionWithDocuments", + "kind": 64, + "path": "ModuleWithDocuments1.Function.functionWithDocuments.md", + "children": [ + { + "title": "FUNCTION_DOC_1", + "kind": 8388608, + "path": "ModuleWithDocuments1.functionWithDocuments.Document.FUNCTION_DOC_1.md" + } + ] + }, + { + "title": "multipleFunctionWithDocuments", + "kind": 64, + "path": "ModuleWithDocuments1.Function.multipleFunctionWithDocuments.md", + "children": [ + { + "title": "FUNCTION_DOC_3", + "kind": 8388608, + "path": "ModuleWithDocuments1.multipleFunctionWithDocuments.Document.FUNCTION_DOC_3.md" + } + ] + } + ] + } + ] + }, + { + "title": "ModuleWithDocuments2", + "kind": 2, + "path": "ModuleWithDocuments2.md", + "children": [ + { + "title": "MODULE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments2.Document.MODULE_DOC.md" + }, + { + "title": "Enumerations", + "children": [ + { + "title": "EnumWithDocuments", + "kind": 8, + "path": "ModuleWithDocuments2.Enumeration.EnumWithDocuments.md", + "children": [ + { + "title": "ENUM_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments2.EnumWithDocuments.Document.ENUM_DOC.md" + } + ] + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassWithDocuments", + "kind": 128, + "path": "ModuleWithDocuments2.Class.ClassWithDocuments.md", + "children": [ + { + "title": "CLASS_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments2.ClassWithDocuments.Document.CLASS_DOC.md" + } + ] + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceWithDocuments", + "kind": 256, + "path": "ModuleWithDocuments2.Interface.InterfaceWithDocuments.md", + "children": [ + { + "title": "INTERFACE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments2.InterfaceWithDocuments.Document.INTERFACE_DOC.md" + } + ] + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeWithDocuments", + "kind": 2097152, + "path": "ModuleWithDocuments2.TypeAlias.TypeWithDocuments.md", + "children": [ + { + "title": "TYPE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments2.TypeWithDocuments.Document.TYPE_DOC.md" + } + ] + } + ] + }, + { + "title": "Variables", + "children": [ + { + "title": "variableWithDocuments", + "kind": 32, + "path": "ModuleWithDocuments2.Variable.variableWithDocuments.md", + "children": [ + { + "title": "VARIABLE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments2.variableWithDocuments.Document.VARIABLE_DOC.md" + } + ] + } + ] + }, + { + "title": "Functions", + "children": [ + { + "title": "functionWithDocuments", + "kind": 64, + "path": "ModuleWithDocuments2.Function.functionWithDocuments.md", + "children": [ + { + "title": "FUNCTION_DOC_1", + "kind": 8388608, + "path": "ModuleWithDocuments2.functionWithDocuments.Document.FUNCTION_DOC_1.md" + } + ] + }, + { + "title": "multipleFunctionWithDocuments", + "kind": 64, + "path": "ModuleWithDocuments2.Function.multipleFunctionWithDocuments.md", + "children": [ + { + "title": "FUNCTION_DOC_3", + "kind": 8388608, + "path": "ModuleWithDocuments2.multipleFunctionWithDocuments.Document.FUNCTION_DOC_3.md" + } + ] + } + ] + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/README.md new file mode 100644 index 000000000..0b77a66cc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/README.md @@ -0,0 +1,121 @@ +[typedoc-stubs](../README.md) / ModuleWithDocuments1 + +# ModuleWithDocuments1 + +## Documents + +- [MODULE\_DOC](documents/MODULE_DOC.md) + +## Namespaces + +- [NamespaceWithDocuments](namespaces/NamespaceWithDocuments/README.md) + +## Enumerations + +### EnumWithDocuments + +#### Documents + +- [ENUM\_DOC](documents/Enumeration.ENUM_DOC.md) + +#### Enumeration Members + +##### EnumMember + +_DECLARATION_TITLE_PARTIAL_ + +## Classes + +### ClassWithDocuments + +#### Documents + +- [CLASS\_DOC](documents/Class.CLASS_DOC.md) + +#### Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ + +## Interfaces + +### InterfaceWithDocuments + +#### Documents + +- [INTERFACE\_DOC](documents/Interface.INTERFACE_DOC.md) + +#### Properties + +##### prop + +_DECLARATION_TITLE_PARTIAL_ + +## Type Aliases + +### TypeWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +#### Documents + +- [TYPE\_DOC](documents/TypeAlias.TYPE_DOC.md) + +## Variables + +### variableWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +#### Documents + +- [VARIABLE\_DOC](documents/Variable.VARIABLE_DOC.md) + +## Functions + +### functionWithDocuments() + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for functionWithDocuments + +#### Documents + +- [FUNCTION\_DOC\_1](documents/Function.FUNCTION_DOC_1.md) + +_SIGNATURE_RETURNS_PARTIAL_ + +*** + +### multipleFunctionWithDocuments() + +Comments for multipleFunctionWithDocuments + +#### Documents + +- [FUNCTION\_DOC\_3](documents/Function.FUNCTION_DOC_3.md) +- [FUNCTION\_DOC\_1](documents/Function.FUNCTION_DOC_1.md) +- [FUNCTION\_DOC\_2](documents/Function.FUNCTION_DOC_2.md) + +#### Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsA + +##### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ + +#### Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsB + +##### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Class.CLASS_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Class.CLASS_DOC.md new file mode 100644 index 000000000..33c59d9d5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Class.CLASS_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [ClassWithDocuments](../README.md#classwithdocuments) / CLASS\_DOC + +> Class Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Enumeration.ENUM_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Enumeration.ENUM_DOC.md new file mode 100644 index 000000000..a791f4476 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Enumeration.ENUM_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [EnumWithDocuments](../README.md#enumwithdocuments) / ENUM\_DOC + +> Enum Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_1.md new file mode 100644 index 000000000..5ececbdce --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [multipleFunctionWithDocuments](../README.md#multiplefunctionwithdocuments) / FUNCTION\_DOC\_1 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_2.md new file mode 100644 index 000000000..143177743 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_2.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [multipleFunctionWithDocuments](../README.md#multiplefunctionwithdocuments) / FUNCTION\_DOC\_2 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_3.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_3.md new file mode 100644 index 000000000..775b4fe8e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_3.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [multipleFunctionWithDocuments](../README.md#multiplefunctionwithdocuments) / FUNCTION\_DOC\_3 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Interface.INTERFACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Interface.INTERFACE_DOC.md new file mode 100644 index 000000000..7c35209a2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Interface.INTERFACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [InterfaceWithDocuments](../README.md#interfacewithdocuments) / INTERFACE\_DOC + +> Interface Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/MODULE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/MODULE_DOC.md new file mode 100644 index 000000000..d6ea144e7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/MODULE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / MODULE\_DOC + +> Module Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/TypeAlias.TYPE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/TypeAlias.TYPE_DOC.md new file mode 100644 index 000000000..bc67da96b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/TypeAlias.TYPE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [TypeWithDocuments](../README.md#typewithdocuments) / TYPE\_DOC + +> Type Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Variable.VARIABLE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Variable.VARIABLE_DOC.md new file mode 100644 index 000000000..b6f4725eb --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/documents/Variable.VARIABLE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [variableWithDocuments](../README.md#variablewithdocuments) / VARIABLE\_DOC + +> Variable Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md new file mode 100644 index 000000000..1f0a3654c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md @@ -0,0 +1,19 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / NamespaceWithDocuments + +# NamespaceWithDocuments + +## Documents + +- [NAMESPACE\_DOC](documents/NAMESPACE_DOC.md) + +## Classes + +### NamespaceClassWithDocuments + +#### Documents + +- [CLASS\_DOC](documents/Class.CLASS_DOC.md) + +#### Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/Class.CLASS_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/Class.CLASS_DOC.md new file mode 100644 index 000000000..151697535 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/Class.CLASS_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../../README.md) / [ModuleWithDocuments1](../../../README.md) / [NamespaceWithDocuments](../README.md) / [NamespaceClassWithDocuments](../README.md#namespaceclasswithdocuments) / CLASS\_DOC + +> Class Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md new file mode 100644 index 000000000..a6fb21660 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../../README.md) / [ModuleWithDocuments1](../../../README.md) / [NamespaceWithDocuments](../README.md) / NAMESPACE\_DOC + +> Namespace Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/README.md new file mode 100644 index 000000000..a46faf763 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/README.md @@ -0,0 +1,117 @@ +[typedoc-stubs](../README.md) / ModuleWithDocuments2 + +# ModuleWithDocuments2 + +## Documents + +- [MODULE\_DOC](documents/MODULE_DOC.md) + +## Enumerations + +### EnumWithDocuments + +#### Documents + +- [ENUM\_DOC](documents/Enumeration.ENUM_DOC.md) + +#### Enumeration Members + +##### EnumMember + +_DECLARATION_TITLE_PARTIAL_ + +## Classes + +### ClassWithDocuments + +#### Documents + +- [CLASS\_DOC](documents/Class.CLASS_DOC.md) + +#### Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ + +## Interfaces + +### InterfaceWithDocuments + +#### Documents + +- [INTERFACE\_DOC](documents/Interface.INTERFACE_DOC.md) + +#### Properties + +##### prop + +_DECLARATION_TITLE_PARTIAL_ + +## Type Aliases + +### TypeWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +#### Documents + +- [TYPE\_DOC](documents/TypeAlias.TYPE_DOC.md) + +## Variables + +### variableWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +#### Documents + +- [VARIABLE\_DOC](documents/Variable.VARIABLE_DOC.md) + +## Functions + +### functionWithDocuments() + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for functionWithDocuments + +#### Documents + +- [FUNCTION\_DOC\_1](documents/Function.FUNCTION_DOC_1.md) + +_SIGNATURE_RETURNS_PARTIAL_ + +*** + +### multipleFunctionWithDocuments() + +Comments for multipleFunctionWithDocuments + +#### Documents + +- [FUNCTION\_DOC\_3](documents/Function.FUNCTION_DOC_3.md) +- [FUNCTION\_DOC\_1](documents/Function.FUNCTION_DOC_1.md) +- [FUNCTION\_DOC\_2](documents/Function.FUNCTION_DOC_2.md) + +#### Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsA + +##### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ + +#### Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsB + +##### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Class.CLASS_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Class.CLASS_DOC.md new file mode 100644 index 000000000..e9383323d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Class.CLASS_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments2](../README.md) / [ClassWithDocuments](../README.md#classwithdocuments) / CLASS\_DOC + +> Class Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Enumeration.ENUM_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Enumeration.ENUM_DOC.md new file mode 100644 index 000000000..784519f2e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Enumeration.ENUM_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments2](../README.md) / [EnumWithDocuments](../README.md#enumwithdocuments) / ENUM\_DOC + +> Enum Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Function.FUNCTION_DOC_1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Function.FUNCTION_DOC_1.md new file mode 100644 index 000000000..fb4b81e03 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Function.FUNCTION_DOC_1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments2](../README.md) / [multipleFunctionWithDocuments](../README.md#multiplefunctionwithdocuments) / FUNCTION\_DOC\_1 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Function.FUNCTION_DOC_2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Function.FUNCTION_DOC_2.md new file mode 100644 index 000000000..338ec0c1a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Function.FUNCTION_DOC_2.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments2](../README.md) / [multipleFunctionWithDocuments](../README.md#multiplefunctionwithdocuments) / FUNCTION\_DOC\_2 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Function.FUNCTION_DOC_3.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Function.FUNCTION_DOC_3.md new file mode 100644 index 000000000..ffdeb235d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Function.FUNCTION_DOC_3.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments2](../README.md) / [multipleFunctionWithDocuments](../README.md#multiplefunctionwithdocuments) / FUNCTION\_DOC\_3 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Interface.INTERFACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Interface.INTERFACE_DOC.md new file mode 100644 index 000000000..25fd6b530 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Interface.INTERFACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments2](../README.md) / [InterfaceWithDocuments](../README.md#interfacewithdocuments) / INTERFACE\_DOC + +> Interface Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/MODULE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/MODULE_DOC.md new file mode 100644 index 000000000..bad42e225 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/MODULE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments2](../README.md) / MODULE\_DOC + +> Module Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/TypeAlias.TYPE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/TypeAlias.TYPE_DOC.md new file mode 100644 index 000000000..60eab641e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/TypeAlias.TYPE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments2](../README.md) / [TypeWithDocuments](../README.md#typewithdocuments) / TYPE\_DOC + +> Type Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Variable.VARIABLE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Variable.VARIABLE_DOC.md new file mode 100644 index 000000000..d8cae9026 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/ModuleWithDocuments2/documents/Variable.VARIABLE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments2](../README.md) / [variableWithDocuments](../README.md#variablewithdocuments) / VARIABLE\_DOC + +> Variable Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/README.md new file mode 100644 index 000000000..111eeea02 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/README.md @@ -0,0 +1,12 @@ +# typedoc-stubs + +## Documents + +- [Project Document 1](documents/Project-Document-1.md) +- [docs/project/PROJECT\_DOC\_2](documents/docs/project/PROJECT_DOC_2.md) +- [docs/project/PROJECT\_DOC\_3](documents/docs/project/PROJECT_DOC_3.md) + +## Modules + +- [ModuleWithDocuments1](ModuleWithDocuments1/README.md) +- [ModuleWithDocuments2](ModuleWithDocuments2/README.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/documents/Project-Document-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/documents/Project-Document-1.md new file mode 100644 index 000000000..bee850405 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/documents/Project-Document-1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../README.md) / Project Document 1 + +## Project Document 1 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/documents/docs/project/PROJECT_DOC_2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/documents/docs/project/PROJECT_DOC_2.md new file mode 100644 index 000000000..01cc00688 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/documents/docs/project/PROJECT_DOC_2.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / docs/project/PROJECT\_DOC\_2 + +## Project Document 2 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/documents/docs/project/PROJECT_DOC_3.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/documents/docs/project/PROJECT_DOC_3.md new file mode 100644 index 000000000..9a398c908 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/documents/docs/project/PROJECT_DOC_3.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / docs/project/PROJECT\_DOC\_3 + +## Project Document 3 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/sidebar.json new file mode 100644 index 000000000..c2d279eb1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-1/sidebar.json @@ -0,0 +1,63 @@ +[ + { + "title": "Documents", + "children": [ + { + "title": "Project Document 1", + "kind": 8388608, + "path": "documents/Project-Document-1.md" + }, + { + "title": "docs/project/PROJECT_DOC_2", + "kind": 8388608, + "path": "documents/docs/project/PROJECT_DOC_2.md" + }, + { + "title": "docs/project/PROJECT_DOC_3", + "kind": 8388608, + "path": "documents/docs/project/PROJECT_DOC_3.md" + } + ] + }, + { + "title": "ModuleWithDocuments1", + "kind": 2, + "path": "ModuleWithDocuments1/README.md", + "children": [ + { + "title": "MODULE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/documents/MODULE_DOC.md" + }, + { + "title": "Namespaces", + "children": [ + { + "title": "NamespaceWithDocuments", + "kind": 4, + "path": "ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md", + "children": [ + { + "title": "NAMESPACE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md" + } + ] + } + ] + } + ] + }, + { + "title": "ModuleWithDocuments2", + "kind": 2, + "path": "ModuleWithDocuments2/README.md", + "children": [ + { + "title": "MODULE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments2/documents/MODULE_DOC.md" + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Class.CLASS_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Class.CLASS_DOC.md new file mode 100644 index 000000000..a6db0eeed --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Class.CLASS_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / [ClassWithDocuments](ModuleWithDocuments2.md#classwithdocuments) / CLASS\_DOC + +> Class Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Enumeration.ENUM_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Enumeration.ENUM_DOC.md new file mode 100644 index 000000000..5eb1d0d28 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Enumeration.ENUM_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / [EnumWithDocuments](ModuleWithDocuments2.md#enumwithdocuments) / ENUM\_DOC + +> Enum Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Function.FUNCTION_DOC_1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Function.FUNCTION_DOC_1.md new file mode 100644 index 000000000..f4977d4ed --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Function.FUNCTION_DOC_1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / [multipleFunctionWithDocuments](ModuleWithDocuments2.md#multiplefunctionwithdocuments) / FUNCTION\_DOC\_1 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Function.FUNCTION_DOC_2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Function.FUNCTION_DOC_2.md new file mode 100644 index 000000000..8d873d346 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Function.FUNCTION_DOC_2.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / [multipleFunctionWithDocuments](ModuleWithDocuments2.md#multiplefunctionwithdocuments) / FUNCTION\_DOC\_2 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Function.FUNCTION_DOC_3.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Function.FUNCTION_DOC_3.md new file mode 100644 index 000000000..1446434f8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Function.FUNCTION_DOC_3.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / [multipleFunctionWithDocuments](ModuleWithDocuments2.md#multiplefunctionwithdocuments) / FUNCTION\_DOC\_3 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Interface.INTERFACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Interface.INTERFACE_DOC.md new file mode 100644 index 000000000..c7adce187 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Interface.INTERFACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / [InterfaceWithDocuments](ModuleWithDocuments2.md#interfacewithdocuments) / INTERFACE\_DOC + +> Interface Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Project-Document-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Project-Document-1.md new file mode 100644 index 000000000..2c77ac53b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Project-Document-1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / Project Document 1 + +## Project Document 1 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.TypeAlias.TYPE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.TypeAlias.TYPE_DOC.md new file mode 100644 index 000000000..3f2f3f88b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.TypeAlias.TYPE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / [TypeWithDocuments](ModuleWithDocuments2.md#typewithdocuments) / TYPE\_DOC + +> Type Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Variable.VARIABLE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Variable.VARIABLE_DOC.md new file mode 100644 index 000000000..bfaba8a3e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.Variable.VARIABLE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / [variableWithDocuments](ModuleWithDocuments2.md#variablewithdocuments) / VARIABLE\_DOC + +> Variable Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.docs.project.PROJECT_DOC_2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.docs.project.PROJECT_DOC_2.md new file mode 100644 index 000000000..36e5ebfc4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.docs.project.PROJECT_DOC_2.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / docs/project/PROJECT\_DOC\_2 + +## Project Document 2 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.docs.project.PROJECT_DOC_3.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.docs.project.PROJECT_DOC_3.md new file mode 100644 index 000000000..a1b8df5f1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/Document.docs.project.PROJECT_DOC_3.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / docs/project/PROJECT\_DOC\_3 + +## Project Document 3 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments1.Document.MODULE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments1.Document.MODULE_DOC.md new file mode 100644 index 000000000..5578c6258 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments1.Document.MODULE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / MODULE\_DOC + +> Module Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments1.Namespace.NamespaceWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments1.Namespace.NamespaceWithDocuments.md new file mode 100644 index 000000000..a845421ca --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments1.Namespace.NamespaceWithDocuments.md @@ -0,0 +1,61 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / NamespaceWithDocuments + +# NamespaceWithDocuments + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[NAMESPACE\_DOC](ModuleWithDocuments1.NamespaceWithDocuments.Document.NAMESPACE_DOC.md) + + + +‐ + +
+ +## Classes + +### NamespaceClassWithDocuments + +#### Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[CLASS\_DOC](Document.Class.CLASS_DOC.md) + + + +‐ + +
+ +#### Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments1.NamespaceWithDocuments.Document.NAMESPACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments1.NamespaceWithDocuments.Document.NAMESPACE_DOC.md new file mode 100644 index 000000000..30b38128c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments1.NamespaceWithDocuments.Document.NAMESPACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments1](ModuleWithDocuments1.md) / [NamespaceWithDocuments](ModuleWithDocuments1.Namespace.NamespaceWithDocuments.md) / NAMESPACE\_DOC + +> Namespace Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments1.md new file mode 100644 index 000000000..6900ed665 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments1.md @@ -0,0 +1,332 @@ +[typedoc-stubs](README.md) / ModuleWithDocuments1 + +# ModuleWithDocuments1 + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[MODULE\_DOC](ModuleWithDocuments1.Document.MODULE_DOC.md) + + + +‐ + +
+ +## Namespaces + + + + + + + + + + + + + + +
NamespaceDescription
+ +[NamespaceWithDocuments](ModuleWithDocuments1.Namespace.NamespaceWithDocuments.md) + + + +‐ + +
+ +## Enumerations + +### EnumWithDocuments + +#### Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[ENUM\_DOC](Document.Enumeration.ENUM_DOC.md) + + + +‐ + +
+ +#### Enumeration Members + +##### EnumMember + +_DECLARATION_TITLE_PARTIAL_ + +## Classes + +### ClassWithDocuments + +#### Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[CLASS\_DOC](Document.Class.CLASS_DOC.md) + + + +‐ + +
+ +#### Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ + +## Interfaces + +### InterfaceWithDocuments + +#### Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[INTERFACE\_DOC](Document.Interface.INTERFACE_DOC.md) + + + +‐ + +
+ +#### Properties + +##### prop + +_DECLARATION_TITLE_PARTIAL_ + +## Type Aliases + +### TypeWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +#### Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[TYPE\_DOC](Document.TypeAlias.TYPE_DOC.md) + + + +‐ + +
+ +## Variables + +### variableWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +#### Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[VARIABLE\_DOC](Document.Variable.VARIABLE_DOC.md) + + + +‐ + +
+ +## Functions + +### functionWithDocuments() + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for functionWithDocuments + +#### Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[FUNCTION\_DOC\_1](Document.Function.FUNCTION_DOC_1.md) + + + +‐ + +
+ +_SIGNATURE_RETURNS_PARTIAL_ + +*** + +### multipleFunctionWithDocuments() + +Comments for multipleFunctionWithDocuments + +#### Documents + + + + + + + + + + + + + + + + + + + + + + +
DocumentDescription
+ +[FUNCTION\_DOC\_3](Document.Function.FUNCTION_DOC_3.md) + + + +‐ + +
+ +[FUNCTION\_DOC\_1](Document.Function.FUNCTION_DOC_1.md) + + + +‐ + +
+ +[FUNCTION\_DOC\_2](Document.Function.FUNCTION_DOC_2.md) + + + +‐ + +
+ +#### Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsA + +##### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ + +#### Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsB + +##### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments2.Document.MODULE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments2.Document.MODULE_DOC.md new file mode 100644 index 000000000..0405e97ff --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments2.Document.MODULE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](README.md) / [ModuleWithDocuments2](ModuleWithDocuments2.md) / MODULE\_DOC + +> Module Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments2.md new file mode 100644 index 000000000..652c9018d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/ModuleWithDocuments2.md @@ -0,0 +1,307 @@ +[typedoc-stubs](README.md) / ModuleWithDocuments2 + +# ModuleWithDocuments2 + +## Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[MODULE\_DOC](ModuleWithDocuments2.Document.MODULE_DOC.md) + + + +‐ + +
+ +## Enumerations + +### EnumWithDocuments + +#### Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[ENUM\_DOC](Document.Enumeration.ENUM_DOC.md) + + + +‐ + +
+ +#### Enumeration Members + +##### EnumMember + +_DECLARATION_TITLE_PARTIAL_ + +## Classes + +### ClassWithDocuments + +#### Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[CLASS\_DOC](Document.Class.CLASS_DOC.md) + + + +‐ + +
+ +#### Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ + +## Interfaces + +### InterfaceWithDocuments + +#### Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[INTERFACE\_DOC](Document.Interface.INTERFACE_DOC.md) + + + +‐ + +
+ +#### Properties + +##### prop + +_DECLARATION_TITLE_PARTIAL_ + +## Type Aliases + +### TypeWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +#### Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[TYPE\_DOC](Document.TypeAlias.TYPE_DOC.md) + + + +‐ + +
+ +## Variables + +### variableWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +#### Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[VARIABLE\_DOC](Document.Variable.VARIABLE_DOC.md) + + + +‐ + +
+ +## Functions + +### functionWithDocuments() + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for functionWithDocuments + +#### Documents + + + + + + + + + + + + + + +
DocumentDescription
+ +[FUNCTION\_DOC\_1](Document.Function.FUNCTION_DOC_1.md) + + + +‐ + +
+ +_SIGNATURE_RETURNS_PARTIAL_ + +*** + +### multipleFunctionWithDocuments() + +Comments for multipleFunctionWithDocuments + +#### Documents + + + + + + + + + + + + + + + + + + + + + + +
DocumentDescription
+ +[FUNCTION\_DOC\_3](Document.Function.FUNCTION_DOC_3.md) + + + +‐ + +
+ +[FUNCTION\_DOC\_1](Document.Function.FUNCTION_DOC_1.md) + + + +‐ + +
+ +[FUNCTION\_DOC\_2](Document.Function.FUNCTION_DOC_2.md) + + + +‐ + +
+ +#### Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsA + +##### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ + +#### Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsB + +##### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/README.md new file mode 100644 index 000000000..74664dd77 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/README.md @@ -0,0 +1,87 @@ +# typedoc-stubs + +## Documents + + + + + + + + + + + + + + + + + + + + + + +
DocumentDescription
+ +[Project Document 1](Document.Project-Document-1.md) + + + +A description of the document + +
+ +[docs/project/PROJECT\_DOC\_2](Document.docs.project.PROJECT_DOC_2.md) + + + +‐ + +
+ +[docs/project/PROJECT\_DOC\_3](Document.docs.project.PROJECT_DOC_3.md) + + + +‐ + +
+ +## Modules + + + + + + + + + + + + + + + + + + +
ModuleDescription
+ +[ModuleWithDocuments1](ModuleWithDocuments1.md) + + + +‐ + +
+ +[ModuleWithDocuments2](ModuleWithDocuments2.md) + + + +‐ + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/sidebar.json new file mode 100644 index 000000000..d28b185a1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documents/modules/opts-2/sidebar.json @@ -0,0 +1,63 @@ +[ + { + "title": "Documents", + "children": [ + { + "title": "Project Document 1", + "kind": 8388608, + "path": "Document.Project-Document-1.md" + }, + { + "title": "docs/project/PROJECT_DOC_2", + "kind": 8388608, + "path": "Document.docs.project.PROJECT_DOC_2.md" + }, + { + "title": "docs/project/PROJECT_DOC_3", + "kind": 8388608, + "path": "Document.docs.project.PROJECT_DOC_3.md" + } + ] + }, + { + "title": "ModuleWithDocuments1", + "kind": 2, + "path": "ModuleWithDocuments1.md", + "children": [ + { + "title": "MODULE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1.Document.MODULE_DOC.md" + }, + { + "title": "Namespaces", + "children": [ + { + "title": "NamespaceWithDocuments", + "kind": 4, + "path": "ModuleWithDocuments1.Namespace.NamespaceWithDocuments.md", + "children": [ + { + "title": "NAMESPACE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1.NamespaceWithDocuments.Document.NAMESPACE_DOC.md" + } + ] + } + ] + } + ] + }, + { + "title": "ModuleWithDocuments2", + "kind": 2, + "path": "ModuleWithDocuments2.md", + "children": [ + { + "title": "MODULE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments2.Document.MODULE_DOC.md" + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/README.md new file mode 100644 index 000000000..83eb0a240 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/README.md @@ -0,0 +1,36 @@ +[typedoc-stubs](../README.md) / ModuleWithDocuments1 + +# ModuleWithDocuments1 + +## Documents + +- [MODULE\_DOC](documents/MODULE_DOC.md) + +## Namespaces + +- [NamespaceWithDocuments](namespaces/NamespaceWithDocuments/README.md) + +## Enumerations + +- [EnumWithDocuments](enumerations/EnumWithDocuments.md) + +## Classes + +- [ClassWithDocuments](classes/ClassWithDocuments.md) + +## Interfaces + +- [InterfaceWithDocuments](interfaces/InterfaceWithDocuments.md) + +## Type Aliases + +- [TypeWithDocuments](type-aliases/TypeWithDocuments.md) + +## Variables + +- [variableWithDocuments](variables/variableWithDocuments.md) + +## Functions + +- [functionWithDocuments](functions/functionWithDocuments.md) +- [multipleFunctionWithDocuments](functions/multipleFunctionWithDocuments.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/classes/ClassWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/classes/ClassWithDocuments.md new file mode 100644 index 000000000..1783eafea --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/classes/ClassWithDocuments.md @@ -0,0 +1,11 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / ClassWithDocuments + +# Class: ClassWithDocuments + +## Documents + +- [CLASS\_DOC](documents/CLASS_DOC.md) + +## Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/classes/documents/CLASS_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/classes/documents/CLASS_DOC.md new file mode 100644 index 000000000..108646210 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/classes/documents/CLASS_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [ClassWithDocuments](../ClassWithDocuments.md) / CLASS\_DOC + +> Class Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/documents/MODULE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/documents/MODULE_DOC.md new file mode 100644 index 000000000..d6ea144e7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/documents/MODULE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / MODULE\_DOC + +> Module Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/enumerations/EnumWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/enumerations/EnumWithDocuments.md new file mode 100644 index 000000000..118e6f629 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/enumerations/EnumWithDocuments.md @@ -0,0 +1,13 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / EnumWithDocuments + +# Enumeration: EnumWithDocuments + +## Documents + +- [ENUM\_DOC](documents/ENUM_DOC.md) + +## Enumeration Members + +### EnumMember + +_DECLARATION_TITLE_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/enumerations/documents/ENUM_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/enumerations/documents/ENUM_DOC.md new file mode 100644 index 000000000..977641737 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/enumerations/documents/ENUM_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [EnumWithDocuments](../EnumWithDocuments.md) / ENUM\_DOC + +> Enum Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_1.md new file mode 100644 index 000000000..16a0aea49 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [multipleFunctionWithDocuments](../multipleFunctionWithDocuments.md) / FUNCTION\_DOC\_1 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_2.md new file mode 100644 index 000000000..f2896d520 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_2.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [multipleFunctionWithDocuments](../multipleFunctionWithDocuments.md) / FUNCTION\_DOC\_2 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_3.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_3.md new file mode 100644 index 000000000..d7ab672f0 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_3.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [multipleFunctionWithDocuments](../multipleFunctionWithDocuments.md) / FUNCTION\_DOC\_3 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/functionWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/functionWithDocuments.md new file mode 100644 index 000000000..ea7b41223 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/functionWithDocuments.md @@ -0,0 +1,13 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / functionWithDocuments + +# Function: functionWithDocuments() + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for functionWithDocuments + +## Documents + +- [FUNCTION\_DOC\_1](documents/FUNCTION_DOC_1.md) + +_SIGNATURE_RETURNS_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/multipleFunctionWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/multipleFunctionWithDocuments.md new file mode 100644 index 000000000..bec3fa11d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/functions/multipleFunctionWithDocuments.md @@ -0,0 +1,35 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / multipleFunctionWithDocuments + +# Function: multipleFunctionWithDocuments() + +Comments for multipleFunctionWithDocuments + +## Documents + +- [FUNCTION\_DOC\_3](documents/FUNCTION_DOC_3.md) +- [FUNCTION\_DOC\_1](documents/FUNCTION_DOC_1.md) +- [FUNCTION\_DOC\_2](documents/FUNCTION_DOC_2.md) + +## Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsA + +### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ + +## Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsB + +### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/interfaces/InterfaceWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/interfaces/InterfaceWithDocuments.md new file mode 100644 index 000000000..71a35e667 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/interfaces/InterfaceWithDocuments.md @@ -0,0 +1,13 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / InterfaceWithDocuments + +# Interface: InterfaceWithDocuments + +## Documents + +- [INTERFACE\_DOC](documents/INTERFACE_DOC.md) + +## Properties + +### prop + +_DECLARATION_TITLE_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/interfaces/documents/INTERFACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/interfaces/documents/INTERFACE_DOC.md new file mode 100644 index 000000000..2250a3def --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/interfaces/documents/INTERFACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [InterfaceWithDocuments](../InterfaceWithDocuments.md) / INTERFACE\_DOC + +> Interface Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md new file mode 100644 index 000000000..070169d87 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md @@ -0,0 +1,11 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / NamespaceWithDocuments + +# NamespaceWithDocuments + +## Documents + +- [NAMESPACE\_DOC](documents/NAMESPACE_DOC.md) + +## Classes + +- [NamespaceClassWithDocuments](classes/NamespaceClassWithDocuments.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/NamespaceClassWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/NamespaceClassWithDocuments.md new file mode 100644 index 000000000..3f84f9d22 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/NamespaceClassWithDocuments.md @@ -0,0 +1,11 @@ +[typedoc-stubs](../../../../README.md) / [ModuleWithDocuments1](../../../README.md) / [NamespaceWithDocuments](../README.md) / NamespaceClassWithDocuments + +# Class: NamespaceClassWithDocuments + +## Documents + +- [CLASS\_DOC](documents/CLASS_DOC.md) + +## Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/documents/CLASS_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/documents/CLASS_DOC.md new file mode 100644 index 000000000..b25c1708c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/documents/CLASS_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../../../README.md) / [ModuleWithDocuments1](../../../../README.md) / [NamespaceWithDocuments](../../README.md) / [NamespaceClassWithDocuments](../NamespaceClassWithDocuments.md) / CLASS\_DOC + +> Class Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md new file mode 100644 index 000000000..a6fb21660 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../../README.md) / [ModuleWithDocuments1](../../../README.md) / [NamespaceWithDocuments](../README.md) / NAMESPACE\_DOC + +> Namespace Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/type-aliases/TypeWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/type-aliases/TypeWithDocuments.md new file mode 100644 index 000000000..410714de6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/type-aliases/TypeWithDocuments.md @@ -0,0 +1,9 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / TypeWithDocuments + +# Type Alias: TypeWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +## Documents + +- [TYPE\_DOC](documents/TYPE_DOC.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/type-aliases/documents/TYPE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/type-aliases/documents/TYPE_DOC.md new file mode 100644 index 000000000..771e62641 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/type-aliases/documents/TYPE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [TypeWithDocuments](../TypeWithDocuments.md) / TYPE\_DOC + +> Type Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/variables/documents/VARIABLE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/variables/documents/VARIABLE_DOC.md new file mode 100644 index 000000000..6623c4476 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/variables/documents/VARIABLE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [variableWithDocuments](../variableWithDocuments.md) / VARIABLE\_DOC + +> Variable Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/variables/variableWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/variables/variableWithDocuments.md new file mode 100644 index 000000000..2a047a6c9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/ModuleWithDocuments1/variables/variableWithDocuments.md @@ -0,0 +1,9 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / variableWithDocuments + +# Variable: variableWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +## Documents + +- [VARIABLE\_DOC](documents/VARIABLE_DOC.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/README.md new file mode 100644 index 000000000..cd7d49d82 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/README.md @@ -0,0 +1,9 @@ +# typedoc-stubs + +## Documents + +- [Project Document 1](documents/Project-Document-1.md) + +## Modules + +- [ModuleWithDocuments1](ModuleWithDocuments1/README.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/documents/Project-Document-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/documents/Project-Document-1.md new file mode 100644 index 000000000..bee850405 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/documents/Project-Document-1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../README.md) / Project Document 1 + +## Project Document 1 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/sidebar.json new file mode 100644 index 000000000..6a47059fe --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-1/sidebar.json @@ -0,0 +1,172 @@ +[ + { + "title": "Documents", + "children": [ + { + "title": "Project Document 1", + "kind": 8388608, + "path": "documents/Project-Document-1.md" + } + ] + }, + { + "title": "ModuleWithDocuments1", + "kind": 2, + "path": "ModuleWithDocuments1/README.md", + "children": [ + { + "title": "MODULE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/documents/MODULE_DOC.md" + }, + { + "title": "Namespaces", + "children": [ + { + "title": "NamespaceWithDocuments", + "kind": 4, + "path": "ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md", + "children": [ + { + "title": "NAMESPACE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md" + }, + { + "title": "Classes", + "children": [ + { + "title": "NamespaceClassWithDocuments", + "kind": 128, + "path": "ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/NamespaceClassWithDocuments.md", + "children": [ + { + "title": "CLASS_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/documents/CLASS_DOC.md" + } + ] + } + ] + } + ] + } + ] + }, + { + "title": "Enumerations", + "children": [ + { + "title": "EnumWithDocuments", + "kind": 8, + "path": "ModuleWithDocuments1/enumerations/EnumWithDocuments.md", + "children": [ + { + "title": "ENUM_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/enumerations/documents/ENUM_DOC.md" + } + ] + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassWithDocuments", + "kind": 128, + "path": "ModuleWithDocuments1/classes/ClassWithDocuments.md", + "children": [ + { + "title": "CLASS_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/classes/documents/CLASS_DOC.md" + } + ] + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceWithDocuments", + "kind": 256, + "path": "ModuleWithDocuments1/interfaces/InterfaceWithDocuments.md", + "children": [ + { + "title": "INTERFACE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/interfaces/documents/INTERFACE_DOC.md" + } + ] + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeWithDocuments", + "kind": 2097152, + "path": "ModuleWithDocuments1/type-aliases/TypeWithDocuments.md", + "children": [ + { + "title": "TYPE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/type-aliases/documents/TYPE_DOC.md" + } + ] + } + ] + }, + { + "title": "Variables", + "children": [ + { + "title": "variableWithDocuments", + "kind": 32, + "path": "ModuleWithDocuments1/variables/variableWithDocuments.md", + "children": [ + { + "title": "VARIABLE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/variables/documents/VARIABLE_DOC.md" + } + ] + } + ] + }, + { + "title": "Functions", + "children": [ + { + "title": "functionWithDocuments", + "kind": 64, + "path": "ModuleWithDocuments1/functions/functionWithDocuments.md", + "children": [ + { + "title": "FUNCTION_DOC_1", + "kind": 8388608, + "path": "ModuleWithDocuments1/functions/documents/FUNCTION_DOC_1.md" + } + ] + }, + { + "title": "multipleFunctionWithDocuments", + "kind": 64, + "path": "ModuleWithDocuments1/functions/multipleFunctionWithDocuments.md", + "children": [ + { + "title": "FUNCTION_DOC_3", + "kind": 8388608, + "path": "ModuleWithDocuments1/functions/documents/FUNCTION_DOC_3.md" + } + ] + } + ] + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/README.md new file mode 100644 index 000000000..846c9eb8f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/README.md @@ -0,0 +1,52 @@ +[typedoc-stubs](../README.md) / ModuleWithDocuments1 + +# ModuleWithDocuments1 + +## Documents + +| Document | Description | +| ------ | ------ | +| [MODULE\_DOC](documents/MODULE_DOC.md) | - | + +## Namespaces + +| Namespace | Description | +| ------ | ------ | +| [NamespaceWithDocuments](namespaces/NamespaceWithDocuments/README.md) | - | + +## Enumerations + +| Enumeration | Description | +| ------ | ------ | +| [EnumWithDocuments](enumerations/EnumWithDocuments.md) | - | + +## Classes + +| Class | Description | +| ------ | ------ | +| [ClassWithDocuments](classes/ClassWithDocuments.md) | - | + +## Interfaces + +| Interface | Description | +| ------ | ------ | +| [InterfaceWithDocuments](interfaces/InterfaceWithDocuments.md) | - | + +## Type Aliases + +| Type alias | Description | +| ------ | ------ | +| [TypeWithDocuments](type-aliases/TypeWithDocuments.md) | - | + +## Variables + +| Variable | Description | +| ------ | ------ | +| [variableWithDocuments](variables/variableWithDocuments.md) | - | + +## Functions + +| Function | Description | +| ------ | ------ | +| [functionWithDocuments](functions/functionWithDocuments.md) | Comments for functionWithDocuments | +| [multipleFunctionWithDocuments](functions/multipleFunctionWithDocuments.md) | Comments for multipleFunctionWithDocuments | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/classes/ClassWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/classes/ClassWithDocuments.md new file mode 100644 index 000000000..6f2b1bf96 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/classes/ClassWithDocuments.md @@ -0,0 +1,13 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / ClassWithDocuments + +# Class: ClassWithDocuments + +## Documents + +| Document | Description | +| ------ | ------ | +| [CLASS\_DOC](documents/CLASS_DOC.md) | - | + +## Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/classes/documents/CLASS_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/classes/documents/CLASS_DOC.md new file mode 100644 index 000000000..108646210 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/classes/documents/CLASS_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [ClassWithDocuments](../ClassWithDocuments.md) / CLASS\_DOC + +> Class Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/documents/MODULE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/documents/MODULE_DOC.md new file mode 100644 index 000000000..d6ea144e7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/documents/MODULE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / MODULE\_DOC + +> Module Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/enumerations/EnumWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/enumerations/EnumWithDocuments.md new file mode 100644 index 000000000..e013056a3 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/enumerations/EnumWithDocuments.md @@ -0,0 +1,15 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / EnumWithDocuments + +# Enumeration: EnumWithDocuments + +## Documents + +| Document | Description | +| ------ | ------ | +| [ENUM\_DOC](documents/ENUM_DOC.md) | - | + +## Enumeration Members + +### EnumMember + +_DECLARATION_TITLE_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/enumerations/documents/ENUM_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/enumerations/documents/ENUM_DOC.md new file mode 100644 index 000000000..977641737 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/enumerations/documents/ENUM_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [EnumWithDocuments](../EnumWithDocuments.md) / ENUM\_DOC + +> Enum Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_1.md new file mode 100644 index 000000000..16a0aea49 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [multipleFunctionWithDocuments](../multipleFunctionWithDocuments.md) / FUNCTION\_DOC\_1 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_2.md new file mode 100644 index 000000000..f2896d520 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_2.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [multipleFunctionWithDocuments](../multipleFunctionWithDocuments.md) / FUNCTION\_DOC\_2 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_3.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_3.md new file mode 100644 index 000000000..d7ab672f0 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/documents/FUNCTION_DOC_3.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [multipleFunctionWithDocuments](../multipleFunctionWithDocuments.md) / FUNCTION\_DOC\_3 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/functionWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/functionWithDocuments.md new file mode 100644 index 000000000..feb76b4ee --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/functionWithDocuments.md @@ -0,0 +1,15 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / functionWithDocuments + +# Function: functionWithDocuments() + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for functionWithDocuments + +## Documents + +| Document | Description | +| ------ | ------ | +| [FUNCTION\_DOC\_1](documents/FUNCTION_DOC_1.md) | - | + +_SIGNATURE_RETURNS_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/multipleFunctionWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/multipleFunctionWithDocuments.md new file mode 100644 index 000000000..78a151520 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/functions/multipleFunctionWithDocuments.md @@ -0,0 +1,37 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / multipleFunctionWithDocuments + +# Function: multipleFunctionWithDocuments() + +Comments for multipleFunctionWithDocuments + +## Documents + +| Document | Description | +| ------ | ------ | +| [FUNCTION\_DOC\_3](documents/FUNCTION_DOC_3.md) | - | +| [FUNCTION\_DOC\_1](documents/FUNCTION_DOC_1.md) | - | +| [FUNCTION\_DOC\_2](documents/FUNCTION_DOC_2.md) | - | + +## Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsA + +### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ + +## Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsB + +### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/interfaces/InterfaceWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/interfaces/InterfaceWithDocuments.md new file mode 100644 index 000000000..66a084bfd --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/interfaces/InterfaceWithDocuments.md @@ -0,0 +1,15 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / InterfaceWithDocuments + +# Interface: InterfaceWithDocuments + +## Documents + +| Document | Description | +| ------ | ------ | +| [INTERFACE\_DOC](documents/INTERFACE_DOC.md) | - | + +## Properties + +### prop + +_DECLARATION_TITLE_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/interfaces/documents/INTERFACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/interfaces/documents/INTERFACE_DOC.md new file mode 100644 index 000000000..2250a3def --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/interfaces/documents/INTERFACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [InterfaceWithDocuments](../InterfaceWithDocuments.md) / INTERFACE\_DOC + +> Interface Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md new file mode 100644 index 000000000..af8576fd5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md @@ -0,0 +1,15 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / NamespaceWithDocuments + +# NamespaceWithDocuments + +## Documents + +| Document | Description | +| ------ | ------ | +| [NAMESPACE\_DOC](documents/NAMESPACE_DOC.md) | - | + +## Classes + +| Class | Description | +| ------ | ------ | +| [NamespaceClassWithDocuments](classes/NamespaceClassWithDocuments.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/NamespaceClassWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/NamespaceClassWithDocuments.md new file mode 100644 index 000000000..70591e518 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/NamespaceClassWithDocuments.md @@ -0,0 +1,13 @@ +[typedoc-stubs](../../../../README.md) / [ModuleWithDocuments1](../../../README.md) / [NamespaceWithDocuments](../README.md) / NamespaceClassWithDocuments + +# Class: NamespaceClassWithDocuments + +## Documents + +| Document | Description | +| ------ | ------ | +| [CLASS\_DOC](documents/CLASS_DOC.md) | - | + +## Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/documents/CLASS_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/documents/CLASS_DOC.md new file mode 100644 index 000000000..b25c1708c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/documents/CLASS_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../../../README.md) / [ModuleWithDocuments1](../../../../README.md) / [NamespaceWithDocuments](../../README.md) / [NamespaceClassWithDocuments](../NamespaceClassWithDocuments.md) / CLASS\_DOC + +> Class Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md new file mode 100644 index 000000000..a6fb21660 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../../README.md) / [ModuleWithDocuments1](../../../README.md) / [NamespaceWithDocuments](../README.md) / NAMESPACE\_DOC + +> Namespace Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/type-aliases/TypeWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/type-aliases/TypeWithDocuments.md new file mode 100644 index 000000000..a4de8f1d5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/type-aliases/TypeWithDocuments.md @@ -0,0 +1,11 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / TypeWithDocuments + +# Type Alias: TypeWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +## Documents + +| Document | Description | +| ------ | ------ | +| [TYPE\_DOC](documents/TYPE_DOC.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/type-aliases/documents/TYPE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/type-aliases/documents/TYPE_DOC.md new file mode 100644 index 000000000..771e62641 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/type-aliases/documents/TYPE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [TypeWithDocuments](../TypeWithDocuments.md) / TYPE\_DOC + +> Type Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/variables/documents/VARIABLE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/variables/documents/VARIABLE_DOC.md new file mode 100644 index 000000000..6623c4476 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/variables/documents/VARIABLE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / [variableWithDocuments](../variableWithDocuments.md) / VARIABLE\_DOC + +> Variable Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/variables/variableWithDocuments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/variables/variableWithDocuments.md new file mode 100644 index 000000000..a3951b95b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/ModuleWithDocuments1/variables/variableWithDocuments.md @@ -0,0 +1,11 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / variableWithDocuments + +# Variable: variableWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +## Documents + +| Document | Description | +| ------ | ------ | +| [VARIABLE\_DOC](documents/VARIABLE_DOC.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/README.md new file mode 100644 index 000000000..528b328d1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/README.md @@ -0,0 +1,13 @@ +# typedoc-stubs + +## Documents + +| Document | Description | +| ------ | ------ | +| [Project Document 1](documents/Project-Document-1.md) | A description of the document | + +## Modules + +| Module | Description | +| ------ | ------ | +| [ModuleWithDocuments1](ModuleWithDocuments1/README.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/documents/Project-Document-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/documents/Project-Document-1.md new file mode 100644 index 000000000..bee850405 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/documents/Project-Document-1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../README.md) / Project Document 1 + +## Project Document 1 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/sidebar.json new file mode 100644 index 000000000..6a47059fe --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/members/opts-2/sidebar.json @@ -0,0 +1,172 @@ +[ + { + "title": "Documents", + "children": [ + { + "title": "Project Document 1", + "kind": 8388608, + "path": "documents/Project-Document-1.md" + } + ] + }, + { + "title": "ModuleWithDocuments1", + "kind": 2, + "path": "ModuleWithDocuments1/README.md", + "children": [ + { + "title": "MODULE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/documents/MODULE_DOC.md" + }, + { + "title": "Namespaces", + "children": [ + { + "title": "NamespaceWithDocuments", + "kind": 4, + "path": "ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md", + "children": [ + { + "title": "NAMESPACE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md" + }, + { + "title": "Classes", + "children": [ + { + "title": "NamespaceClassWithDocuments", + "kind": 128, + "path": "ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/NamespaceClassWithDocuments.md", + "children": [ + { + "title": "CLASS_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/namespaces/NamespaceWithDocuments/classes/documents/CLASS_DOC.md" + } + ] + } + ] + } + ] + } + ] + }, + { + "title": "Enumerations", + "children": [ + { + "title": "EnumWithDocuments", + "kind": 8, + "path": "ModuleWithDocuments1/enumerations/EnumWithDocuments.md", + "children": [ + { + "title": "ENUM_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/enumerations/documents/ENUM_DOC.md" + } + ] + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassWithDocuments", + "kind": 128, + "path": "ModuleWithDocuments1/classes/ClassWithDocuments.md", + "children": [ + { + "title": "CLASS_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/classes/documents/CLASS_DOC.md" + } + ] + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceWithDocuments", + "kind": 256, + "path": "ModuleWithDocuments1/interfaces/InterfaceWithDocuments.md", + "children": [ + { + "title": "INTERFACE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/interfaces/documents/INTERFACE_DOC.md" + } + ] + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeWithDocuments", + "kind": 2097152, + "path": "ModuleWithDocuments1/type-aliases/TypeWithDocuments.md", + "children": [ + { + "title": "TYPE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/type-aliases/documents/TYPE_DOC.md" + } + ] + } + ] + }, + { + "title": "Variables", + "children": [ + { + "title": "variableWithDocuments", + "kind": 32, + "path": "ModuleWithDocuments1/variables/variableWithDocuments.md", + "children": [ + { + "title": "VARIABLE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/variables/documents/VARIABLE_DOC.md" + } + ] + } + ] + }, + { + "title": "Functions", + "children": [ + { + "title": "functionWithDocuments", + "kind": 64, + "path": "ModuleWithDocuments1/functions/functionWithDocuments.md", + "children": [ + { + "title": "FUNCTION_DOC_1", + "kind": 8388608, + "path": "ModuleWithDocuments1/functions/documents/FUNCTION_DOC_1.md" + } + ] + }, + { + "title": "multipleFunctionWithDocuments", + "kind": 64, + "path": "ModuleWithDocuments1/functions/multipleFunctionWithDocuments.md", + "children": [ + { + "title": "FUNCTION_DOC_3", + "kind": 8388608, + "path": "ModuleWithDocuments1/functions/documents/FUNCTION_DOC_3.md" + } + ] + } + ] + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/README.md new file mode 100644 index 000000000..0b77a66cc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/README.md @@ -0,0 +1,121 @@ +[typedoc-stubs](../README.md) / ModuleWithDocuments1 + +# ModuleWithDocuments1 + +## Documents + +- [MODULE\_DOC](documents/MODULE_DOC.md) + +## Namespaces + +- [NamespaceWithDocuments](namespaces/NamespaceWithDocuments/README.md) + +## Enumerations + +### EnumWithDocuments + +#### Documents + +- [ENUM\_DOC](documents/Enumeration.ENUM_DOC.md) + +#### Enumeration Members + +##### EnumMember + +_DECLARATION_TITLE_PARTIAL_ + +## Classes + +### ClassWithDocuments + +#### Documents + +- [CLASS\_DOC](documents/Class.CLASS_DOC.md) + +#### Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ + +## Interfaces + +### InterfaceWithDocuments + +#### Documents + +- [INTERFACE\_DOC](documents/Interface.INTERFACE_DOC.md) + +#### Properties + +##### prop + +_DECLARATION_TITLE_PARTIAL_ + +## Type Aliases + +### TypeWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +#### Documents + +- [TYPE\_DOC](documents/TypeAlias.TYPE_DOC.md) + +## Variables + +### variableWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +#### Documents + +- [VARIABLE\_DOC](documents/Variable.VARIABLE_DOC.md) + +## Functions + +### functionWithDocuments() + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for functionWithDocuments + +#### Documents + +- [FUNCTION\_DOC\_1](documents/Function.FUNCTION_DOC_1.md) + +_SIGNATURE_RETURNS_PARTIAL_ + +*** + +### multipleFunctionWithDocuments() + +Comments for multipleFunctionWithDocuments + +#### Documents + +- [FUNCTION\_DOC\_3](documents/Function.FUNCTION_DOC_3.md) +- [FUNCTION\_DOC\_1](documents/Function.FUNCTION_DOC_1.md) +- [FUNCTION\_DOC\_2](documents/Function.FUNCTION_DOC_2.md) + +#### Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsA + +##### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ + +#### Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsB + +##### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Class.CLASS_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Class.CLASS_DOC.md new file mode 100644 index 000000000..33c59d9d5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Class.CLASS_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [ClassWithDocuments](../README.md#classwithdocuments) / CLASS\_DOC + +> Class Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Enumeration.ENUM_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Enumeration.ENUM_DOC.md new file mode 100644 index 000000000..a791f4476 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Enumeration.ENUM_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [EnumWithDocuments](../README.md#enumwithdocuments) / ENUM\_DOC + +> Enum Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_1.md new file mode 100644 index 000000000..5ececbdce --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [multipleFunctionWithDocuments](../README.md#multiplefunctionwithdocuments) / FUNCTION\_DOC\_1 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_2.md new file mode 100644 index 000000000..143177743 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_2.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [multipleFunctionWithDocuments](../README.md#multiplefunctionwithdocuments) / FUNCTION\_DOC\_2 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_3.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_3.md new file mode 100644 index 000000000..775b4fe8e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_3.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [multipleFunctionWithDocuments](../README.md#multiplefunctionwithdocuments) / FUNCTION\_DOC\_3 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Interface.INTERFACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Interface.INTERFACE_DOC.md new file mode 100644 index 000000000..7c35209a2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Interface.INTERFACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [InterfaceWithDocuments](../README.md#interfacewithdocuments) / INTERFACE\_DOC + +> Interface Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/MODULE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/MODULE_DOC.md new file mode 100644 index 000000000..d6ea144e7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/MODULE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / MODULE\_DOC + +> Module Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/TypeAlias.TYPE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/TypeAlias.TYPE_DOC.md new file mode 100644 index 000000000..bc67da96b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/TypeAlias.TYPE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [TypeWithDocuments](../README.md#typewithdocuments) / TYPE\_DOC + +> Type Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Variable.VARIABLE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Variable.VARIABLE_DOC.md new file mode 100644 index 000000000..b6f4725eb --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/documents/Variable.VARIABLE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [variableWithDocuments](../README.md#variablewithdocuments) / VARIABLE\_DOC + +> Variable Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md new file mode 100644 index 000000000..1f0a3654c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md @@ -0,0 +1,19 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / NamespaceWithDocuments + +# NamespaceWithDocuments + +## Documents + +- [NAMESPACE\_DOC](documents/NAMESPACE_DOC.md) + +## Classes + +### NamespaceClassWithDocuments + +#### Documents + +- [CLASS\_DOC](documents/Class.CLASS_DOC.md) + +#### Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/Class.CLASS_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/Class.CLASS_DOC.md new file mode 100644 index 000000000..151697535 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/Class.CLASS_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../../README.md) / [ModuleWithDocuments1](../../../README.md) / [NamespaceWithDocuments](../README.md) / [NamespaceClassWithDocuments](../README.md#namespaceclasswithdocuments) / CLASS\_DOC + +> Class Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md new file mode 100644 index 000000000..a6fb21660 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../../README.md) / [ModuleWithDocuments1](../../../README.md) / [NamespaceWithDocuments](../README.md) / NAMESPACE\_DOC + +> Namespace Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/README.md new file mode 100644 index 000000000..cd7d49d82 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/README.md @@ -0,0 +1,9 @@ +# typedoc-stubs + +## Documents + +- [Project Document 1](documents/Project-Document-1.md) + +## Modules + +- [ModuleWithDocuments1](ModuleWithDocuments1/README.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/documents/Project-Document-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/documents/Project-Document-1.md new file mode 100644 index 000000000..bee850405 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/documents/Project-Document-1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../README.md) / Project Document 1 + +## Project Document 1 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/sidebar.json new file mode 100644 index 000000000..7b0c3040d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-1/sidebar.json @@ -0,0 +1,41 @@ +[ + { + "title": "Documents", + "children": [ + { + "title": "Project Document 1", + "kind": 8388608, + "path": "documents/Project-Document-1.md" + } + ] + }, + { + "title": "ModuleWithDocuments1", + "kind": 2, + "path": "ModuleWithDocuments1/README.md", + "children": [ + { + "title": "MODULE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/documents/MODULE_DOC.md" + }, + { + "title": "Namespaces", + "children": [ + { + "title": "NamespaceWithDocuments", + "kind": 4, + "path": "ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md", + "children": [ + { + "title": "NAMESPACE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md" + } + ] + } + ] + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/README.md new file mode 100644 index 000000000..8c2ce2d15 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/README.md @@ -0,0 +1,139 @@ +[typedoc-stubs](../README.md) / ModuleWithDocuments1 + +# ModuleWithDocuments1 + +## Documents + +| Document | Description | +| ------ | ------ | +| [MODULE\_DOC](documents/MODULE_DOC.md) | - | + +## Namespaces + +| Namespace | Description | +| ------ | ------ | +| [NamespaceWithDocuments](namespaces/NamespaceWithDocuments/README.md) | - | + +## Enumerations + +### EnumWithDocuments + +#### Documents + +| Document | Description | +| ------ | ------ | +| [ENUM\_DOC](documents/Enumeration.ENUM_DOC.md) | - | + +#### Enumeration Members + +##### EnumMember + +_DECLARATION_TITLE_PARTIAL_ + +## Classes + +### ClassWithDocuments + +#### Documents + +| Document | Description | +| ------ | ------ | +| [CLASS\_DOC](documents/Class.CLASS_DOC.md) | - | + +#### Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ + +## Interfaces + +### InterfaceWithDocuments + +#### Documents + +| Document | Description | +| ------ | ------ | +| [INTERFACE\_DOC](documents/Interface.INTERFACE_DOC.md) | - | + +#### Properties + +##### prop + +_DECLARATION_TITLE_PARTIAL_ + +## Type Aliases + +### TypeWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +#### Documents + +| Document | Description | +| ------ | ------ | +| [TYPE\_DOC](documents/TypeAlias.TYPE_DOC.md) | - | + +## Variables + +### variableWithDocuments + +_DECLARATION_TITLE_PARTIAL_ + +#### Documents + +| Document | Description | +| ------ | ------ | +| [VARIABLE\_DOC](documents/Variable.VARIABLE_DOC.md) | - | + +## Functions + +### functionWithDocuments() + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for functionWithDocuments + +#### Documents + +| Document | Description | +| ------ | ------ | +| [FUNCTION\_DOC\_1](documents/Function.FUNCTION_DOC_1.md) | - | + +_SIGNATURE_RETURNS_PARTIAL_ + +*** + +### multipleFunctionWithDocuments() + +Comments for multipleFunctionWithDocuments + +#### Documents + +| Document | Description | +| ------ | ------ | +| [FUNCTION\_DOC\_3](documents/Function.FUNCTION_DOC_3.md) | - | +| [FUNCTION\_DOC\_1](documents/Function.FUNCTION_DOC_1.md) | - | +| [FUNCTION\_DOC\_2](documents/Function.FUNCTION_DOC_2.md) | - | + +#### Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsA + +##### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ + +#### Call Signature + +_SIGNATURE_TITLE_PARTIAL_ + +Comments for multipleFunctionWithDocumentsB + +##### Parameters + +_PARAMETERS_LIST_PARTIAL_ + +_SIGNATURE_RETURNS_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Class.CLASS_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Class.CLASS_DOC.md new file mode 100644 index 000000000..33c59d9d5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Class.CLASS_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [ClassWithDocuments](../README.md#classwithdocuments) / CLASS\_DOC + +> Class Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Enumeration.ENUM_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Enumeration.ENUM_DOC.md new file mode 100644 index 000000000..a791f4476 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Enumeration.ENUM_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [EnumWithDocuments](../README.md#enumwithdocuments) / ENUM\_DOC + +> Enum Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_1.md new file mode 100644 index 000000000..5ececbdce --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [multipleFunctionWithDocuments](../README.md#multiplefunctionwithdocuments) / FUNCTION\_DOC\_1 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_2.md new file mode 100644 index 000000000..143177743 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_2.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [multipleFunctionWithDocuments](../README.md#multiplefunctionwithdocuments) / FUNCTION\_DOC\_2 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_3.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_3.md new file mode 100644 index 000000000..775b4fe8e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Function.FUNCTION_DOC_3.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [multipleFunctionWithDocuments](../README.md#multiplefunctionwithdocuments) / FUNCTION\_DOC\_3 + +> Function Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Interface.INTERFACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Interface.INTERFACE_DOC.md new file mode 100644 index 000000000..7c35209a2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Interface.INTERFACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [InterfaceWithDocuments](../README.md#interfacewithdocuments) / INTERFACE\_DOC + +> Interface Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/MODULE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/MODULE_DOC.md new file mode 100644 index 000000000..d6ea144e7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/MODULE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / MODULE\_DOC + +> Module Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/TypeAlias.TYPE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/TypeAlias.TYPE_DOC.md new file mode 100644 index 000000000..bc67da96b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/TypeAlias.TYPE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [TypeWithDocuments](../README.md#typewithdocuments) / TYPE\_DOC + +> Type Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Variable.VARIABLE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Variable.VARIABLE_DOC.md new file mode 100644 index 000000000..b6f4725eb --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/documents/Variable.VARIABLE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../README.md) / [ModuleWithDocuments1](../README.md) / [variableWithDocuments](../README.md#variablewithdocuments) / VARIABLE\_DOC + +> Variable Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md new file mode 100644 index 000000000..20b6d9788 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md @@ -0,0 +1,23 @@ +[typedoc-stubs](../../../README.md) / [ModuleWithDocuments1](../../README.md) / NamespaceWithDocuments + +# NamespaceWithDocuments + +## Documents + +| Document | Description | +| ------ | ------ | +| [NAMESPACE\_DOC](documents/NAMESPACE_DOC.md) | - | + +## Classes + +### NamespaceClassWithDocuments + +#### Documents + +| Document | Description | +| ------ | ------ | +| [CLASS\_DOC](documents/Class.CLASS_DOC.md) | - | + +#### Constructors + +_CONSTRUCTOR_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/Class.CLASS_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/Class.CLASS_DOC.md new file mode 100644 index 000000000..151697535 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/Class.CLASS_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../../README.md) / [ModuleWithDocuments1](../../../README.md) / [NamespaceWithDocuments](../README.md) / [NamespaceClassWithDocuments](../README.md#namespaceclasswithdocuments) / CLASS\_DOC + +> Class Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md new file mode 100644 index 000000000..a6fb21660 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../../../../README.md) / [ModuleWithDocuments1](../../../README.md) / [NamespaceWithDocuments](../README.md) / NAMESPACE\_DOC + +> Namespace Documentation + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/README.md new file mode 100644 index 000000000..528b328d1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/README.md @@ -0,0 +1,13 @@ +# typedoc-stubs + +## Documents + +| Document | Description | +| ------ | ------ | +| [Project Document 1](documents/Project-Document-1.md) | A description of the document | + +## Modules + +| Module | Description | +| ------ | ------ | +| [ModuleWithDocuments1](ModuleWithDocuments1/README.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/documents/Project-Document-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/documents/Project-Document-1.md new file mode 100644 index 000000000..bee850405 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/documents/Project-Document-1.md @@ -0,0 +1,5 @@ +[typedoc-stubs](../README.md) / Project Document 1 + +## Project Document 1 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/sidebar.json new file mode 100644 index 000000000..7b0c3040d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/documentsSingleModule/modules/opts-2/sidebar.json @@ -0,0 +1,41 @@ +[ + { + "title": "Documents", + "children": [ + { + "title": "Project Document 1", + "kind": 8388608, + "path": "documents/Project-Document-1.md" + } + ] + }, + { + "title": "ModuleWithDocuments1", + "kind": 2, + "path": "ModuleWithDocuments1/README.md", + "children": [ + { + "title": "MODULE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/documents/MODULE_DOC.md" + }, + { + "title": "Namespaces", + "children": [ + { + "title": "NamespaceWithDocuments", + "kind": 4, + "path": "ModuleWithDocuments1/namespaces/NamespaceWithDocuments/README.md", + "children": [ + { + "title": "NAMESPACE_DOC", + "kind": 8388608, + "path": "ModuleWithDocuments1/namespaces/NamespaceWithDocuments/documents/NAMESPACE_DOC.md" + } + ] + } + ] + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/.nojekyll b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/@scope/module-1/README.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/@scope/module-1/README.mdx new file mode 100644 index 000000000..e47e0e533 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/@scope/module-1/README.mdx @@ -0,0 +1,13 @@ +[**@scope/entryfile**](../../README.mdx) + +*** + +[@scope/entryfile](../../modules.mdx) / @scope/module-1 + +# @scope/module-1 + +## Index + +### Classes + +- [ModuleClass](classes/ModuleClass.mdx) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/@scope/module-1/classes/ModuleClass.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/@scope/module-1/classes/ModuleClass.mdx new file mode 100644 index 000000000..d00e8a7dc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/@scope/module-1/classes/ModuleClass.mdx @@ -0,0 +1,17 @@ +[**@scope/entryfile**](../../../README.mdx) + +*** + +[@scope/entryfile](../../../modules.mdx) / [@scope/module-1](../README.mdx) / ModuleClass + +# Class: ModuleClass + +## Constructors + +### new ModuleClass() + +> **new ModuleClass**(): [`ModuleClass`](ModuleClass.mdx) + +#### Returns + +[`ModuleClass`](ModuleClass.mdx) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/README.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/README.mdx new file mode 100644 index 000000000..a40435e5d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/README.mdx @@ -0,0 +1,11 @@ +**@scope/entryfile** + +*** + +# entry-module + +## Index + +### Classes + +- [ModuleClass](entry-module/classes/ModuleClass.mdx) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/entry-module/classes/ModuleClass.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/entry-module/classes/ModuleClass.mdx new file mode 100644 index 000000000..0399915fb --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/entry-module/classes/ModuleClass.mdx @@ -0,0 +1,17 @@ +[**@scope/entryfile**](../../README.mdx) + +*** + +[@scope/entryfile](../../modules.mdx) / ModuleClass + +# Class: ModuleClass + +## Constructors + +### new ModuleClass() + +> **new ModuleClass**(): [`ModuleClass`](ModuleClass.mdx) + +#### Returns + +[`ModuleClass`](ModuleClass.mdx) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/module-2/README.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/module-2/README.mdx new file mode 100644 index 000000000..44d91c742 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/module-2/README.mdx @@ -0,0 +1,13 @@ +[**@scope/entryfile**](../README.mdx) + +*** + +[@scope/entryfile](../modules.mdx) / module-2 + +# module-2 + +## Index + +### Classes + +- [ModuleClass](classes/ModuleClass.mdx) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/module-2/classes/ModuleClass.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/module-2/classes/ModuleClass.mdx new file mode 100644 index 000000000..fa655f9cb --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/module-2/classes/ModuleClass.mdx @@ -0,0 +1,17 @@ +[**@scope/entryfile**](../../README.mdx) + +*** + +[@scope/entryfile](../../modules.mdx) / [module-2](../README.mdx) / ModuleClass + +# Class: ModuleClass + +## Constructors + +### new ModuleClass() + +> **new ModuleClass**(): [`ModuleClass`](ModuleClass.mdx) + +#### Returns + +[`ModuleClass`](ModuleClass.mdx) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/readme_.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/readme_.mdx new file mode 100644 index 000000000..c08c9b42e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/readme_.mdx @@ -0,0 +1,15 @@ +[**@scope/entryfile**](README.mdx) + +*** + +[@scope/entryfile](modules.mdx) / @scope/entryfile + +# MY README + +> Some block quote + +Some text. + +## Readme heading + +Some text. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/sidebar.json new file mode 100644 index 000000000..882843182 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-1/sidebar.json @@ -0,0 +1,36 @@ +[ + { + "title": "@scope/module-1", + "kind": 2, + "path": "@scope/module-1/README.mdx", + "children": [ + { + "title": "Classes", + "children": [ + { + "title": "ModuleClass", + "kind": 128, + "path": "@scope/module-1/classes/ModuleClass.mdx" + } + ] + } + ] + }, + { + "title": "module-2", + "kind": 2, + "path": "module-2/README.mdx", + "children": [ + { + "title": "Classes", + "children": [ + { + "title": "ModuleClass", + "kind": 128, + "path": "module-2/classes/ModuleClass.mdx" + } + ] + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/entry-module/classes/ModuleClass.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/entry-module/classes/ModuleClass.mdx new file mode 100644 index 000000000..6aa911c6a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/entry-module/classes/ModuleClass.mdx @@ -0,0 +1,17 @@ +[**@scope/entryfile**](../../index.mdx) + +*** + +[@scope/entryfile](../../modules.mdx) / ModuleClass + +# Class: ModuleClass + +## Constructors + +### new ModuleClass() + +> **new ModuleClass**(): [`ModuleClass`](ModuleClass.mdx) + +#### Returns + +[`ModuleClass`](ModuleClass.mdx) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/index.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/index.mdx new file mode 100644 index 000000000..a40435e5d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/index.mdx @@ -0,0 +1,11 @@ +**@scope/entryfile** + +*** + +# entry-module + +## Index + +### Classes + +- [ModuleClass](entry-module/classes/ModuleClass.mdx) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/module-1/classes/ModuleClass.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/module-1/classes/ModuleClass.mdx new file mode 100644 index 000000000..846efc4f0 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/module-1/classes/ModuleClass.mdx @@ -0,0 +1,17 @@ +[**@scope/entryfile**](../../index.mdx) + +*** + +[@scope/entryfile](../../modules.mdx) / [@scope/module-1](../index.mdx) / ModuleClass + +# Class: ModuleClass + +## Constructors + +### new ModuleClass() + +> **new ModuleClass**(): [`ModuleClass`](ModuleClass.mdx) + +#### Returns + +[`ModuleClass`](ModuleClass.mdx) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/module-1/index.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/module-1/index.mdx new file mode 100644 index 000000000..3e9d70fb3 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/module-1/index.mdx @@ -0,0 +1,13 @@ +[**@scope/entryfile**](../index.mdx) + +*** + +[@scope/entryfile](../modules.mdx) / @scope/module-1 + +# @scope/module-1 + +## Index + +### Classes + +- [ModuleClass](classes/ModuleClass.mdx) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/module-2/classes/ModuleClass.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/module-2/classes/ModuleClass.mdx new file mode 100644 index 000000000..da7b0894c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/module-2/classes/ModuleClass.mdx @@ -0,0 +1,17 @@ +[**@scope/entryfile**](../../index.mdx) + +*** + +[@scope/entryfile](../../modules.mdx) / [module-2](../index.mdx) / ModuleClass + +# Class: ModuleClass + +## Constructors + +### new ModuleClass() + +> **new ModuleClass**(): [`ModuleClass`](ModuleClass.mdx) + +#### Returns + +[`ModuleClass`](ModuleClass.mdx) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/module-2/index.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/module-2/index.mdx new file mode 100644 index 000000000..234f065a4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/module-2/index.mdx @@ -0,0 +1,13 @@ +[**@scope/entryfile**](../index.mdx) + +*** + +[@scope/entryfile](../modules.mdx) / module-2 + +# module-2 + +## Index + +### Classes + +- [ModuleClass](classes/ModuleClass.mdx) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/sidebar.json new file mode 100644 index 000000000..aad85aefb --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/members/opts-2/sidebar.json @@ -0,0 +1,36 @@ +[ + { + "title": "@scope/module-1", + "kind": 2, + "path": "module-1/index.mdx", + "children": [ + { + "title": "Classes", + "children": [ + { + "title": "ModuleClass", + "kind": 128, + "path": "module-1/classes/ModuleClass.mdx" + } + ] + } + ] + }, + { + "title": "module-2", + "kind": 2, + "path": "module-2/index.mdx", + "children": [ + { + "title": "Classes", + "children": [ + { + "title": "ModuleClass", + "kind": 128, + "path": "module-2/classes/ModuleClass.mdx" + } + ] + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/.nojekyll b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/@scope/module-1.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/@scope/module-1.mdx new file mode 100644 index 000000000..1568dc1ac --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/@scope/module-1.mdx @@ -0,0 +1,21 @@ +[**@scope/entryfile**](../README.mdx) + +*** + +[@scope/entryfile](../modules.mdx) / @scope/module-1 + +# @scope/module-1 + +## Classes + +### ModuleClass + +#### Constructors + +##### new ModuleClass() + +> **new ModuleClass**(): [`ModuleClass`](module-1.mdx#moduleclass) + +###### Returns + +[`ModuleClass`](module-1.mdx#moduleclass) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/README.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/README.mdx new file mode 100644 index 000000000..38c68b685 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/README.mdx @@ -0,0 +1,19 @@ +**@scope/entryfile** + +*** + +# entry-module + +## Classes + +### ModuleClass + +#### Constructors + +##### new ModuleClass() + +> **new ModuleClass**(): [`ModuleClass`](README.mdx#moduleclass) + +###### Returns + +[`ModuleClass`](README.mdx#moduleclass) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/module-2.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/module-2.mdx new file mode 100644 index 000000000..71658ecf0 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/module-2.mdx @@ -0,0 +1,21 @@ +[**@scope/entryfile**](README.mdx) + +*** + +[@scope/entryfile](modules.mdx) / module-2 + +# module-2 + +## Classes + +### ModuleClass + +#### Constructors + +##### new ModuleClass() + +> **new ModuleClass**(): [`ModuleClass`](module-2.mdx#moduleclass) + +###### Returns + +[`ModuleClass`](module-2.mdx#moduleclass) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/readme_.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/readme_.mdx new file mode 100644 index 000000000..c08c9b42e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/readme_.mdx @@ -0,0 +1,15 @@ +[**@scope/entryfile**](README.mdx) + +*** + +[@scope/entryfile](modules.mdx) / @scope/entryfile + +# MY README + +> Some block quote + +Some text. + +## Readme heading + +Some text. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/sidebar.json new file mode 100644 index 000000000..9c6cc5aff --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-1/sidebar.json @@ -0,0 +1,12 @@ +[ + { + "title": "@scope/module-1", + "kind": 2, + "path": "@scope/module-1.mdx" + }, + { + "title": "module-2", + "kind": 2, + "path": "module-2.mdx" + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-2/index.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-2/index.mdx new file mode 100644 index 000000000..cc2f3f80a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-2/index.mdx @@ -0,0 +1,19 @@ +**@scope/entryfile** + +*** + +# entry-module + +## Classes + +### ModuleClass + +#### Constructors + +##### new ModuleClass() + +> **new ModuleClass**(): [`ModuleClass`](index.mdx#moduleclass) + +###### Returns + +[`ModuleClass`](index.mdx#moduleclass) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-2/module-1.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-2/module-1.mdx new file mode 100644 index 000000000..c0de5dd13 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-2/module-1.mdx @@ -0,0 +1,21 @@ +[**@scope/entryfile**](index.mdx) + +*** + +[@scope/entryfile](modules.mdx) / @scope/module-1 + +# @scope/module-1 + +## Classes + +### ModuleClass + +#### Constructors + +##### new ModuleClass() + +> **new ModuleClass**(): [`ModuleClass`](module-1.mdx#moduleclass) + +###### Returns + +[`ModuleClass`](module-1.mdx#moduleclass) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-2/module-2.mdx b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-2/module-2.mdx new file mode 100644 index 000000000..5a63aae98 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-2/module-2.mdx @@ -0,0 +1,21 @@ +[**@scope/entryfile**](index.mdx) + +*** + +[@scope/entryfile](modules.mdx) / module-2 + +# module-2 + +## Classes + +### ModuleClass + +#### Constructors + +##### new ModuleClass() + +> **new ModuleClass**(): [`ModuleClass`](module-2.mdx#moduleclass) + +###### Returns + +[`ModuleClass`](module-2.mdx#moduleclass) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-2/sidebar.json new file mode 100644 index 000000000..7a48cfe55 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/entryfiles/modules/opts-2/sidebar.json @@ -0,0 +1,12 @@ +[ + { + "title": "@scope/module-1", + "kind": 2, + "path": "module-1.mdx" + }, + { + "title": "module-2", + "kind": 2, + "path": "module-2.mdx" + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/-internal-/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/-internal-/index.md new file mode 100644 index 000000000..8a3131dd9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/-internal-/index.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../modules.md) / \ + +# \ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/42-module-name/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/42-module-name/index.md new file mode 100644 index 000000000..94323861f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/42-module-name/index.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../modules.md) / 42-module-name + +# 42-module-name diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/classes/ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/classes/ClassA.md new file mode 100644 index 000000000..d4a011d16 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/classes/ClassA.md @@ -0,0 +1,15 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [basic](../index.md) / ClassA + +# Class: ClassA + +ClassA function. + +## Constructors + +### new ClassA() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/classes/ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/classes/ClassB.md new file mode 100644 index 000000000..b52cf65ea --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/classes/ClassB.md @@ -0,0 +1,13 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [basic](../index.md) / ClassB + +# Class: ClassB + +## Constructors + +### new ClassB() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/enumerations/EnumA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/enumerations/EnumA.md new file mode 100644 index 000000000..4038f92b6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/enumerations/EnumA.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [basic](../index.md) / EnumA + +# Enumeration: EnumA + +EnumA function. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/enumerations/EnumB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/enumerations/EnumB.md new file mode 100644 index 000000000..7bae37c89 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/enumerations/EnumB.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [basic](../index.md) / EnumB + +# Enumeration: EnumB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/functions/functionA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/functions/functionA.md new file mode 100644 index 000000000..22214209a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/functions/functionA.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [basic](../index.md) / functionA + +# Function: functionA() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/index.md new file mode 100644 index 000000000..d6e7cb8b4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/index.md @@ -0,0 +1,52 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../modules.md) / basic + +# basic + +A basic module + +## Index + +### Enumerations + +| Enumeration | Description | +| :------ | :------ | +| [EnumA](enumerations/EnumA.md) | EnumA function. | +| [EnumB](enumerations/EnumB.md) | - | + +### Classes + +| Class | Description | +| :------ | :------ | +| [ClassA](classes/ClassA.md) | ClassA function. | +| [ClassB](classes/ClassB.md) | - | + +### Interfaces + +| Interface | Description | +| :------ | :------ | +| [InterfaceA](interfaces/InterfaceA.md) | Interface A comments line 1 and comments on a soft line. | +| [InterfaceB](interfaces/InterfaceB.md) | InterfaceB function. | + +### Type Aliases + +| Type alias | Description | +| :------ | :------ | +| [TypeA](type-aliases/TypeA.md) | TypeA function. | +| [TypeB](type-aliases/TypeB.md) | TypeB function. | + +### Variables + +| Variable | Description | +| :------ | :------ | +| [variableA](variables/variableA.md) | - | +| [variableB](variables/variableB.md) | - | + +### Functions + +| Function | Description | +| :------ | :------ | +| [functionA](functions/functionA.md) | Create a function. | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/interfaces/InterfaceA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/interfaces/InterfaceA.md new file mode 100644 index 000000000..8361cf1c9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/interfaces/InterfaceA.md @@ -0,0 +1,32 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [basic](../index.md) / InterfaceA + +# Interface: InterfaceA + +Interface A comments line 1 +and comments on a soft line. + +Comments on double new line. + +```typescript +const a = new InterfaceA(); +``` + +## Remarks + +Block tag content. + +## Properties + +### propA + +_DECLARATION_MEMBER_PARTIAL_ + +*** + +### propB + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/interfaces/InterfaceB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/interfaces/InterfaceB.md new file mode 100644 index 000000000..8e83b358a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/interfaces/InterfaceB.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [basic](../index.md) / InterfaceB + +# Interface: InterfaceB + +InterfaceB function. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/type-aliases/TypeA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/type-aliases/TypeA.md new file mode 100644 index 000000000..f8bb5db98 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/type-aliases/TypeA.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [basic](../index.md) / TypeA + +# Type Alias: TypeA + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/type-aliases/TypeB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/type-aliases/TypeB.md new file mode 100644 index 000000000..bcc798820 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/type-aliases/TypeB.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [basic](../index.md) / TypeB + +# Type Alias: TypeB() + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/variables/variableA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/variables/variableA.md new file mode 100644 index 000000000..7e7feebe2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/variables/variableA.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [basic](../index.md) / variableA + +# Variable: variableA + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/variables/variableB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/variables/variableB.md new file mode 100644 index 000000000..ef21f5ec2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/basic/variables/variableB.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [basic](../index.md) / variableB + +# Variable: variableB + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/CategoryAEnum1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/CategoryAEnum1.md new file mode 100644 index 000000000..2490fb417 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/CategoryAEnum1.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-categories](../index.md) / CategoryAEnum1 + +# Enumeration: CategoryAEnum1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/CategoryAEnum2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/CategoryAEnum2.md new file mode 100644 index 000000000..c241d6adc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/CategoryAEnum2.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-categories](../index.md) / CategoryAEnum2 + +# Enumeration: CategoryAEnum2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/CategoryBEnum1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/CategoryBEnum1.md new file mode 100644 index 000000000..f112117d6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/CategoryBEnum1.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-categories](../index.md) / CategoryBEnum1 + +# Enumeration: CategoryBEnum1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/CategoryBEnum2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/CategoryBEnum2.md new file mode 100644 index 000000000..178fcaa27 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/CategoryBEnum2.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-categories](../index.md) / CategoryBEnum2 + +# Enumeration: CategoryBEnum2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/UnCategorizedEnum.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/UnCategorizedEnum.md new file mode 100644 index 000000000..e99795569 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/enumerations/UnCategorizedEnum.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-categories](../index.md) / UnCategorizedEnum + +# Enumeration: UnCategorizedEnum diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/index.md new file mode 100644 index 000000000..1b24cc444 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/index.md @@ -0,0 +1,62 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../modules.md) / has-categories + +# has-categories + +A module that contains categories + +## Index + +### Enumerations + +#### Category A + +| Enumeration | Description | +| :------ | :------ | +| [CategoryAEnum1](enumerations/CategoryAEnum1.md) | - | +| [CategoryAEnum2](enumerations/CategoryAEnum2.md) | - | + +#### Category B + +| Enumeration | Description | +| :------ | :------ | +| [CategoryBEnum1](enumerations/CategoryBEnum1.md) | - | +| [CategoryBEnum2](enumerations/CategoryBEnum2.md) | - | + +#### Other + +| Enumeration | Description | +| :------ | :------ | +| [UnCategorizedEnum](enumerations/UnCategorizedEnum.md) | - | + +### Interfaces + +#### Category A + +| Interface | Description | +| :------ | :------ | +| [CategoryAInterface1](interfaces/CategoryAInterface1.md) | - | +| [CategoryAInterface2](interfaces/CategoryAInterface2.md) | - | + +#### Category B + +| Interface | Description | +| :------ | :------ | +| [CategoryBInterface1](interfaces/CategoryBInterface1.md) | - | +| [CategoryBInterface2](interfaces/CategoryBInterface2.md) | - | + +#### Category C + +| Interface | Description | +| :------ | :------ | +| [CategoryCInterface1](interfaces/CategoryCInterface1.md) | - | + +#### Other + +| Interface | Description | +| :------ | :------ | +| [CategoryCInterface2](interfaces/CategoryCInterface2.md) | - | +| [UnCategorizedInterace](interfaces/UnCategorizedInterace.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryAInterface1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryAInterface1.md new file mode 100644 index 000000000..b866beef3 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryAInterface1.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-categories](../index.md) / CategoryAInterface1 + +# Interface: CategoryAInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryAInterface2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryAInterface2.md new file mode 100644 index 000000000..756670899 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryAInterface2.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-categories](../index.md) / CategoryAInterface2 + +# Interface: CategoryAInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryBInterface1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryBInterface1.md new file mode 100644 index 000000000..76ddc29e6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryBInterface1.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-categories](../index.md) / CategoryBInterface1 + +# Interface: CategoryBInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryBInterface2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryBInterface2.md new file mode 100644 index 000000000..3a907e2ea --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryBInterface2.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-categories](../index.md) / CategoryBInterface2 + +# Interface: CategoryBInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryCInterface1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryCInterface1.md new file mode 100644 index 000000000..1a3cd5208 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryCInterface1.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-categories](../index.md) / CategoryCInterface1 + +# Interface: CategoryCInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryCInterface2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryCInterface2.md new file mode 100644 index 000000000..b9c6f7c45 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/CategoryCInterface2.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-categories](../index.md) / CategoryCInterface2 + +# Interface: CategoryCInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/UnCategorizedInterace.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/UnCategorizedInterace.md new file mode 100644 index 000000000..686de9126 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-categories/interfaces/UnCategorizedInterace.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-categories](../index.md) / UnCategorizedInterace + +# Interface: UnCategorizedInterace diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/index.md new file mode 100644 index 000000000..334630f07 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/index.md @@ -0,0 +1,30 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../modules.md) / has-custom-groups + +# has-custom-groups + +A module that contains custom groupings + +## Index + +### Variables + +| Variable | Description | +| :------ | :------ | +| [variableC](variables/variableC.md) | Default grouping | + +### CustomGroupA + +| Variable | Description | +| :------ | :------ | +| [variabelA](variables/variabelA.md) | - | + +### CustomGroupB + +| Variable | Description | +| :------ | :------ | +| [variableB1](variables/variableB1.md) | - | +| [variableB2](variables/variableB2.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/variables/variabelA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/variables/variabelA.md new file mode 100644 index 000000000..fad50f343 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/variables/variabelA.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-custom-groups](../index.md) / variabelA + +# Variable: variabelA + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/variables/variableB1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/variables/variableB1.md new file mode 100644 index 000000000..da489109a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/variables/variableB1.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-custom-groups](../index.md) / variableB1 + +# Variable: variableB1 + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/variables/variableB2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/variables/variableB2.md new file mode 100644 index 000000000..0b1f278ca --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/variables/variableB2.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-custom-groups](../index.md) / variableB2 + +# Variable: variableB2 + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/variables/variableC.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/variables/variableC.md new file mode 100644 index 000000000..f91790685 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-custom-groups/variables/variableC.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-custom-groups](../index.md) / variableC + +# Variable: variableC + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/classes/ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/classes/ClassB.md new file mode 100644 index 000000000..d2cc856c2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/classes/ClassB.md @@ -0,0 +1,13 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-namespaces](../index.md) / ClassB + +# Class: ClassB + +## Constructors + +### new ClassB() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/classes/Class_A.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/classes/Class_A.md new file mode 100644 index 000000000..0c3bc9ac1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/classes/Class_A.md @@ -0,0 +1,13 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-namespaces](../index.md) / \_\_Class\_A\_ + +# Class: \_\_Class\_A\_ + +## Constructors + +### new \_\_Class\_A\_() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/enumerations/EnumB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/enumerations/EnumB.md new file mode 100644 index 000000000..8a47a4850 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/enumerations/EnumB.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-namespaces](../index.md) / EnumB + +# Enumeration: EnumB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/enumerations/Enum_A.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/enumerations/Enum_A.md new file mode 100644 index 000000000..37f8afd99 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/enumerations/Enum_A.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-namespaces](../index.md) / \_Enum\_A\_ + +# Enumeration: \_Enum\_A\_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/functions/functionB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/functions/functionB.md new file mode 100644 index 000000000..c0db49306 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/functions/functionB.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-namespaces](../index.md) / functionB + +# Function: functionB() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/functions/function_A.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/functions/function_A.md new file mode 100644 index 000000000..27678b115 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/functions/function_A.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-namespaces](../index.md) / \_function\_A\_ + +# Function: \_function\_A\_() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/index.md new file mode 100644 index 000000000..cbc8dcf20 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/index.md @@ -0,0 +1,60 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../modules.md) / has-namespaces + +# has-namespaces + +A module that contains namespaces + +## Index + +### Namespaces + +| Namespace | Description | +| :------ | :------ | +| [\_Namespace\_A\_](namespaces/Namespace_A/index.md) | - | +| [NamespaceB](namespaces/NamespaceB/index.md) | - | + +### Enumerations + +| Enumeration | Description | +| :------ | :------ | +| [\_Enum\_A\_](enumerations/Enum_A.md) | - | +| [EnumB](enumerations/EnumB.md) | - | + +### Classes + +| Class | Description | +| :------ | :------ | +| [\_\_Class\_A\_](classes/Class_A.md) | - | +| [ClassB](classes/ClassB.md) | - | + +### Interfaces + +| Interface | Description | +| :------ | :------ | +| [\_Interface\_A\_](interfaces/Interface_A.md) | - | +| [InterfaceB](interfaces/InterfaceB.md) | - | + +### Type Aliases + +| Type alias | Description | +| :------ | :------ | +| [\_Type\_A\_](type-aliases/Type_A.md) | - | +| [TypeB](type-aliases/TypeB.md) | - | + +### Variables + +| Variable | Description | +| :------ | :------ | +| [\_variable\_A\_](variables/variable_A.md) | - | +| [variableB](variables/variableB.md) | - | + +### Functions + +| Function | Description | +| :------ | :------ | +| [\_function\_A\_](functions/function_A.md) | - | +| [functionB](functions/functionB.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/interfaces/InterfaceB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/interfaces/InterfaceB.md new file mode 100644 index 000000000..5061037f4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/interfaces/InterfaceB.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-namespaces](../index.md) / InterfaceB + +# Interface: InterfaceB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/interfaces/Interface_A.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/interfaces/Interface_A.md new file mode 100644 index 000000000..c7ad69f10 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/interfaces/Interface_A.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-namespaces](../index.md) / \_Interface\_A\_ + +# Interface: \_Interface\_A\_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/NamespaceB/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/NamespaceB/index.md new file mode 100644 index 000000000..99b8c44dc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/NamespaceB/index.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../../index.md) + +*** + +[typedoc-stubs](../../../modules.md) / [has-namespaces](../../index.md) / NamespaceB + +# NamespaceB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/Namespace_A/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/Namespace_A/index.md new file mode 100644 index 000000000..7a64265b5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/Namespace_A/index.md @@ -0,0 +1,21 @@ +[**typedoc-stubs**](../../../index.md) + +*** + +[typedoc-stubs](../../../modules.md) / [has-namespaces](../../index.md) / \_Namespace\_A\_ + +# \_Namespace\_A\_ + +## Index + +### Namespaces + +| Namespace | Description | +| :------ | :------ | +| [NestedNamespace](namespaces/NestedNamespace/index.md) | - | + +### Interfaces + +| Interface | Description | +| :------ | :------ | +| [NamespaceInterface](interfaces/NamespaceInterface.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/Namespace_A/interfaces/NamespaceInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/Namespace_A/interfaces/NamespaceInterface.md new file mode 100644 index 000000000..4f96dba1f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/Namespace_A/interfaces/NamespaceInterface.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../../../index.md) + +*** + +[typedoc-stubs](../../../../modules.md) / [has-namespaces](../../../index.md) / [\_Namespace\_A\_](../index.md) / NamespaceInterface + +# Interface: NamespaceInterface diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/index.md new file mode 100644 index 000000000..f2617108f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/index.md @@ -0,0 +1,15 @@ +[**typedoc-stubs**](../../../../../index.md) + +*** + +[typedoc-stubs](../../../../../modules.md) / [has-namespaces](../../../../index.md) / [\_Namespace\_A\_](../../index.md) / NestedNamespace + +# NestedNamespace + +## Index + +### Interfaces + +| Interface | Description | +| :------ | :------ | +| [NamespaceInterface](interfaces/NamespaceInterface.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/interfaces/NamespaceInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/interfaces/NamespaceInterface.md new file mode 100644 index 000000000..725b2ce5f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/interfaces/NamespaceInterface.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../../../../../index.md) + +*** + +[typedoc-stubs](../../../../../../modules.md) / [has-namespaces](../../../../../index.md) / [\_Namespace\_A\_](../../../index.md) / [NestedNamespace](../index.md) / NamespaceInterface + +# Interface: NamespaceInterface diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/type-aliases/TypeB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/type-aliases/TypeB.md new file mode 100644 index 000000000..fbc0210de --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/type-aliases/TypeB.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-namespaces](../index.md) / TypeB + +# Type Alias: TypeB + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/type-aliases/Type_A.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/type-aliases/Type_A.md new file mode 100644 index 000000000..df8bae041 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/type-aliases/Type_A.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-namespaces](../index.md) / \_Type\_A\_ + +# Type Alias: \_Type\_A\_ + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/variables/variableB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/variables/variableB.md new file mode 100644 index 000000000..ee58c22ac --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/variables/variableB.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-namespaces](../index.md) / variableB + +# Variable: variableB + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/variables/variable_A.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/variables/variable_A.md new file mode 100644 index 000000000..c08ba97d8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-namespaces/variables/variable_A.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-namespaces](../index.md) / \_variable\_A\_ + +# Variable: \_variable\_A\_ + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-references/functions/defaultFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-references/functions/defaultFunction.md new file mode 100644 index 000000000..68fd276c1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-references/functions/defaultFunction.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-references](../index.md) / defaultFunction + +# Function: defaultFunction() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-references/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-references/index.md new file mode 100644 index 000000000..faebcf65d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-references/index.md @@ -0,0 +1,35 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../modules.md) / has-references + +# has-references + +A module that contains references + +## Index + +### Functions + +| Function | Description | +| :------ | :------ | +| [defaultFunction](functions/defaultFunction.md) | - | + +## References + +### default + +Renames and re-exports [defaultFunction](functions/defaultFunction.md) + +*** + +### InterfaceA + +Re-exports [InterfaceA](../basic/interfaces/InterfaceA.md) + +*** + +### RenamedInterfaceB + +Renames and re-exports [InterfaceB](../basic/interfaces/InterfaceB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-same-exports/classes/SomeClass-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-same-exports/classes/SomeClass-1.md new file mode 100644 index 000000000..280886e32 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-same-exports/classes/SomeClass-1.md @@ -0,0 +1,13 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-same-exports](../index.md) / SomeClass + +# Class: SomeClass + +## Constructors + +### new SomeClass() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-same-exports/classes/someClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-same-exports/classes/someClass.md new file mode 100644 index 000000000..3db46c054 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-same-exports/classes/someClass.md @@ -0,0 +1,13 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-same-exports](../index.md) / someClass + +# Class: someClass + +## Constructors + +### new someClass() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-same-exports/functions/someFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-same-exports/functions/someFunction.md new file mode 100644 index 000000000..f3a386fe8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-same-exports/functions/someFunction.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-same-exports](../index.md) / someFunction + +# Function: someFunction() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-same-exports/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-same-exports/index.md new file mode 100644 index 000000000..bb3120609 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/has-same-exports/index.md @@ -0,0 +1,28 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../modules.md) / has-same-exports + +# has-same-exports + +## Index + +### Classes + +| Class | Description | +| :------ | :------ | +| [someClass](classes/someClass.md) | - | +| [SomeClass](classes/SomeClass-1.md) | - | + +### group1 + +| Function | Description | +| :------ | :------ | +| [someFunction](functions/someFunction.md) | - | + +### group2 + +| Function | Description | +| :------ | :------ | +| [someFunction](functions/someFunction.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/index.md new file mode 100644 index 000000000..4fbe2a59f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/index.md @@ -0,0 +1,13 @@ +**typedoc-stubs** + +*** + +# MY README + +> Some block quote + +Some text. + +## Readme heading + +Some text. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/index/classes/SomeClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/index/classes/SomeClass.md new file mode 100644 index 000000000..a32efb769 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/index/classes/SomeClass.md @@ -0,0 +1,13 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [index](../index.md) / SomeClass + +# Class: SomeClass + +## Constructors + +### new SomeClass() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/index/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/index/index.md new file mode 100644 index 000000000..321e52e32 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/index/index.md @@ -0,0 +1,17 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../modules.md) / index + +# index + +A module named index + +## Index + +### Classes + +| Class | Description | +| :------ | :------ | +| [SomeClass](classes/SomeClass.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/modules.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/modules.md new file mode 100644 index 000000000..8a6e90af3 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/modules.md @@ -0,0 +1,19 @@ +[**typedoc-stubs**](index.md) + +*** + +# typedoc-stubs + +## Modules + +| Module | Description | +| :------ | :------ | +| [\](-internal-/index.md) | - | +| [42-module-name](42-module-name/index.md) | - | +| [basic](basic/index.md) | A basic module | +| [has-categories](has-categories/index.md) | A module that contains categories | +| [has-custom-groups](has-custom-groups/index.md) | A module that contains custom groupings | +| [has-namespaces](has-namespaces/index.md) | A module that contains namespaces | +| [has-references](has-references/index.md) | A module that contains references | +| [has-same-exports](has-same-exports/index.md) | - | +| [index](index/index.md) | A module named index | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/sidebar.json new file mode 100644 index 000000000..3b85bca3a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-1/sidebar.json @@ -0,0 +1,310 @@ +[ + { + "title": "", + "kind": 2, + "path": "-internal-/index.md" + }, + { + "title": "42-module-name", + "kind": 2, + "path": "42-module-name/index.md" + }, + { + "title": "basic", + "kind": 2, + "path": "basic/index.md", + "children": [ + { + "title": "EnumA", + "kind": 8, + "path": "basic/enumerations/EnumA.md" + }, + { + "title": "EnumB", + "kind": 8, + "path": "basic/enumerations/EnumB.md" + }, + { + "title": "ClassA", + "kind": 128, + "path": "basic/classes/ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "basic/classes/ClassB.md" + }, + { + "title": "InterfaceA", + "kind": 256, + "path": "basic/interfaces/InterfaceA.md" + }, + { + "title": "InterfaceB", + "kind": 256, + "path": "basic/interfaces/InterfaceB.md" + }, + { + "title": "TypeA", + "kind": 2097152, + "path": "basic/type-aliases/TypeA.md" + }, + { + "title": "TypeB", + "kind": 2097152, + "path": "basic/type-aliases/TypeB.md" + }, + { + "title": "variableA", + "kind": 32, + "path": "basic/variables/variableA.md" + }, + { + "title": "variableB", + "kind": 32, + "path": "basic/variables/variableB.md" + }, + { + "title": "functionA", + "kind": 64, + "path": "basic/functions/functionA.md" + } + ] + }, + { + "title": "has-categories", + "kind": 2, + "path": "has-categories/index.md", + "children": [ + { + "title": "CategoryAEnum1", + "kind": 8, + "path": "has-categories/enumerations/CategoryAEnum1.md" + }, + { + "title": "CategoryAEnum2", + "kind": 8, + "path": "has-categories/enumerations/CategoryAEnum2.md" + }, + { + "title": "CategoryBEnum1", + "kind": 8, + "path": "has-categories/enumerations/CategoryBEnum1.md" + }, + { + "title": "CategoryBEnum2", + "kind": 8, + "path": "has-categories/enumerations/CategoryBEnum2.md" + }, + { + "title": "UnCategorizedEnum", + "kind": 8, + "path": "has-categories/enumerations/UnCategorizedEnum.md" + }, + { + "title": "CategoryAInterface1", + "kind": 256, + "path": "has-categories/interfaces/CategoryAInterface1.md" + }, + { + "title": "CategoryAInterface2", + "kind": 256, + "path": "has-categories/interfaces/CategoryAInterface2.md" + }, + { + "title": "CategoryBInterface1", + "kind": 256, + "path": "has-categories/interfaces/CategoryBInterface1.md" + }, + { + "title": "CategoryBInterface2", + "kind": 256, + "path": "has-categories/interfaces/CategoryBInterface2.md" + }, + { + "title": "CategoryCInterface1", + "kind": 256, + "path": "has-categories/interfaces/CategoryCInterface1.md" + }, + { + "title": "CategoryCInterface2", + "kind": 256, + "path": "has-categories/interfaces/CategoryCInterface2.md" + }, + { + "title": "UnCategorizedInterace", + "kind": 256, + "path": "has-categories/interfaces/UnCategorizedInterace.md" + } + ] + }, + { + "title": "has-custom-groups", + "kind": 2, + "path": "has-custom-groups/index.md", + "children": [ + { + "title": "variabelA", + "kind": 32, + "path": "has-custom-groups/variables/variabelA.md" + }, + { + "title": "variableB1", + "kind": 32, + "path": "has-custom-groups/variables/variableB1.md" + }, + { + "title": "variableB2", + "kind": 32, + "path": "has-custom-groups/variables/variableB2.md" + }, + { + "title": "variableC", + "kind": 32, + "path": "has-custom-groups/variables/variableC.md" + } + ] + }, + { + "title": "has-namespaces", + "kind": 2, + "path": "has-namespaces/index.md", + "children": [ + { + "title": "_Namespace_A_", + "kind": 4, + "path": "has-namespaces/namespaces/Namespace_A/index.md", + "children": [ + { + "title": "NestedNamespace", + "kind": 4, + "path": "has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/index.md", + "children": [ + { + "title": "NamespaceInterface", + "kind": 256, + "path": "has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/interfaces/NamespaceInterface.md" + } + ] + }, + { + "title": "NamespaceInterface", + "kind": 256, + "path": "has-namespaces/namespaces/Namespace_A/interfaces/NamespaceInterface.md" + } + ] + }, + { + "title": "NamespaceB", + "kind": 4, + "path": "has-namespaces/namespaces/NamespaceB/index.md" + }, + { + "title": "_Enum_A_", + "kind": 8, + "path": "has-namespaces/enumerations/Enum_A.md" + }, + { + "title": "EnumB", + "kind": 8, + "path": "has-namespaces/enumerations/EnumB.md" + }, + { + "title": "__Class_A_", + "kind": 128, + "path": "has-namespaces/classes/Class_A.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "has-namespaces/classes/ClassB.md" + }, + { + "title": "_Interface_A_", + "kind": 256, + "path": "has-namespaces/interfaces/Interface_A.md" + }, + { + "title": "InterfaceB", + "kind": 256, + "path": "has-namespaces/interfaces/InterfaceB.md" + }, + { + "title": "_Type_A_", + "kind": 2097152, + "path": "has-namespaces/type-aliases/Type_A.md" + }, + { + "title": "TypeB", + "kind": 2097152, + "path": "has-namespaces/type-aliases/TypeB.md" + }, + { + "title": "_variable_A_", + "kind": 32, + "path": "has-namespaces/variables/variable_A.md" + }, + { + "title": "variableB", + "kind": 32, + "path": "has-namespaces/variables/variableB.md" + }, + { + "title": "_function_A_", + "kind": 64, + "path": "has-namespaces/functions/function_A.md" + }, + { + "title": "functionB", + "kind": 64, + "path": "has-namespaces/functions/functionB.md" + } + ] + }, + { + "title": "has-references", + "kind": 2, + "path": "has-references/index.md", + "children": [ + { + "title": "defaultFunction", + "kind": 64, + "path": "has-references/functions/defaultFunction.md" + } + ] + }, + { + "title": "has-same-exports", + "kind": 2, + "path": "has-same-exports/index.md", + "children": [ + { + "title": "someClass", + "kind": 128, + "path": "has-same-exports/classes/someClass.md" + }, + { + "title": "SomeClass", + "kind": 128, + "path": "has-same-exports/classes/SomeClass-1.md" + }, + { + "title": "someFunction", + "kind": 64, + "path": "has-same-exports/functions/someFunction.md" + } + ] + }, + { + "title": "index", + "kind": 2, + "path": "index/index.md", + "children": [ + { + "title": "SomeClass", + "kind": 128, + "path": "index/classes/SomeClass.md" + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/-internal-/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/-internal-/index.md new file mode 100644 index 000000000..5b32d5d2a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/-internal-/index.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../index.md) / \ + +# \ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/42-module-name/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/42-module-name/index.md new file mode 100644 index 000000000..fd82e73a8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/42-module-name/index.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../index.md) / 42-module-name + +# 42-module-name diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/classes/ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/classes/ClassA.md new file mode 100644 index 000000000..1cd5a3270 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/classes/ClassA.md @@ -0,0 +1,17 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [basic](../index.md) / ClassA + +# Class: ClassA + +ClassA function. + +## Constructors + + + +### new ClassA() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/classes/ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/classes/ClassB.md new file mode 100644 index 000000000..5108caccd --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/classes/ClassB.md @@ -0,0 +1,15 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [basic](../index.md) / ClassB + +# Class: ClassB + +## Constructors + + + +### new ClassB() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/enumerations/EnumA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/enumerations/EnumA.md new file mode 100644 index 000000000..9ee4c3b59 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/enumerations/EnumA.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [basic](../index.md) / EnumA + +# Enumeration: EnumA + +EnumA function. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/enumerations/EnumB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/enumerations/EnumB.md new file mode 100644 index 000000000..a2743be42 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/enumerations/EnumB.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [basic](../index.md) / EnumB + +# Enumeration: EnumB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/functions/functionA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/functions/functionA.md new file mode 100644 index 000000000..cbdbaa697 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/functions/functionA.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [basic](../index.md) / functionA + +# Function: functionA() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/index.md new file mode 100644 index 000000000..43c49329b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/index.md @@ -0,0 +1,211 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../index.md) / basic + +# basic + +A basic module + +## Index + +### Functions + + + + + + + + + + + + + + +
FunctionDescription
+ +[functionA](functions/functionA.md) + + + +Create a function. + +More summary. + +
+ +### Interfaces + + + + + + + + + + + + + + + + + + +
InterfaceDescription
+ +[InterfaceA](interfaces/InterfaceA.md) + + + +Interface A comments line 1 +and comments on a soft line. + +Comments on double new line. + +```typescript +const a = new InterfaceA(); +``` + +**Remarks** + +Block tag content. + +
+ +[InterfaceB](interfaces/InterfaceB.md) + + + +InterfaceB function. + +
+ +### Classes + + + + + + + + + + + + + + + + + + +
ClassDescription
+ +[ClassA](classes/ClassA.md) + + + +ClassA function. + +
+ +[ClassB](classes/ClassB.md) + + + +‐ + +
+ +### Enumerations + + + + + + + + + + + + + + + + + + +
EnumerationDescription
+ +[EnumA](enumerations/EnumA.md) + + + +EnumA function. + +
+ +[EnumB](enumerations/EnumB.md) + + + +‐ + +
+ +### Type Aliases + + + + + + + + + + + + + + + + + + +
Type aliasDescription
+ +[TypeA](type-aliases/TypeA.md) + + + +TypeA function. + +
+ +[TypeB](type-aliases/TypeB.md) + + + +TypeB function. + +
+ + + +## variableA + +_DECLARATION_MEMBER_PARTIAL_ + +*** + + + +## variableB + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/interfaces/InterfaceA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/interfaces/InterfaceA.md new file mode 100644 index 000000000..ffad8cd7e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/interfaces/InterfaceA.md @@ -0,0 +1,36 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [basic](../index.md) / InterfaceA + +# Interface: InterfaceA + +Interface A comments line 1 +and comments on a soft line. + +Comments on double new line. + +```typescript +const a = new InterfaceA(); +``` + +## Remarks + +Block tag content. + +## Properties + + + +### propA + +_DECLARATION_MEMBER_PARTIAL_ + +*** + + + +### propB + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/interfaces/InterfaceB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/interfaces/InterfaceB.md new file mode 100644 index 000000000..0ee40e2ea --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/interfaces/InterfaceB.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [basic](../index.md) / InterfaceB + +# Interface: InterfaceB + +InterfaceB function. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/type-aliases/TypeA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/type-aliases/TypeA.md new file mode 100644 index 000000000..063b31f88 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/type-aliases/TypeA.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [basic](../index.md) / TypeA + +# Type Alias: TypeA + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/type-aliases/TypeB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/type-aliases/TypeB.md new file mode 100644 index 000000000..08fc50cf1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/basic/type-aliases/TypeB.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [basic](../index.md) / TypeB + +# Type Alias: TypeB() + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/CategoryAEnum1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/CategoryAEnum1.md new file mode 100644 index 000000000..962852a98 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/CategoryAEnum1.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-categories](../index.md) / CategoryAEnum1 + +# Enumeration: CategoryAEnum1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/CategoryAEnum2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/CategoryAEnum2.md new file mode 100644 index 000000000..17578b55a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/CategoryAEnum2.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-categories](../index.md) / CategoryAEnum2 + +# Enumeration: CategoryAEnum2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/CategoryBEnum1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/CategoryBEnum1.md new file mode 100644 index 000000000..f24930870 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/CategoryBEnum1.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-categories](../index.md) / CategoryBEnum1 + +# Enumeration: CategoryBEnum1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/CategoryBEnum2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/CategoryBEnum2.md new file mode 100644 index 000000000..ba1e5a0fd --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/CategoryBEnum2.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-categories](../index.md) / CategoryBEnum2 + +# Enumeration: CategoryBEnum2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/UnCategorizedEnum.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/UnCategorizedEnum.md new file mode 100644 index 000000000..3bda6a87f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/enumerations/UnCategorizedEnum.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-categories](../index.md) / UnCategorizedEnum + +# Enumeration: UnCategorizedEnum diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/index.md new file mode 100644 index 000000000..fbb802846 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/index.md @@ -0,0 +1,207 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../index.md) / has-categories + +# has-categories + +A module that contains categories + +## Index + +### Category A + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enumeration, InterfaceDescription
+ +[CategoryAEnum1](enumerations/CategoryAEnum1.md) + + + +‐ + +
+ +[CategoryAEnum2](enumerations/CategoryAEnum2.md) + + + +‐ + +
+ +[CategoryAInterface1](interfaces/CategoryAInterface1.md) + + + +‐ + +
+ +[CategoryAInterface2](interfaces/CategoryAInterface2.md) + + + +‐ + +
+ +### Category B + + + + + + + + + + + + + + + + + + + + + + + + + + +
Enumeration, InterfaceDescription
+ +[CategoryBEnum1](enumerations/CategoryBEnum1.md) + + + +‐ + +
+ +[CategoryBEnum2](enumerations/CategoryBEnum2.md) + + + +‐ + +
+ +[CategoryBInterface1](interfaces/CategoryBInterface1.md) + + + +‐ + +
+ +[CategoryBInterface2](interfaces/CategoryBInterface2.md) + + + +‐ + +
+ +### Category C + + + + + + + + + + + + + + +
InterfaceDescription
+ +[CategoryCInterface1](interfaces/CategoryCInterface1.md) + + + +‐ + +
+ +### Other + + + + + + + + + + + + + + + + + + + + + + +
Enumeration, InterfaceDescription
+ +[UnCategorizedEnum](enumerations/UnCategorizedEnum.md) + + + +‐ + +
+ +[CategoryCInterface2](interfaces/CategoryCInterface2.md) + + + +‐ + +
+ +[UnCategorizedInterace](interfaces/UnCategorizedInterace.md) + + + +‐ + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryAInterface1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryAInterface1.md new file mode 100644 index 000000000..fe01502d9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryAInterface1.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-categories](../index.md) / CategoryAInterface1 + +# Interface: CategoryAInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryAInterface2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryAInterface2.md new file mode 100644 index 000000000..9fcf6363f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryAInterface2.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-categories](../index.md) / CategoryAInterface2 + +# Interface: CategoryAInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryBInterface1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryBInterface1.md new file mode 100644 index 000000000..430694b4e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryBInterface1.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-categories](../index.md) / CategoryBInterface1 + +# Interface: CategoryBInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryBInterface2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryBInterface2.md new file mode 100644 index 000000000..9059806ce --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryBInterface2.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-categories](../index.md) / CategoryBInterface2 + +# Interface: CategoryBInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryCInterface1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryCInterface1.md new file mode 100644 index 000000000..d4ac5db6d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryCInterface1.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-categories](../index.md) / CategoryCInterface1 + +# Interface: CategoryCInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryCInterface2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryCInterface2.md new file mode 100644 index 000000000..4756834ea --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/CategoryCInterface2.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-categories](../index.md) / CategoryCInterface2 + +# Interface: CategoryCInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/UnCategorizedInterace.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/UnCategorizedInterace.md new file mode 100644 index 000000000..49f6be01f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-categories/interfaces/UnCategorizedInterace.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-categories](../index.md) / UnCategorizedInterace + +# Interface: UnCategorizedInterace diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-custom-groups/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-custom-groups/index.md new file mode 100644 index 000000000..211ad0df4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-custom-groups/index.md @@ -0,0 +1,39 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../index.md) / has-custom-groups + +# has-custom-groups + +A module that contains custom groupings + + + +## variabelA + +_DECLARATION_MEMBER_PARTIAL_ + +*** + + + +## variableB1 + +_DECLARATION_MEMBER_PARTIAL_ + +*** + + + +## variableB2 + +_DECLARATION_MEMBER_PARTIAL_ + +*** + + + +## variableC + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/classes/ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/classes/ClassB.md new file mode 100644 index 000000000..5f1cda070 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/classes/ClassB.md @@ -0,0 +1,15 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-namespaces](../index.md) / ClassB + +# Class: ClassB + +## Constructors + + + +### new ClassB() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/classes/Class_A.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/classes/Class_A.md new file mode 100644 index 000000000..8612e6eeb --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/classes/Class_A.md @@ -0,0 +1,15 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-namespaces](../index.md) / \_\_Class\_A\_ + +# Class: \_\_Class\_A\_ + +## Constructors + + + +### new \_\_Class\_A\_() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/enumerations/EnumB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/enumerations/EnumB.md new file mode 100644 index 000000000..8c07258e1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/enumerations/EnumB.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-namespaces](../index.md) / EnumB + +# Enumeration: EnumB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/enumerations/Enum_A.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/enumerations/Enum_A.md new file mode 100644 index 000000000..ecf347420 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/enumerations/Enum_A.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-namespaces](../index.md) / \_Enum\_A\_ + +# Enumeration: \_Enum\_A\_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/functions/functionB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/functions/functionB.md new file mode 100644 index 000000000..fe0d2653b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/functions/functionB.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-namespaces](../index.md) / functionB + +# Function: functionB() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/functions/function_A.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/functions/function_A.md new file mode 100644 index 000000000..a83bb3635 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/functions/function_A.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-namespaces](../index.md) / \_function\_A\_ + +# Function: \_function\_A\_() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/index.md new file mode 100644 index 000000000..c038ebb3d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/index.md @@ -0,0 +1,247 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../index.md) / has-namespaces + +# has-namespaces + +A module that contains namespaces + +## Index + +### Functions + + + + + + + + + + + + + + + + + + +
FunctionDescription
+ +[\_function\_A\_](functions/function_A.md) + + + +‐ + +
+ +[functionB](functions/functionB.md) + + + +‐ + +
+ +### Interfaces + + + + + + + + + + + + + + + + + + +
InterfaceDescription
+ +[\_Interface\_A\_](interfaces/Interface_A.md) + + + +‐ + +
+ +[InterfaceB](interfaces/InterfaceB.md) + + + +‐ + +
+ +### Classes + + + + + + + + + + + + + + + + + + +
ClassDescription
+ +[\_\_Class\_A\_](classes/Class_A.md) + + + +‐ + +
+ +[ClassB](classes/ClassB.md) + + + +‐ + +
+ +### Enumerations + + + + + + + + + + + + + + + + + + +
EnumerationDescription
+ +[\_Enum\_A\_](enumerations/Enum_A.md) + + + +‐ + +
+ +[EnumB](enumerations/EnumB.md) + + + +‐ + +
+ +### Namespaces + + + + + + + + + + + + + + + + + + +
NamespaceDescription
+ +[\_Namespace\_A\_](namespaces/Namespace_A/index.md) + + + +‐ + +
+ +[NamespaceB](namespaces/NamespaceB/index.md) + + + +‐ + +
+ +### Type Aliases + + + + + + + + + + + + + + + + + + +
Type aliasDescription
+ +[\_Type\_A\_](type-aliases/Type_A.md) + + + +‐ + +
+ +[TypeB](type-aliases/TypeB.md) + + + +‐ + +
+ + + +## \_variable\_A\_ + +_DECLARATION_MEMBER_PARTIAL_ + +*** + + + +## variableB + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/interfaces/InterfaceB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/interfaces/InterfaceB.md new file mode 100644 index 000000000..72bae1351 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/interfaces/InterfaceB.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-namespaces](../index.md) / InterfaceB + +# Interface: InterfaceB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/interfaces/Interface_A.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/interfaces/Interface_A.md new file mode 100644 index 000000000..264ae93be --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/interfaces/Interface_A.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-namespaces](../index.md) / \_Interface\_A\_ + +# Interface: \_Interface\_A\_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/NamespaceB/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/NamespaceB/index.md new file mode 100644 index 000000000..becc0c0b1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/NamespaceB/index.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../../index.md) + +*** + +[typedoc-stubs](../../../index.md) / [has-namespaces](../../index.md) / NamespaceB + +# NamespaceB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/Namespace_A/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/Namespace_A/index.md new file mode 100644 index 000000000..105ce80da --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/Namespace_A/index.md @@ -0,0 +1,59 @@ +[**typedoc-stubs**](../../../index.md) + +*** + +[typedoc-stubs](../../../index.md) / [has-namespaces](../../index.md) / \_Namespace\_A\_ + +# \_Namespace\_A\_ + +## Index + +### Interfaces + + + + + + + + + + + + + + +
InterfaceDescription
+ +[NamespaceInterface](interfaces/NamespaceInterface.md) + + + +‐ + +
+ +### Namespaces + + + + + + + + + + + + + + +
NamespaceDescription
+ +[NestedNamespace](namespaces/NestedNamespace/index.md) + + + +‐ + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/Namespace_A/interfaces/NamespaceInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/Namespace_A/interfaces/NamespaceInterface.md new file mode 100644 index 000000000..7b3817343 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/Namespace_A/interfaces/NamespaceInterface.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../../../index.md) + +*** + +[typedoc-stubs](../../../../index.md) / [has-namespaces](../../../index.md) / [\_Namespace\_A\_](../index.md) / NamespaceInterface + +# Interface: NamespaceInterface diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/index.md new file mode 100644 index 000000000..9560a8a72 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/index.md @@ -0,0 +1,34 @@ +[**typedoc-stubs**](../../../../../index.md) + +*** + +[typedoc-stubs](../../../../../index.md) / [has-namespaces](../../../../index.md) / [\_Namespace\_A\_](../../index.md) / NestedNamespace + +# NestedNamespace + +## Index + +### Interfaces + + + + + + + + + + + + + + +
InterfaceDescription
+ +[NamespaceInterface](interfaces/NamespaceInterface.md) + + + +‐ + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/interfaces/NamespaceInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/interfaces/NamespaceInterface.md new file mode 100644 index 000000000..a402fc24d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/interfaces/NamespaceInterface.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../../../../../index.md) + +*** + +[typedoc-stubs](../../../../../../index.md) / [has-namespaces](../../../../../index.md) / [\_Namespace\_A\_](../../../index.md) / [NestedNamespace](../index.md) / NamespaceInterface + +# Interface: NamespaceInterface diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/type-aliases/TypeB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/type-aliases/TypeB.md new file mode 100644 index 000000000..d88a1c447 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/type-aliases/TypeB.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-namespaces](../index.md) / TypeB + +# Type Alias: TypeB + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/type-aliases/Type_A.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/type-aliases/Type_A.md new file mode 100644 index 000000000..e0cba9c97 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-namespaces/type-aliases/Type_A.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-namespaces](../index.md) / \_Type\_A\_ + +# Type Alias: \_Type\_A\_ + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-references/functions/defaultFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-references/functions/defaultFunction.md new file mode 100644 index 000000000..0e692d66a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-references/functions/defaultFunction.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-references](../index.md) / defaultFunction + +# Function: defaultFunction() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-references/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-references/index.md new file mode 100644 index 000000000..b4913cb3b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-references/index.md @@ -0,0 +1,58 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../index.md) / has-references + +# has-references + +A module that contains references + +## Index + +### Functions + + + + + + + + + + + + + + +
FunctionDescription
+ +[defaultFunction](functions/defaultFunction.md) + + + +‐ + +
+ + + +## default + +Renames and re-exports [defaultFunction](functions/defaultFunction.md) + +*** + + + +## InterfaceA + +Re-exports [InterfaceA](../basic/interfaces/InterfaceA.md) + +*** + + + +## RenamedInterfaceB + +Renames and re-exports [InterfaceB](../basic/interfaces/InterfaceB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-same-exports/classes/SomeClass-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-same-exports/classes/SomeClass-1.md new file mode 100644 index 000000000..0a4d53122 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-same-exports/classes/SomeClass-1.md @@ -0,0 +1,15 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-same-exports](../index.md) / SomeClass + +# Class: SomeClass + +## Constructors + + + +### new SomeClass() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-same-exports/classes/someClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-same-exports/classes/someClass.md new file mode 100644 index 000000000..9e65f465a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-same-exports/classes/someClass.md @@ -0,0 +1,15 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-same-exports](../index.md) / someClass + +# Class: someClass + +## Constructors + + + +### new someClass() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-same-exports/functions/someFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-same-exports/functions/someFunction.md new file mode 100644 index 000000000..400a387d7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-same-exports/functions/someFunction.md @@ -0,0 +1,9 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-same-exports](../index.md) / someFunction + +# Function: someFunction() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-same-exports/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-same-exports/index.md new file mode 100644 index 000000000..1c76b1585 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/has-same-exports/index.md @@ -0,0 +1,96 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../index.md) / has-same-exports + +# has-same-exports + +## Index + +### Classes + + + + + + + + + + + + + + + + + + +
ClassDescription
+ +[someClass](classes/someClass.md) + + + +‐ + +
+ +[SomeClass](classes/SomeClass-1.md) + + + +‐ + +
+ +### group1 + + + + + + + + + + + + + + +
FunctionDescription
+ +[someFunction](functions/someFunction.md) + + + +‐ + +
+ +### group2 + + + + + + + + + + + + + + +
FunctionDescription
+ +[someFunction](functions/someFunction.md) + + + +‐ + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/index.md new file mode 100644 index 000000000..2b8ac9c78 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/index.md @@ -0,0 +1,126 @@ +**typedoc-stubs** + +*** + +# typedoc-stubs + +## Modules + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ModuleDescription
+ +[\](-internal-/index.md) + + + +‐ + +
+ +[42-module-name](42-module-name/index.md) + + + +‐ + +
+ +[basic](basic/index.md) + + + +A basic module + +
+ +[has-categories](has-categories/index.md) + + + +A module that contains categories + +
+ +[has-custom-groups](has-custom-groups/index.md) + + + +A module that contains custom groupings + +
+ +[has-namespaces](has-namespaces/index.md) + + + +A module that contains namespaces + +
+ +[has-references](has-references/index.md) + + + +A module that contains references + +
+ +[has-same-exports](has-same-exports/index.md) + + + +‐ + +
+ +[index](index/index.md) + + + +A module named index + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/index/classes/SomeClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/index/classes/SomeClass.md new file mode 100644 index 000000000..6c07e8ffc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/index/classes/SomeClass.md @@ -0,0 +1,15 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [index](../index.md) / SomeClass + +# Class: SomeClass + +## Constructors + + + +### new SomeClass() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/index/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/index/index.md new file mode 100644 index 000000000..42b77bb06 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/index/index.md @@ -0,0 +1,36 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../index.md) / index + +# index + +A module named index + +## Index + +### Classes + + + + + + + + + + + + + + +
ClassDescription
+ +[SomeClass](classes/SomeClass.md) + + + +‐ + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/sidebar.json new file mode 100644 index 000000000..956cc9b0c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/members/opts-2/sidebar.json @@ -0,0 +1,388 @@ +[ + { + "title": "", + "kind": 2, + "path": "-internal-/index.md" + }, + { + "title": "42-module-name", + "kind": 2, + "path": "42-module-name/index.md" + }, + { + "title": "basic", + "kind": 2, + "path": "basic/index.md", + "children": [ + { + "title": "Functions", + "children": [ + { + "title": "functionA", + "kind": 64, + "path": "basic/functions/functionA.md" + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceA", + "kind": 256, + "path": "basic/interfaces/InterfaceA.md" + }, + { + "title": "InterfaceB", + "kind": 256, + "path": "basic/interfaces/InterfaceB.md" + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "basic/classes/ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "basic/classes/ClassB.md" + } + ] + }, + { + "title": "Enumerations", + "children": [ + { + "title": "EnumA", + "kind": 8, + "path": "basic/enumerations/EnumA.md" + }, + { + "title": "EnumB", + "kind": 8, + "path": "basic/enumerations/EnumB.md" + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeA", + "kind": 2097152, + "path": "basic/type-aliases/TypeA.md" + }, + { + "title": "TypeB", + "kind": 2097152, + "path": "basic/type-aliases/TypeB.md" + } + ] + } + ] + }, + { + "title": "has-categories", + "kind": 2, + "path": "has-categories/index.md", + "children": [ + { + "title": "Category A", + "children": [ + { + "title": "CategoryAEnum1", + "kind": 8, + "path": "has-categories/enumerations/CategoryAEnum1.md" + }, + { + "title": "CategoryAEnum2", + "kind": 8, + "path": "has-categories/enumerations/CategoryAEnum2.md" + }, + { + "title": "CategoryAInterface1", + "kind": 256, + "path": "has-categories/interfaces/CategoryAInterface1.md" + }, + { + "title": "CategoryAInterface2", + "kind": 256, + "path": "has-categories/interfaces/CategoryAInterface2.md" + } + ] + }, + { + "title": "Category B", + "children": [ + { + "title": "CategoryBEnum1", + "kind": 8, + "path": "has-categories/enumerations/CategoryBEnum1.md" + }, + { + "title": "CategoryBEnum2", + "kind": 8, + "path": "has-categories/enumerations/CategoryBEnum2.md" + }, + { + "title": "CategoryBInterface1", + "kind": 256, + "path": "has-categories/interfaces/CategoryBInterface1.md" + }, + { + "title": "CategoryBInterface2", + "kind": 256, + "path": "has-categories/interfaces/CategoryBInterface2.md" + } + ] + }, + { + "title": "Category C", + "children": [ + { + "title": "CategoryCInterface1", + "kind": 256, + "path": "has-categories/interfaces/CategoryCInterface1.md" + } + ] + }, + { + "title": "Other", + "children": [ + { + "title": "UnCategorizedEnum", + "kind": 8, + "path": "has-categories/enumerations/UnCategorizedEnum.md" + }, + { + "title": "CategoryCInterface2", + "kind": 256, + "path": "has-categories/interfaces/CategoryCInterface2.md" + }, + { + "title": "UnCategorizedInterace", + "kind": 256, + "path": "has-categories/interfaces/UnCategorizedInterace.md" + } + ] + } + ] + }, + { + "title": "has-custom-groups", + "kind": 2, + "path": "has-custom-groups/index.md" + }, + { + "title": "has-namespaces", + "kind": 2, + "path": "has-namespaces/index.md", + "children": [ + { + "title": "Functions", + "children": [ + { + "title": "_function_A_", + "kind": 64, + "path": "has-namespaces/functions/function_A.md" + }, + { + "title": "functionB", + "kind": 64, + "path": "has-namespaces/functions/functionB.md" + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "_Interface_A_", + "kind": 256, + "path": "has-namespaces/interfaces/Interface_A.md" + }, + { + "title": "InterfaceB", + "kind": 256, + "path": "has-namespaces/interfaces/InterfaceB.md" + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "__Class_A_", + "kind": 128, + "path": "has-namespaces/classes/Class_A.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "has-namespaces/classes/ClassB.md" + } + ] + }, + { + "title": "Enumerations", + "children": [ + { + "title": "_Enum_A_", + "kind": 8, + "path": "has-namespaces/enumerations/Enum_A.md" + }, + { + "title": "EnumB", + "kind": 8, + "path": "has-namespaces/enumerations/EnumB.md" + } + ] + }, + { + "title": "Namespaces", + "children": [ + { + "title": "_Namespace_A_", + "kind": 4, + "path": "has-namespaces/namespaces/Namespace_A/index.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "NamespaceInterface", + "kind": 256, + "path": "has-namespaces/namespaces/Namespace_A/interfaces/NamespaceInterface.md" + } + ] + }, + { + "title": "Namespaces", + "children": [ + { + "title": "NestedNamespace", + "kind": 4, + "path": "has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/index.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "NamespaceInterface", + "kind": 256, + "path": "has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace/interfaces/NamespaceInterface.md" + } + ] + } + ] + } + ] + } + ] + }, + { + "title": "NamespaceB", + "kind": 4, + "path": "has-namespaces/namespaces/NamespaceB/index.md" + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "_Type_A_", + "kind": 2097152, + "path": "has-namespaces/type-aliases/Type_A.md" + }, + { + "title": "TypeB", + "kind": 2097152, + "path": "has-namespaces/type-aliases/TypeB.md" + } + ] + } + ] + }, + { + "title": "has-references", + "kind": 2, + "path": "has-references/index.md", + "children": [ + { + "title": "Functions", + "children": [ + { + "title": "defaultFunction", + "kind": 64, + "path": "has-references/functions/defaultFunction.md" + } + ] + } + ] + }, + { + "title": "has-same-exports", + "kind": 2, + "path": "has-same-exports/index.md", + "children": [ + { + "title": "Classes", + "children": [ + { + "title": "someClass", + "kind": 128, + "path": "has-same-exports/classes/someClass.md" + }, + { + "title": "SomeClass", + "kind": 128, + "path": "has-same-exports/classes/SomeClass-1.md" + } + ] + }, + { + "title": "group1", + "children": [ + { + "title": "someFunction", + "kind": 64, + "path": "has-same-exports/functions/someFunction.md" + } + ] + }, + { + "title": "group2", + "children": [ + { + "title": "someFunction", + "kind": 64, + "path": "has-same-exports/functions/someFunction.md" + } + ] + } + ] + }, + { + "title": "index", + "kind": 2, + "path": "index/index.md", + "children": [ + { + "title": "Classes", + "children": [ + { + "title": "SomeClass", + "kind": 128, + "path": "index/classes/SomeClass.md" + } + ] + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/-internal-.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/-internal-.md new file mode 100644 index 000000000..0772862f6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/-internal-.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](index.md) + +*** + +[typedoc-stubs](modules.md) / \ + +# \ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/42-module-name.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/42-module-name.md new file mode 100644 index 000000000..bc901bdd7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/42-module-name.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](index.md) + +*** + +[typedoc-stubs](modules.md) / 42-module-name + +# 42-module-name diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/basic.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/basic.md new file mode 100644 index 000000000..4cc0420e6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/basic.md @@ -0,0 +1,104 @@ +[**typedoc-stubs**](index.md) + +*** + +[typedoc-stubs](modules.md) / basic + +# basic + +A basic module + +## Enumerations + +### EnumA + +EnumA function. + +*** + +### EnumB + +## Classes + +### ClassA + +ClassA function. + +#### Constructors + +##### new ClassA() + +_SIGNATURE_MEMBER_PARTIAL_ + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +_SIGNATURE_MEMBER_PARTIAL_ + +## Interfaces + +### InterfaceA + +Interface A comments line 1 +and comments on a soft line. + +Comments on double new line. + +```typescript +const a = new InterfaceA(); +``` + +#### Remarks + +Block tag content. + +#### Properties + +##### propA + +_DECLARATION_MEMBER_PARTIAL_ + +##### propB + +_DECLARATION_MEMBER_PARTIAL_ + +*** + +### InterfaceB + +InterfaceB function. + +## Type Aliases + +### TypeA + +_DECLARATION_MEMBER_PARTIAL_ + +*** + +### TypeB() + +_DECLARATION_MEMBER_PARTIAL_ + +## Variables + +### variableA + +_DECLARATION_MEMBER_PARTIAL_ + +*** + +### variableB + +_DECLARATION_MEMBER_PARTIAL_ + +## Functions + +### functionA() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-categories.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-categories.md new file mode 100644 index 000000000..b3656a1ef --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-categories.md @@ -0,0 +1,61 @@ +[**typedoc-stubs**](index.md) + +*** + +[typedoc-stubs](modules.md) / has-categories + +# has-categories + +A module that contains categories + +## Enumerations + +### Category A + +#### CategoryAEnum1 + +*** + +#### CategoryAEnum2 + +### Category B + +#### CategoryBEnum1 + +*** + +#### CategoryBEnum2 + +### Other + +#### UnCategorizedEnum + +## Interfaces + +### Category A + +#### CategoryAInterface1 + +*** + +#### CategoryAInterface2 + +### Category B + +#### CategoryBInterface1 + +*** + +#### CategoryBInterface2 + +### Category C + +#### CategoryCInterface1 + +### Other + +#### CategoryCInterface2 + +*** + +#### UnCategorizedInterace diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-custom-groups.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-custom-groups.md new file mode 100644 index 000000000..56313e38c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-custom-groups.md @@ -0,0 +1,33 @@ +[**typedoc-stubs**](index.md) + +*** + +[typedoc-stubs](modules.md) / has-custom-groups + +# has-custom-groups + +A module that contains custom groupings + +## Variables + +### variableC + +_DECLARATION_MEMBER_PARTIAL_ + +## CustomGroupA + +### variabelA + +_DECLARATION_MEMBER_PARTIAL_ + +## CustomGroupB + +### variableB1 + +_DECLARATION_MEMBER_PARTIAL_ + +*** + +### variableB2 + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-namespaces/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-namespaces/index.md new file mode 100644 index 000000000..1f719e874 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-namespaces/index.md @@ -0,0 +1,90 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../modules.md) / has-namespaces + +# has-namespaces + +A module that contains namespaces + +## Index + +### Namespaces + +| Namespace | Description | +| :------ | :------ | +| [\_Namespace\_A\_](namespaces/Namespace_A/index.md) | - | +| [NamespaceB](namespaces/NamespaceB.md) | - | + +## Enumerations + +### \_Enum\_A\_ + +*** + +### EnumB + +## Classes + +### \_\_Class\_A\_ + +#### Constructors + +##### new \_\_Class\_A\_() + +_SIGNATURE_MEMBER_PARTIAL_ + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +_SIGNATURE_MEMBER_PARTIAL_ + +## Interfaces + +### \_Interface\_A\_ + +*** + +### InterfaceB + +## Type Aliases + +### \_Type\_A\_ + +_DECLARATION_MEMBER_PARTIAL_ + +*** + +### TypeB + +_DECLARATION_MEMBER_PARTIAL_ + +## Variables + +### \_variable\_A\_ + +_DECLARATION_MEMBER_PARTIAL_ + +*** + +### variableB + +_DECLARATION_MEMBER_PARTIAL_ + +## Functions + +### \_function\_A\_() + +_SIGNATURE_MEMBER_PARTIAL_ + +*** + +### functionB() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-namespaces/namespaces/NamespaceB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-namespaces/namespaces/NamespaceB.md new file mode 100644 index 000000000..0978f82d1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-namespaces/namespaces/NamespaceB.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../modules.md) / [has-namespaces](../index.md) / NamespaceB + +# NamespaceB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-namespaces/namespaces/Namespace_A/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-namespaces/namespaces/Namespace_A/index.md new file mode 100644 index 000000000..59a53787f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-namespaces/namespaces/Namespace_A/index.md @@ -0,0 +1,19 @@ +[**typedoc-stubs**](../../../index.md) + +*** + +[typedoc-stubs](../../../modules.md) / [has-namespaces](../../index.md) / \_Namespace\_A\_ + +# \_Namespace\_A\_ + +## Index + +### Namespaces + +| Namespace | Description | +| :------ | :------ | +| [NestedNamespace](namespaces/NestedNamespace.md) | - | + +## Interfaces + +### NamespaceInterface diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace.md new file mode 100644 index 000000000..825cec2c0 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace.md @@ -0,0 +1,11 @@ +[**typedoc-stubs**](../../../../index.md) + +*** + +[typedoc-stubs](../../../../modules.md) / [has-namespaces](../../../index.md) / [\_Namespace\_A\_](../index.md) / NestedNamespace + +# NestedNamespace + +## Interfaces + +### NamespaceInterface diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-references.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-references.md new file mode 100644 index 000000000..92da12f9c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-references.md @@ -0,0 +1,29 @@ +[**typedoc-stubs**](index.md) + +*** + +[typedoc-stubs](modules.md) / has-references + +# has-references + +A module that contains references + +## Functions + +### defaultFunction() + +_SIGNATURE_MEMBER_PARTIAL_ + +## References + +### default + +Renames and re-exports [defaultFunction](has-references.md#defaultfunction) + +### InterfaceA + +Re-exports [InterfaceA](basic.md#interfacea) + +### RenamedInterfaceB + +Renames and re-exports [InterfaceB](basic.md#interfaceb) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-same-exports.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-same-exports.md new file mode 100644 index 000000000..0470b2d71 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/has-same-exports.md @@ -0,0 +1,39 @@ +[**typedoc-stubs**](index.md) + +*** + +[typedoc-stubs](modules.md) / has-same-exports + +# has-same-exports + +## Classes + +### someClass + +#### Constructors + +##### new someClass() + +_SIGNATURE_MEMBER_PARTIAL_ + +*** + +### SomeClass + +#### Constructors + +##### new SomeClass() + +_SIGNATURE_MEMBER_PARTIAL_ + +## group1 + +### someFunction() + +_SIGNATURE_MEMBER_PARTIAL_ + +## group2 + +### someFunction() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/index.md new file mode 100644 index 000000000..4fbe2a59f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/index.md @@ -0,0 +1,13 @@ +**typedoc-stubs** + +*** + +# MY README + +> Some block quote + +Some text. + +## Readme heading + +Some text. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/module_index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/module_index.md new file mode 100644 index 000000000..cf42e78b9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/module_index.md @@ -0,0 +1,19 @@ +[**typedoc-stubs**](index.md) + +*** + +[typedoc-stubs](modules.md) / index + +# index + +A module named index + +## Classes + +### SomeClass + +#### Constructors + +##### new SomeClass() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/modules.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/modules.md new file mode 100644 index 000000000..6e8c00281 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/modules.md @@ -0,0 +1,19 @@ +[**typedoc-stubs**](index.md) + +*** + +# typedoc-stubs + +## Modules + +| Module | Description | +| :------ | :------ | +| [\](-internal-.md) | - | +| [42-module-name](42-module-name.md) | - | +| [basic](basic.md) | A basic module | +| [has-categories](has-categories.md) | A module that contains categories | +| [has-custom-groups](has-custom-groups.md) | A module that contains custom groupings | +| [has-namespaces](has-namespaces/index.md) | A module that contains namespaces | +| [has-references](has-references.md) | A module that contains references | +| [has-same-exports](has-same-exports.md) | - | +| [index](module_index.md) | A module named index | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/sidebar.json new file mode 100644 index 000000000..cdad69c27 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-1/sidebar.json @@ -0,0 +1,66 @@ +[ + { + "title": "", + "kind": 2, + "path": "-internal-.md" + }, + { + "title": "42-module-name", + "kind": 2, + "path": "42-module-name.md" + }, + { + "title": "basic", + "kind": 2, + "path": "basic.md" + }, + { + "title": "has-categories", + "kind": 2, + "path": "has-categories.md" + }, + { + "title": "has-custom-groups", + "kind": 2, + "path": "has-custom-groups.md" + }, + { + "title": "has-namespaces", + "kind": 2, + "path": "has-namespaces/index.md", + "children": [ + { + "title": "_Namespace_A_", + "kind": 4, + "path": "has-namespaces/namespaces/Namespace_A/index.md", + "children": [ + { + "title": "NestedNamespace", + "kind": 4, + "path": "has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace.md" + } + ] + }, + { + "title": "NamespaceB", + "kind": 4, + "path": "has-namespaces/namespaces/NamespaceB.md" + } + ] + }, + { + "title": "has-references", + "kind": 2, + "path": "has-references.md" + }, + { + "title": "has-same-exports", + "kind": 2, + "path": "has-same-exports.md" + }, + { + "title": "index", + "kind": 2, + "path": "module_index.md" + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/-internal-.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/-internal-.md new file mode 100644 index 000000000..bd9d962fe --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/-internal-.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](index.md) + +*** + +[typedoc-stubs](index.md) / \ + +# \ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/42-module-name.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/42-module-name.md new file mode 100644 index 000000000..19aee09fc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/42-module-name.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](index.md) + +*** + +[typedoc-stubs](index.md) / 42-module-name + +# 42-module-name diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/basic.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/basic.md new file mode 100644 index 000000000..a4e068ce7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/basic.md @@ -0,0 +1,132 @@ +[**typedoc-stubs**](index.md) + +*** + +[typedoc-stubs](index.md) / basic + +# basic + +A basic module + + + +## functionA() + +_SIGNATURE_MEMBER_PARTIAL_ + +*** + + + +## InterfaceA + +Interface A comments line 1 +and comments on a soft line. + +Comments on double new line. + +```typescript +const a = new InterfaceA(); +``` + +### Remarks + +Block tag content. + +### Properties + + + +#### propA + +_DECLARATION_MEMBER_PARTIAL_ + + + +#### propB + +_DECLARATION_MEMBER_PARTIAL_ + +*** + + + +## InterfaceB + +InterfaceB function. + +*** + + + +## ClassA + +ClassA function. + +### Constructors + + + +#### new ClassA() + +_SIGNATURE_MEMBER_PARTIAL_ + +*** + + + +## ClassB + +### Constructors + + + +#### new ClassB() + +_SIGNATURE_MEMBER_PARTIAL_ + +*** + + + +## EnumA + +EnumA function. + +*** + + + +## EnumB + +*** + + + +## TypeA + +_DECLARATION_MEMBER_PARTIAL_ + +*** + + + +## TypeB() + +_DECLARATION_MEMBER_PARTIAL_ + +*** + + + +## variableA + +_DECLARATION_MEMBER_PARTIAL_ + +*** + + + +## variableB + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-categories.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-categories.md new file mode 100644 index 000000000..bcafabd54 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-categories.md @@ -0,0 +1,81 @@ +[**typedoc-stubs**](index.md) + +*** + +[typedoc-stubs](index.md) / has-categories + +# has-categories + +A module that contains categories + +## Category A + + + +### CategoryAEnum1 + +*** + + + +### CategoryAEnum2 + +*** + + + +### CategoryAInterface1 + +*** + + + +### CategoryAInterface2 + +## Category B + + + +### CategoryBEnum1 + +*** + + + +### CategoryBEnum2 + +*** + + + +### CategoryBInterface1 + +*** + + + +### CategoryBInterface2 + +## Category C + + + +### CategoryCInterface1 + +## Other + + + +### UnCategorizedEnum + +*** + + + +### CategoryCInterface2 + +*** + + + +### UnCategorizedInterace diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-custom-groups.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-custom-groups.md new file mode 100644 index 000000000..667a77418 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-custom-groups.md @@ -0,0 +1,39 @@ +[**typedoc-stubs**](index.md) + +*** + +[typedoc-stubs](index.md) / has-custom-groups + +# has-custom-groups + +A module that contains custom groupings + + + +## variabelA + +_DECLARATION_MEMBER_PARTIAL_ + +*** + + + +## variableB1 + +_DECLARATION_MEMBER_PARTIAL_ + +*** + + + +## variableB2 + +_DECLARATION_MEMBER_PARTIAL_ + +*** + + + +## variableC + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-namespaces/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-namespaces/index.md new file mode 100644 index 000000000..a65939355 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-namespaces/index.md @@ -0,0 +1,146 @@ +[**typedoc-stubs**](../index.md) + +*** + +[typedoc-stubs](../index.md) / has-namespaces + +# has-namespaces + +A module that contains namespaces + +## Index + +### Namespaces + + + + + + + + + + + + + + + + + + +
NamespaceDescription
+ +[\_Namespace\_A\_](namespaces/Namespace_A/index.md) + + + +‐ + +
+ +[NamespaceB](namespaces/NamespaceB.md) + + + +‐ + +
+ + + +## \_function\_A\_() + +_SIGNATURE_MEMBER_PARTIAL_ + +*** + + + +## functionB() + +_SIGNATURE_MEMBER_PARTIAL_ + +*** + + + +## \_Interface\_A\_ + +*** + + + +## InterfaceB + +*** + + + +## \_\_Class\_A\_ + +### Constructors + + + +#### new \_\_Class\_A\_() + +_SIGNATURE_MEMBER_PARTIAL_ + +*** + + + +## ClassB + +### Constructors + + + +#### new ClassB() + +_SIGNATURE_MEMBER_PARTIAL_ + +*** + + + +## \_Enum\_A\_ + +*** + + + +## EnumB + +*** + + + +## \_Type\_A\_ + +_DECLARATION_MEMBER_PARTIAL_ + +*** + + + +## TypeB + +_DECLARATION_MEMBER_PARTIAL_ + +*** + + + +## \_variable\_A\_ + +_DECLARATION_MEMBER_PARTIAL_ + +*** + + + +## variableB + +_DECLARATION_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-namespaces/namespaces/NamespaceB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-namespaces/namespaces/NamespaceB.md new file mode 100644 index 000000000..6495c2c09 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-namespaces/namespaces/NamespaceB.md @@ -0,0 +1,7 @@ +[**typedoc-stubs**](../../index.md) + +*** + +[typedoc-stubs](../../index.md) / [has-namespaces](../index.md) / NamespaceB + +# NamespaceB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-namespaces/namespaces/Namespace_A/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-namespaces/namespaces/Namespace_A/index.md new file mode 100644 index 000000000..414e416d8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-namespaces/namespaces/Namespace_A/index.md @@ -0,0 +1,38 @@ +[**typedoc-stubs**](../../../index.md) + +*** + +[typedoc-stubs](../../../index.md) / [has-namespaces](../../index.md) / \_Namespace\_A\_ + +# \_Namespace\_A\_ + +## Index + +### Namespaces + + + + + + + + + + + + + + +
NamespaceDescription
+ +[NestedNamespace](namespaces/NestedNamespace.md) + + + +‐ + +
+ + + +## NamespaceInterface diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace.md new file mode 100644 index 000000000..6f50756c8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace.md @@ -0,0 +1,11 @@ +[**typedoc-stubs**](../../../../index.md) + +*** + +[typedoc-stubs](../../../../index.md) / [has-namespaces](../../../index.md) / [\_Namespace\_A\_](../index.md) / NestedNamespace + +# NestedNamespace + + + +## NamespaceInterface diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-references.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-references.md new file mode 100644 index 000000000..4d3e0a0bf --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-references.md @@ -0,0 +1,35 @@ +[**typedoc-stubs**](index.md) + +*** + +[typedoc-stubs](index.md) / has-references + +# has-references + +A module that contains references + + + +## defaultFunction() + +_SIGNATURE_MEMBER_PARTIAL_ + +*** + + + +## default + +Renames and re-exports [defaultFunction](has-references.md#defaultfunction) + + + +## InterfaceA + +Re-exports [InterfaceA](basic.md#interfacea) + + + +## RenamedInterfaceB + +Renames and re-exports [InterfaceB](basic.md#interfaceb) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-same-exports.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-same-exports.md new file mode 100644 index 000000000..befe08c86 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/has-same-exports.md @@ -0,0 +1,49 @@ +[**typedoc-stubs**](index.md) + +*** + +[typedoc-stubs](index.md) / has-same-exports + +# has-same-exports + + + +## someClass + +### Constructors + + + +#### new someClass() + +_SIGNATURE_MEMBER_PARTIAL_ + +*** + + + +## SomeClass + +### Constructors + + + +#### new SomeClass() + +_SIGNATURE_MEMBER_PARTIAL_ + +*** + + + +## someFunction() + +_SIGNATURE_MEMBER_PARTIAL_ + +*** + + + +## someFunction() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/index.md new file mode 100644 index 000000000..19c87e92a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/index.md @@ -0,0 +1,126 @@ +**typedoc-stubs** + +*** + +# typedoc-stubs + +## Modules + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ModuleDescription
+ +[\](-internal-.md) + + + +‐ + +
+ +[42-module-name](42-module-name.md) + + + +‐ + +
+ +[basic](basic.md) + + + +A basic module + +
+ +[has-categories](has-categories.md) + + + +A module that contains categories + +
+ +[has-custom-groups](has-custom-groups.md) + + + +A module that contains custom groupings + +
+ +[has-namespaces](has-namespaces/index.md) + + + +A module that contains namespaces + +
+ +[has-references](has-references.md) + + + +A module that contains references + +
+ +[has-same-exports](has-same-exports.md) + + + +‐ + +
+ +[index](module_index.md) + + + +A module named index + +
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/module_index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/module_index.md new file mode 100644 index 000000000..9a5f70c3e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/module_index.md @@ -0,0 +1,21 @@ +[**typedoc-stubs**](index.md) + +*** + +[typedoc-stubs](index.md) / index + +# index + +A module named index + + + +## SomeClass + +### Constructors + + + +#### new SomeClass() + +_SIGNATURE_MEMBER_PARTIAL_ diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/sidebar.json new file mode 100644 index 000000000..971c17460 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/groups/modules/opts-2/sidebar.json @@ -0,0 +1,76 @@ +[ + { + "title": "", + "kind": 2, + "path": "-internal-.md" + }, + { + "title": "42-module-name", + "kind": 2, + "path": "42-module-name.md" + }, + { + "title": "basic", + "kind": 2, + "path": "basic.md" + }, + { + "title": "has-categories", + "kind": 2, + "path": "has-categories.md" + }, + { + "title": "has-custom-groups", + "kind": 2, + "path": "has-custom-groups.md" + }, + { + "title": "has-namespaces", + "kind": 2, + "path": "has-namespaces/index.md", + "children": [ + { + "title": "Namespaces", + "children": [ + { + "title": "_Namespace_A_", + "kind": 4, + "path": "has-namespaces/namespaces/Namespace_A/index.md", + "children": [ + { + "title": "Namespaces", + "children": [ + { + "title": "NestedNamespace", + "kind": 4, + "path": "has-namespaces/namespaces/Namespace_A/namespaces/NestedNamespace.md" + } + ] + } + ] + }, + { + "title": "NamespaceB", + "kind": 4, + "path": "has-namespaces/namespaces/NamespaceB.md" + } + ] + } + ] + }, + { + "title": "has-references", + "kind": 2, + "path": "has-references.md" + }, + { + "title": "has-same-exports", + "kind": 2, + "path": "has-same-exports.md" + }, + { + "title": "index", + "kind": 2, + "path": "module_index.md" + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/README.md new file mode 100644 index 000000000..8bc10a451 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/README.md @@ -0,0 +1,9 @@ +# MY README + +> Some block quote + +Some text. + +## Readme heading + +Some text. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/Test_Module_Name/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/Test_Module_Name/README.md new file mode 100644 index 000000000..59a3d2ec6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/Test_Module_Name/README.md @@ -0,0 +1,7 @@ +# "/Test/Module/Name" + +## Index + +### Interfaces + +- [InterfaceA](interfaces/InterfaceA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/Test_Module_Name/interfaces/InterfaceA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/Test_Module_Name/interfaces/InterfaceA.md new file mode 100644 index 000000000..05ebc7537 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/Test_Module_Name/interfaces/InterfaceA.md @@ -0,0 +1 @@ +# Interface: InterfaceA diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/README.md new file mode 100644 index 000000000..7c916449a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/README.md @@ -0,0 +1,23 @@ +# module-1/submodules/submodule-1 + +## Index + +### Enumerations + +- [EnumA](enumerations/EnumA.md) +- [EnumB](enumerations/EnumB.md) + +### Classes + +- [ClassA](classes/ClassA.md) +- [ClassB](classes/ClassB.md) + +### Interfaces + +- [InterfaceA](interfaces/InterfaceA.md) +- [InterfaceB](interfaces/InterfaceB.md) + +### Type Aliases + +- [TypeA](type-aliases/TypeA.md) +- [TypeB](type-aliases/TypeB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/classes/ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/classes/ClassA.md new file mode 100644 index 000000000..b05380e0c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/classes/ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/classes/ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/classes/ClassB.md new file mode 100644 index 000000000..de4b002bc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/classes/ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/enumerations/EnumA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/enumerations/EnumA.md new file mode 100644 index 000000000..47905ba52 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/enumerations/EnumA.md @@ -0,0 +1 @@ +# Enumeration: EnumA diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/enumerations/EnumB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/enumerations/EnumB.md new file mode 100644 index 000000000..7ee0c78ec --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/enumerations/EnumB.md @@ -0,0 +1 @@ +# Enumeration: EnumB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/interfaces/InterfaceA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/interfaces/InterfaceA.md new file mode 100644 index 000000000..61a12bee5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/interfaces/InterfaceA.md @@ -0,0 +1,13 @@ +# Interface: InterfaceA + +## Properties + +### propA + +> **propA**: `string` + +*** + +### propB + +> **propB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/interfaces/InterfaceB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/interfaces/InterfaceB.md new file mode 100644 index 000000000..635164782 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/interfaces/InterfaceB.md @@ -0,0 +1 @@ +# Interface: InterfaceB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/type-aliases/TypeA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/type-aliases/TypeA.md new file mode 100644 index 000000000..151203337 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/type-aliases/TypeA.md @@ -0,0 +1,3 @@ +# Type Alias: TypeA + +> **TypeA**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/type-aliases/TypeB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/type-aliases/TypeB.md new file mode 100644 index 000000000..ae447470c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-1/type-aliases/TypeB.md @@ -0,0 +1,3 @@ +# Type Alias: TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/README.md new file mode 100644 index 000000000..a7ac7c734 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/README.md @@ -0,0 +1,23 @@ +# module-1/submodules/submodule-2 + +## Index + +### Enumerations + +- [EnumA](enumerations/EnumA.md) +- [EnumB](enumerations/EnumB.md) + +### Classes + +- [ClassA](classes/ClassA.md) +- [ClassB](classes/ClassB.md) + +### Interfaces + +- [InterfaceA](interfaces/InterfaceA.md) +- [InterfaceB](interfaces/InterfaceB.md) + +### Type Aliases + +- [TypeA](type-aliases/TypeA.md) +- [TypeB](type-aliases/TypeB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/classes/ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/classes/ClassA.md new file mode 100644 index 000000000..b05380e0c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/classes/ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/classes/ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/classes/ClassB.md new file mode 100644 index 000000000..de4b002bc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/classes/ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/enumerations/EnumA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/enumerations/EnumA.md new file mode 100644 index 000000000..47905ba52 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/enumerations/EnumA.md @@ -0,0 +1 @@ +# Enumeration: EnumA diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/enumerations/EnumB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/enumerations/EnumB.md new file mode 100644 index 000000000..7ee0c78ec --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/enumerations/EnumB.md @@ -0,0 +1 @@ +# Enumeration: EnumB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/interfaces/InterfaceA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/interfaces/InterfaceA.md new file mode 100644 index 000000000..61a12bee5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/interfaces/InterfaceA.md @@ -0,0 +1,13 @@ +# Interface: InterfaceA + +## Properties + +### propA + +> **propA**: `string` + +*** + +### propB + +> **propB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/interfaces/InterfaceB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/interfaces/InterfaceB.md new file mode 100644 index 000000000..635164782 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/interfaces/InterfaceB.md @@ -0,0 +1 @@ +# Interface: InterfaceB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/type-aliases/TypeA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/type-aliases/TypeA.md new file mode 100644 index 000000000..151203337 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/type-aliases/TypeA.md @@ -0,0 +1,3 @@ +# Type Alias: TypeA + +> **TypeA**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/type-aliases/TypeB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/type-aliases/TypeB.md new file mode 100644 index 000000000..ae447470c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-2/type-aliases/TypeB.md @@ -0,0 +1,3 @@ +# Type Alias: TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/README.md new file mode 100644 index 000000000..d7065b066 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/README.md @@ -0,0 +1,23 @@ +# module-1/submodules/submodule-3-with-modules/nested-submodule-1 + +## Index + +### Enumerations + +- [EnumA](enumerations/EnumA.md) +- [EnumB](enumerations/EnumB.md) + +### Classes + +- [ClassA](classes/ClassA.md) +- [ClassB](classes/ClassB.md) + +### Interfaces + +- [InterfaceA](interfaces/InterfaceA.md) +- [InterfaceB](interfaces/InterfaceB.md) + +### Type Aliases + +- [TypeA](type-aliases/TypeA.md) +- [TypeB](type-aliases/TypeB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassA.md new file mode 100644 index 000000000..b05380e0c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassB.md new file mode 100644 index 000000000..de4b002bc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/enumerations/EnumA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/enumerations/EnumA.md new file mode 100644 index 000000000..47905ba52 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/enumerations/EnumA.md @@ -0,0 +1 @@ +# Enumeration: EnumA diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/enumerations/EnumB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/enumerations/EnumB.md new file mode 100644 index 000000000..7ee0c78ec --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/enumerations/EnumB.md @@ -0,0 +1 @@ +# Enumeration: EnumB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/interfaces/InterfaceA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/interfaces/InterfaceA.md new file mode 100644 index 000000000..61a12bee5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/interfaces/InterfaceA.md @@ -0,0 +1,13 @@ +# Interface: InterfaceA + +## Properties + +### propA + +> **propA**: `string` + +*** + +### propB + +> **propB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/interfaces/InterfaceB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/interfaces/InterfaceB.md new file mode 100644 index 000000000..635164782 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/interfaces/InterfaceB.md @@ -0,0 +1 @@ +# Interface: InterfaceB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/type-aliases/TypeA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/type-aliases/TypeA.md new file mode 100644 index 000000000..151203337 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/type-aliases/TypeA.md @@ -0,0 +1,3 @@ +# Type Alias: TypeA + +> **TypeA**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/type-aliases/TypeB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/type-aliases/TypeB.md new file mode 100644 index 000000000..ae447470c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1/type-aliases/TypeB.md @@ -0,0 +1,3 @@ +# Type Alias: TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/README.md new file mode 100644 index 000000000..7dc57472b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/README.md @@ -0,0 +1,23 @@ +# module-1/submodules/submodule-3-with-modules/nested-submodule-2 + +## Index + +### Enumerations + +- [EnumA](enumerations/EnumA.md) +- [EnumB](enumerations/EnumB.md) + +### Classes + +- [ClassA](classes/ClassA.md) +- [ClassB](classes/ClassB.md) + +### Interfaces + +- [InterfaceA](interfaces/InterfaceA.md) +- [InterfaceB](interfaces/InterfaceB.md) + +### Type Aliases + +- [TypeA](type-aliases/TypeA.md) +- [TypeB](type-aliases/TypeB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassA.md new file mode 100644 index 000000000..b05380e0c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassB.md new file mode 100644 index 000000000..de4b002bc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/enumerations/EnumA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/enumerations/EnumA.md new file mode 100644 index 000000000..47905ba52 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/enumerations/EnumA.md @@ -0,0 +1 @@ +# Enumeration: EnumA diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/enumerations/EnumB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/enumerations/EnumB.md new file mode 100644 index 000000000..7ee0c78ec --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/enumerations/EnumB.md @@ -0,0 +1 @@ +# Enumeration: EnumB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/interfaces/InterfaceA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/interfaces/InterfaceA.md new file mode 100644 index 000000000..61a12bee5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/interfaces/InterfaceA.md @@ -0,0 +1,13 @@ +# Interface: InterfaceA + +## Properties + +### propA + +> **propA**: `string` + +*** + +### propB + +> **propB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/interfaces/InterfaceB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/interfaces/InterfaceB.md new file mode 100644 index 000000000..635164782 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/interfaces/InterfaceB.md @@ -0,0 +1 @@ +# Interface: InterfaceB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/type-aliases/TypeA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/type-aliases/TypeA.md new file mode 100644 index 000000000..151203337 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/type-aliases/TypeA.md @@ -0,0 +1,3 @@ +# Type Alias: TypeA + +> **TypeA**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/type-aliases/TypeB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/type-aliases/TypeB.md new file mode 100644 index 000000000..ae447470c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2/type-aliases/TypeB.md @@ -0,0 +1,3 @@ +# Type Alias: TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/README.md new file mode 100644 index 000000000..734fee757 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/README.md @@ -0,0 +1,23 @@ +# module-2 + +## Index + +### Enumerations + +- [EnumA](enumerations/EnumA.md) +- [EnumB](enumerations/EnumB.md) + +### Classes + +- [ClassA](classes/ClassA.md) +- [ClassB](classes/ClassB.md) + +### Interfaces + +- [InterfaceA](interfaces/InterfaceA.md) +- [InterfaceB](interfaces/InterfaceB.md) + +### Type Aliases + +- [TypeA](type-aliases/TypeA.md) +- [TypeB](type-aliases/TypeB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/classes/ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/classes/ClassA.md new file mode 100644 index 000000000..b05380e0c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/classes/ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/classes/ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/classes/ClassB.md new file mode 100644 index 000000000..de4b002bc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/classes/ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/enumerations/EnumA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/enumerations/EnumA.md new file mode 100644 index 000000000..47905ba52 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/enumerations/EnumA.md @@ -0,0 +1 @@ +# Enumeration: EnumA diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/enumerations/EnumB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/enumerations/EnumB.md new file mode 100644 index 000000000..7ee0c78ec --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/enumerations/EnumB.md @@ -0,0 +1 @@ +# Enumeration: EnumB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/interfaces/InterfaceA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/interfaces/InterfaceA.md new file mode 100644 index 000000000..61a12bee5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/interfaces/InterfaceA.md @@ -0,0 +1,13 @@ +# Interface: InterfaceA + +## Properties + +### propA + +> **propA**: `string` + +*** + +### propB + +> **propB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/interfaces/InterfaceB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/interfaces/InterfaceB.md new file mode 100644 index 000000000..635164782 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/interfaces/InterfaceB.md @@ -0,0 +1 @@ +# Interface: InterfaceB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/type-aliases/TypeA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/type-aliases/TypeA.md new file mode 100644 index 000000000..151203337 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/type-aliases/TypeA.md @@ -0,0 +1,3 @@ +# Type Alias: TypeA + +> **TypeA**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/type-aliases/TypeB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/type-aliases/TypeB.md new file mode 100644 index 000000000..ae447470c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/module-2/type-aliases/TypeB.md @@ -0,0 +1,3 @@ +# Type Alias: TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/modules.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/modules.md new file mode 100644 index 000000000..1838aa46d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/modules.md @@ -0,0 +1,11 @@ +# typedoc-stubs + +## Modules + +- ["/Test/Module/Name"](Test_Module_Name/README.md) +- [@scope/namespace](namespace/README.md) +- [module-1/submodules/submodule-1](module-1/submodules/submodule-1/README.md) +- [module-1/submodules/submodule-2](module-1/submodules/submodule-2/README.md) +- [module-1/submodules/submodule-3-with-modules/nested-submodule-1](module-1/submodules/submodule-3-with-modules/nested-submodule-1/README.md) +- [module-1/submodules/submodule-3-with-modules/nested-submodule-2](module-1/submodules/submodule-3-with-modules/nested-submodule-2/README.md) +- [module-2](module-2/README.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/README.md new file mode 100644 index 000000000..b9e9c0be8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/README.md @@ -0,0 +1,23 @@ +# @scope/namespace + +## Index + +### Enumerations + +- [EnumA](enumerations/EnumA.md) +- [EnumB](enumerations/EnumB.md) + +### Classes + +- [ClassA](classes/ClassA.md) +- [ClassB](classes/ClassB.md) + +### Interfaces + +- [InterfaceA](interfaces/InterfaceA.md) +- [InterfaceB](interfaces/InterfaceB.md) + +### Type Aliases + +- [TypeA](type-aliases/TypeA.md) +- [TypeB](type-aliases/TypeB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/classes/ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/classes/ClassA.md new file mode 100644 index 000000000..b05380e0c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/classes/ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/classes/ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/classes/ClassB.md new file mode 100644 index 000000000..de4b002bc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/classes/ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/enumerations/EnumA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/enumerations/EnumA.md new file mode 100644 index 000000000..47905ba52 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/enumerations/EnumA.md @@ -0,0 +1 @@ +# Enumeration: EnumA diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/enumerations/EnumB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/enumerations/EnumB.md new file mode 100644 index 000000000..7ee0c78ec --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/enumerations/EnumB.md @@ -0,0 +1 @@ +# Enumeration: EnumB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/interfaces/InterfaceA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/interfaces/InterfaceA.md new file mode 100644 index 000000000..61a12bee5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/interfaces/InterfaceA.md @@ -0,0 +1,13 @@ +# Interface: InterfaceA + +## Properties + +### propA + +> **propA**: `string` + +*** + +### propB + +> **propB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/interfaces/InterfaceB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/interfaces/InterfaceB.md new file mode 100644 index 000000000..635164782 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/interfaces/InterfaceB.md @@ -0,0 +1 @@ +# Interface: InterfaceB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/type-aliases/TypeA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/type-aliases/TypeA.md new file mode 100644 index 000000000..151203337 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/type-aliases/TypeA.md @@ -0,0 +1,3 @@ +# Type Alias: TypeA + +> **TypeA**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/type-aliases/TypeB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/type-aliases/TypeB.md new file mode 100644 index 000000000..ae447470c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/namespace/type-aliases/TypeB.md @@ -0,0 +1,3 @@ +# Type Alias: TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/sidebar.json new file mode 100644 index 000000000..afe67c49b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-1/sidebar.json @@ -0,0 +1,436 @@ +[ + { + "title": "\"/Test/Module/Name\"", + "kind": 2, + "path": "Test_Module_Name/README.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceA", + "kind": 256, + "path": "Test_Module_Name/interfaces/InterfaceA.md" + } + ] + } + ] + }, + { + "title": "@scope/namespace", + "kind": 2, + "path": "namespace/README.md", + "children": [ + { + "title": "Enumerations", + "children": [ + { + "title": "EnumA", + "kind": 8, + "path": "namespace/enumerations/EnumA.md" + }, + { + "title": "EnumB", + "kind": 8, + "path": "namespace/enumerations/EnumB.md" + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "namespace/classes/ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "namespace/classes/ClassB.md" + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceA", + "kind": 256, + "path": "namespace/interfaces/InterfaceA.md" + }, + { + "title": "InterfaceB", + "kind": 256, + "path": "namespace/interfaces/InterfaceB.md" + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeA", + "kind": 2097152, + "path": "namespace/type-aliases/TypeA.md" + }, + { + "title": "TypeB", + "kind": 2097152, + "path": "namespace/type-aliases/TypeB.md" + } + ] + } + ] + }, + { + "title": "module-1", + "children": [ + { + "title": "submodules", + "children": [ + { + "title": "submodule-1", + "kind": 2, + "path": "module-1/submodules/submodule-1/README.md", + "children": [ + { + "title": "Enumerations", + "children": [ + { + "title": "EnumA", + "kind": 8, + "path": "module-1/submodules/submodule-1/enumerations/EnumA.md" + }, + { + "title": "EnumB", + "kind": 8, + "path": "module-1/submodules/submodule-1/enumerations/EnumB.md" + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "module-1/submodules/submodule-1/classes/ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "module-1/submodules/submodule-1/classes/ClassB.md" + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceA", + "kind": 256, + "path": "module-1/submodules/submodule-1/interfaces/InterfaceA.md" + }, + { + "title": "InterfaceB", + "kind": 256, + "path": "module-1/submodules/submodule-1/interfaces/InterfaceB.md" + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeA", + "kind": 2097152, + "path": "module-1/submodules/submodule-1/type-aliases/TypeA.md" + }, + { + "title": "TypeB", + "kind": 2097152, + "path": "module-1/submodules/submodule-1/type-aliases/TypeB.md" + } + ] + } + ] + }, + { + "title": "submodule-2", + "kind": 2, + "path": "module-1/submodules/submodule-2/README.md", + "children": [ + { + "title": "Enumerations", + "children": [ + { + "title": "EnumA", + "kind": 8, + "path": "module-1/submodules/submodule-2/enumerations/EnumA.md" + }, + { + "title": "EnumB", + "kind": 8, + "path": "module-1/submodules/submodule-2/enumerations/EnumB.md" + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "module-1/submodules/submodule-2/classes/ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "module-1/submodules/submodule-2/classes/ClassB.md" + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceA", + "kind": 256, + "path": "module-1/submodules/submodule-2/interfaces/InterfaceA.md" + }, + { + "title": "InterfaceB", + "kind": 256, + "path": "module-1/submodules/submodule-2/interfaces/InterfaceB.md" + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeA", + "kind": 2097152, + "path": "module-1/submodules/submodule-2/type-aliases/TypeA.md" + }, + { + "title": "TypeB", + "kind": 2097152, + "path": "module-1/submodules/submodule-2/type-aliases/TypeB.md" + } + ] + } + ] + }, + { + "title": "submodule-3-with-modules", + "children": [ + { + "title": "nested-submodule-1", + "kind": 2, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-1/README.md", + "children": [ + { + "title": "Enumerations", + "children": [ + { + "title": "EnumA", + "kind": 8, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-1/enumerations/EnumA.md" + }, + { + "title": "EnumB", + "kind": 8, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-1/enumerations/EnumB.md" + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassB.md" + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceA", + "kind": 256, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-1/interfaces/InterfaceA.md" + }, + { + "title": "InterfaceB", + "kind": 256, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-1/interfaces/InterfaceB.md" + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeA", + "kind": 2097152, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-1/type-aliases/TypeA.md" + }, + { + "title": "TypeB", + "kind": 2097152, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-1/type-aliases/TypeB.md" + } + ] + } + ] + }, + { + "title": "nested-submodule-2", + "kind": 2, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-2/README.md", + "children": [ + { + "title": "Enumerations", + "children": [ + { + "title": "EnumA", + "kind": 8, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-2/enumerations/EnumA.md" + }, + { + "title": "EnumB", + "kind": 8, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-2/enumerations/EnumB.md" + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassB.md" + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceA", + "kind": 256, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-2/interfaces/InterfaceA.md" + }, + { + "title": "InterfaceB", + "kind": 256, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-2/interfaces/InterfaceB.md" + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeA", + "kind": 2097152, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-2/type-aliases/TypeA.md" + }, + { + "title": "TypeB", + "kind": 2097152, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-2/type-aliases/TypeB.md" + } + ] + } + ] + } + ] + } + ] + } + ] + }, + { + "title": "module-2", + "kind": 2, + "path": "module-2/README.md", + "children": [ + { + "title": "Enumerations", + "children": [ + { + "title": "EnumA", + "kind": 8, + "path": "module-2/enumerations/EnumA.md" + }, + { + "title": "EnumB", + "kind": 8, + "path": "module-2/enumerations/EnumB.md" + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "module-2/classes/ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "module-2/classes/ClassB.md" + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceA", + "kind": 256, + "path": "module-2/interfaces/InterfaceA.md" + }, + { + "title": "InterfaceB", + "kind": 256, + "path": "module-2/interfaces/InterfaceB.md" + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeA", + "kind": 2097152, + "path": "module-2/type-aliases/TypeA.md" + }, + { + "title": "TypeB", + "kind": 2097152, + "path": "module-2/type-aliases/TypeB.md" + } + ] + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Class.ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Class.ClassA.md new file mode 100644 index 000000000..33aca0ccf --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Class.ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](@scope.namespace.Class.ClassA.md) + +#### Returns + +[`ClassA`](@scope.namespace.Class.ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Class.ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Class.ClassB.md new file mode 100644 index 000000000..9ad5ebe44 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Class.ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](@scope.namespace.Class.ClassB.md) + +#### Returns + +[`ClassB`](@scope.namespace.Class.ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Enumeration.EnumA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Enumeration.EnumA.md new file mode 100644 index 000000000..47905ba52 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Enumeration.EnumA.md @@ -0,0 +1 @@ +# Enumeration: EnumA diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Enumeration.EnumB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Enumeration.EnumB.md new file mode 100644 index 000000000..7ee0c78ec --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Enumeration.EnumB.md @@ -0,0 +1 @@ +# Enumeration: EnumB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Interface.InterfaceA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Interface.InterfaceA.md new file mode 100644 index 000000000..61a12bee5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Interface.InterfaceA.md @@ -0,0 +1,13 @@ +# Interface: InterfaceA + +## Properties + +### propA + +> **propA**: `string` + +*** + +### propB + +> **propB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Interface.InterfaceB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Interface.InterfaceB.md new file mode 100644 index 000000000..635164782 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.Interface.InterfaceB.md @@ -0,0 +1 @@ +# Interface: InterfaceB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.TypeAlias.TypeA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.TypeAlias.TypeA.md new file mode 100644 index 000000000..151203337 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.TypeAlias.TypeA.md @@ -0,0 +1,3 @@ +# Type Alias: TypeA + +> **TypeA**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.TypeAlias.TypeB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.TypeAlias.TypeB.md new file mode 100644 index 000000000..ae447470c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.TypeAlias.TypeB.md @@ -0,0 +1,3 @@ +# Type Alias: TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.md new file mode 100644 index 000000000..2745feedf --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/@scope.namespace.md @@ -0,0 +1,23 @@ +# @scope/namespace + +## Index + +### Enumerations + +- [EnumA](@scope.namespace.Enumeration.EnumA.md) +- [EnumB](@scope.namespace.Enumeration.EnumB.md) + +### Classes + +- [ClassA](@scope.namespace.Class.ClassA.md) +- [ClassB](@scope.namespace.Class.ClassB.md) + +### Interfaces + +- [InterfaceA](@scope.namespace.Interface.InterfaceA.md) +- [InterfaceB](@scope.namespace.Interface.InterfaceB.md) + +### Type Aliases + +- [TypeA](@scope.namespace.TypeAlias.TypeA.md) +- [TypeB](@scope.namespace.TypeAlias.TypeB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/README.md new file mode 100644 index 000000000..8bc10a451 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/README.md @@ -0,0 +1,9 @@ +# MY README + +> Some block quote + +Some text. + +## Readme heading + +Some text. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/Test.Module.Name.Interface.InterfaceA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/Test.Module.Name.Interface.InterfaceA.md new file mode 100644 index 000000000..05ebc7537 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/Test.Module.Name.Interface.InterfaceA.md @@ -0,0 +1 @@ +# Interface: InterfaceA diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/Test.Module.Name.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/Test.Module.Name.md new file mode 100644 index 000000000..f4d3ddfac --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/Test.Module.Name.md @@ -0,0 +1,7 @@ +# "/Test/Module/Name" + +## Index + +### Interfaces + +- [InterfaceA](Test.Module.Name.Interface.InterfaceA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/documentation.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/documentation.md new file mode 100644 index 000000000..02b252a27 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/documentation.md @@ -0,0 +1,11 @@ +# typedoc-stubs + +## Modules + +- ["/Test/Module/Name"](Test.Module.Name.md) +- [@scope/namespace](@scope.namespace.md) +- [module-1/submodules/submodule-1](module-1.submodules.submodule-1.md) +- [module-1/submodules/submodule-2](module-1.submodules.submodule-2.md) +- [module-1/submodules/submodule-3-with-modules/nested-submodule-1](module-1.submodules.submodule-3-with-modules.nested-submodule-1.md) +- [module-1/submodules/submodule-3-with-modules/nested-submodule-2](module-1.submodules.submodule-3-with-modules.nested-submodule-2.md) +- [module-2](module-2.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Class.ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Class.ClassA.md new file mode 100644 index 000000000..35811d709 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Class.ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](module-1.submodules.submodule-1.Class.ClassA.md) + +#### Returns + +[`ClassA`](module-1.submodules.submodule-1.Class.ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Class.ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Class.ClassB.md new file mode 100644 index 000000000..faa753561 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Class.ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](module-1.submodules.submodule-1.Class.ClassB.md) + +#### Returns + +[`ClassB`](module-1.submodules.submodule-1.Class.ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Enumeration.EnumA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Enumeration.EnumA.md new file mode 100644 index 000000000..47905ba52 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Enumeration.EnumA.md @@ -0,0 +1 @@ +# Enumeration: EnumA diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Enumeration.EnumB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Enumeration.EnumB.md new file mode 100644 index 000000000..7ee0c78ec --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Enumeration.EnumB.md @@ -0,0 +1 @@ +# Enumeration: EnumB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Interface.InterfaceA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Interface.InterfaceA.md new file mode 100644 index 000000000..61a12bee5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Interface.InterfaceA.md @@ -0,0 +1,13 @@ +# Interface: InterfaceA + +## Properties + +### propA + +> **propA**: `string` + +*** + +### propB + +> **propB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Interface.InterfaceB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Interface.InterfaceB.md new file mode 100644 index 000000000..635164782 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.Interface.InterfaceB.md @@ -0,0 +1 @@ +# Interface: InterfaceB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.TypeAlias.TypeA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.TypeAlias.TypeA.md new file mode 100644 index 000000000..151203337 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.TypeAlias.TypeA.md @@ -0,0 +1,3 @@ +# Type Alias: TypeA + +> **TypeA**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.TypeAlias.TypeB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.TypeAlias.TypeB.md new file mode 100644 index 000000000..ae447470c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.TypeAlias.TypeB.md @@ -0,0 +1,3 @@ +# Type Alias: TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.md new file mode 100644 index 000000000..f1fcc8398 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-1.md @@ -0,0 +1,23 @@ +# module-1/submodules/submodule-1 + +## Index + +### Enumerations + +- [EnumA](module-1.submodules.submodule-1.Enumeration.EnumA.md) +- [EnumB](module-1.submodules.submodule-1.Enumeration.EnumB.md) + +### Classes + +- [ClassA](module-1.submodules.submodule-1.Class.ClassA.md) +- [ClassB](module-1.submodules.submodule-1.Class.ClassB.md) + +### Interfaces + +- [InterfaceA](module-1.submodules.submodule-1.Interface.InterfaceA.md) +- [InterfaceB](module-1.submodules.submodule-1.Interface.InterfaceB.md) + +### Type Aliases + +- [TypeA](module-1.submodules.submodule-1.TypeAlias.TypeA.md) +- [TypeB](module-1.submodules.submodule-1.TypeAlias.TypeB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Class.ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Class.ClassA.md new file mode 100644 index 000000000..9212412f4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Class.ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](module-1.submodules.submodule-2.Class.ClassA.md) + +#### Returns + +[`ClassA`](module-1.submodules.submodule-2.Class.ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Class.ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Class.ClassB.md new file mode 100644 index 000000000..daf2f8d31 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Class.ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](module-1.submodules.submodule-2.Class.ClassB.md) + +#### Returns + +[`ClassB`](module-1.submodules.submodule-2.Class.ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Enumeration.EnumA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Enumeration.EnumA.md new file mode 100644 index 000000000..47905ba52 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Enumeration.EnumA.md @@ -0,0 +1 @@ +# Enumeration: EnumA diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Enumeration.EnumB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Enumeration.EnumB.md new file mode 100644 index 000000000..7ee0c78ec --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Enumeration.EnumB.md @@ -0,0 +1 @@ +# Enumeration: EnumB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Interface.InterfaceA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Interface.InterfaceA.md new file mode 100644 index 000000000..61a12bee5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Interface.InterfaceA.md @@ -0,0 +1,13 @@ +# Interface: InterfaceA + +## Properties + +### propA + +> **propA**: `string` + +*** + +### propB + +> **propB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Interface.InterfaceB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Interface.InterfaceB.md new file mode 100644 index 000000000..635164782 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.Interface.InterfaceB.md @@ -0,0 +1 @@ +# Interface: InterfaceB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.TypeAlias.TypeA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.TypeAlias.TypeA.md new file mode 100644 index 000000000..151203337 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.TypeAlias.TypeA.md @@ -0,0 +1,3 @@ +# Type Alias: TypeA + +> **TypeA**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.TypeAlias.TypeB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.TypeAlias.TypeB.md new file mode 100644 index 000000000..ae447470c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.TypeAlias.TypeB.md @@ -0,0 +1,3 @@ +# Type Alias: TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.md new file mode 100644 index 000000000..c915d8ef9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-2.md @@ -0,0 +1,23 @@ +# module-1/submodules/submodule-2 + +## Index + +### Enumerations + +- [EnumA](module-1.submodules.submodule-2.Enumeration.EnumA.md) +- [EnumB](module-1.submodules.submodule-2.Enumeration.EnumB.md) + +### Classes + +- [ClassA](module-1.submodules.submodule-2.Class.ClassA.md) +- [ClassB](module-1.submodules.submodule-2.Class.ClassB.md) + +### Interfaces + +- [InterfaceA](module-1.submodules.submodule-2.Interface.InterfaceA.md) +- [InterfaceB](module-1.submodules.submodule-2.Interface.InterfaceB.md) + +### Type Aliases + +- [TypeA](module-1.submodules.submodule-2.TypeAlias.TypeA.md) +- [TypeB](module-1.submodules.submodule-2.TypeAlias.TypeB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Class.ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Class.ClassA.md new file mode 100644 index 000000000..daa437152 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Class.ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](module-1.submodules.submodule-3-with-modules.nested-submodule-1.Class.ClassA.md) + +#### Returns + +[`ClassA`](module-1.submodules.submodule-3-with-modules.nested-submodule-1.Class.ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Class.ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Class.ClassB.md new file mode 100644 index 000000000..7e3e5adad --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Class.ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](module-1.submodules.submodule-3-with-modules.nested-submodule-1.Class.ClassB.md) + +#### Returns + +[`ClassB`](module-1.submodules.submodule-3-with-modules.nested-submodule-1.Class.ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Enumeration.EnumA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Enumeration.EnumA.md new file mode 100644 index 000000000..47905ba52 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Enumeration.EnumA.md @@ -0,0 +1 @@ +# Enumeration: EnumA diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Enumeration.EnumB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Enumeration.EnumB.md new file mode 100644 index 000000000..7ee0c78ec --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Enumeration.EnumB.md @@ -0,0 +1 @@ +# Enumeration: EnumB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Interface.InterfaceA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Interface.InterfaceA.md new file mode 100644 index 000000000..61a12bee5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Interface.InterfaceA.md @@ -0,0 +1,13 @@ +# Interface: InterfaceA + +## Properties + +### propA + +> **propA**: `string` + +*** + +### propB + +> **propB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Interface.InterfaceB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Interface.InterfaceB.md new file mode 100644 index 000000000..635164782 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.Interface.InterfaceB.md @@ -0,0 +1 @@ +# Interface: InterfaceB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.TypeAlias.TypeA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.TypeAlias.TypeA.md new file mode 100644 index 000000000..151203337 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.TypeAlias.TypeA.md @@ -0,0 +1,3 @@ +# Type Alias: TypeA + +> **TypeA**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.TypeAlias.TypeB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.TypeAlias.TypeB.md new file mode 100644 index 000000000..ae447470c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.TypeAlias.TypeB.md @@ -0,0 +1,3 @@ +# Type Alias: TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.md new file mode 100644 index 000000000..37a0bd659 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.md @@ -0,0 +1,23 @@ +# module-1/submodules/submodule-3-with-modules/nested-submodule-1 + +## Index + +### Enumerations + +- [EnumA](module-1.submodules.submodule-3-with-modules.nested-submodule-1.Enumeration.EnumA.md) +- [EnumB](module-1.submodules.submodule-3-with-modules.nested-submodule-1.Enumeration.EnumB.md) + +### Classes + +- [ClassA](module-1.submodules.submodule-3-with-modules.nested-submodule-1.Class.ClassA.md) +- [ClassB](module-1.submodules.submodule-3-with-modules.nested-submodule-1.Class.ClassB.md) + +### Interfaces + +- [InterfaceA](module-1.submodules.submodule-3-with-modules.nested-submodule-1.Interface.InterfaceA.md) +- [InterfaceB](module-1.submodules.submodule-3-with-modules.nested-submodule-1.Interface.InterfaceB.md) + +### Type Aliases + +- [TypeA](module-1.submodules.submodule-3-with-modules.nested-submodule-1.TypeAlias.TypeA.md) +- [TypeB](module-1.submodules.submodule-3-with-modules.nested-submodule-1.TypeAlias.TypeB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Class.ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Class.ClassA.md new file mode 100644 index 000000000..8373c1469 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Class.ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](module-1.submodules.submodule-3-with-modules.nested-submodule-2.Class.ClassA.md) + +#### Returns + +[`ClassA`](module-1.submodules.submodule-3-with-modules.nested-submodule-2.Class.ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Class.ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Class.ClassB.md new file mode 100644 index 000000000..be8e8956b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Class.ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](module-1.submodules.submodule-3-with-modules.nested-submodule-2.Class.ClassB.md) + +#### Returns + +[`ClassB`](module-1.submodules.submodule-3-with-modules.nested-submodule-2.Class.ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Enumeration.EnumA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Enumeration.EnumA.md new file mode 100644 index 000000000..47905ba52 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Enumeration.EnumA.md @@ -0,0 +1 @@ +# Enumeration: EnumA diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Enumeration.EnumB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Enumeration.EnumB.md new file mode 100644 index 000000000..7ee0c78ec --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Enumeration.EnumB.md @@ -0,0 +1 @@ +# Enumeration: EnumB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Interface.InterfaceA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Interface.InterfaceA.md new file mode 100644 index 000000000..61a12bee5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Interface.InterfaceA.md @@ -0,0 +1,13 @@ +# Interface: InterfaceA + +## Properties + +### propA + +> **propA**: `string` + +*** + +### propB + +> **propB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Interface.InterfaceB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Interface.InterfaceB.md new file mode 100644 index 000000000..635164782 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.Interface.InterfaceB.md @@ -0,0 +1 @@ +# Interface: InterfaceB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.TypeAlias.TypeA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.TypeAlias.TypeA.md new file mode 100644 index 000000000..151203337 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.TypeAlias.TypeA.md @@ -0,0 +1,3 @@ +# Type Alias: TypeA + +> **TypeA**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.TypeAlias.TypeB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.TypeAlias.TypeB.md new file mode 100644 index 000000000..ae447470c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.TypeAlias.TypeB.md @@ -0,0 +1,3 @@ +# Type Alias: TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.md new file mode 100644 index 000000000..d4d920d80 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.md @@ -0,0 +1,23 @@ +# module-1/submodules/submodule-3-with-modules/nested-submodule-2 + +## Index + +### Enumerations + +- [EnumA](module-1.submodules.submodule-3-with-modules.nested-submodule-2.Enumeration.EnumA.md) +- [EnumB](module-1.submodules.submodule-3-with-modules.nested-submodule-2.Enumeration.EnumB.md) + +### Classes + +- [ClassA](module-1.submodules.submodule-3-with-modules.nested-submodule-2.Class.ClassA.md) +- [ClassB](module-1.submodules.submodule-3-with-modules.nested-submodule-2.Class.ClassB.md) + +### Interfaces + +- [InterfaceA](module-1.submodules.submodule-3-with-modules.nested-submodule-2.Interface.InterfaceA.md) +- [InterfaceB](module-1.submodules.submodule-3-with-modules.nested-submodule-2.Interface.InterfaceB.md) + +### Type Aliases + +- [TypeA](module-1.submodules.submodule-3-with-modules.nested-submodule-2.TypeAlias.TypeA.md) +- [TypeB](module-1.submodules.submodule-3-with-modules.nested-submodule-2.TypeAlias.TypeB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Class.ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Class.ClassA.md new file mode 100644 index 000000000..5b5d8c76d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Class.ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](module-2.Class.ClassA.md) + +#### Returns + +[`ClassA`](module-2.Class.ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Class.ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Class.ClassB.md new file mode 100644 index 000000000..5000e6310 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Class.ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](module-2.Class.ClassB.md) + +#### Returns + +[`ClassB`](module-2.Class.ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Enumeration.EnumA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Enumeration.EnumA.md new file mode 100644 index 000000000..47905ba52 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Enumeration.EnumA.md @@ -0,0 +1 @@ +# Enumeration: EnumA diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Enumeration.EnumB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Enumeration.EnumB.md new file mode 100644 index 000000000..7ee0c78ec --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Enumeration.EnumB.md @@ -0,0 +1 @@ +# Enumeration: EnumB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Interface.InterfaceA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Interface.InterfaceA.md new file mode 100644 index 000000000..61a12bee5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Interface.InterfaceA.md @@ -0,0 +1,13 @@ +# Interface: InterfaceA + +## Properties + +### propA + +> **propA**: `string` + +*** + +### propB + +> **propB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Interface.InterfaceB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Interface.InterfaceB.md new file mode 100644 index 000000000..635164782 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.Interface.InterfaceB.md @@ -0,0 +1 @@ +# Interface: InterfaceB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.TypeAlias.TypeA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.TypeAlias.TypeA.md new file mode 100644 index 000000000..151203337 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.TypeAlias.TypeA.md @@ -0,0 +1,3 @@ +# Type Alias: TypeA + +> **TypeA**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.TypeAlias.TypeB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.TypeAlias.TypeB.md new file mode 100644 index 000000000..ae447470c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.TypeAlias.TypeB.md @@ -0,0 +1,3 @@ +# Type Alias: TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.md new file mode 100644 index 000000000..c81bb7ecb --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/module-2.md @@ -0,0 +1,23 @@ +# module-2 + +## Index + +### Enumerations + +- [EnumA](module-2.Enumeration.EnumA.md) +- [EnumB](module-2.Enumeration.EnumB.md) + +### Classes + +- [ClassA](module-2.Class.ClassA.md) +- [ClassB](module-2.Class.ClassB.md) + +### Interfaces + +- [InterfaceA](module-2.Interface.InterfaceA.md) +- [InterfaceB](module-2.Interface.InterfaceB.md) + +### Type Aliases + +- [TypeA](module-2.TypeAlias.TypeA.md) +- [TypeB](module-2.TypeAlias.TypeB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/sidebar.json new file mode 100644 index 000000000..45ebe20f2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/members/opts-2/sidebar.json @@ -0,0 +1,421 @@ +[ + { + "title": "\"/Test/Module/Name\"", + "kind": 2, + "path": "Test.Module.Name.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceA", + "kind": 256, + "path": "Test.Module.Name.Interface.InterfaceA.md" + } + ] + } + ] + }, + { + "title": "@scope/namespace", + "kind": 2, + "path": "@scope.namespace.md", + "children": [ + { + "title": "Enumerations", + "children": [ + { + "title": "EnumA", + "kind": 8, + "path": "@scope.namespace.Enumeration.EnumA.md" + }, + { + "title": "EnumB", + "kind": 8, + "path": "@scope.namespace.Enumeration.EnumB.md" + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "@scope.namespace.Class.ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "@scope.namespace.Class.ClassB.md" + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceA", + "kind": 256, + "path": "@scope.namespace.Interface.InterfaceA.md" + }, + { + "title": "InterfaceB", + "kind": 256, + "path": "@scope.namespace.Interface.InterfaceB.md" + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeA", + "kind": 2097152, + "path": "@scope.namespace.TypeAlias.TypeA.md" + }, + { + "title": "TypeB", + "kind": 2097152, + "path": "@scope.namespace.TypeAlias.TypeB.md" + } + ] + } + ] + }, + { + "title": "module-1/submodules/submodule-1", + "kind": 2, + "path": "module-1.submodules.submodule-1.md", + "children": [ + { + "title": "Enumerations", + "children": [ + { + "title": "EnumA", + "kind": 8, + "path": "module-1.submodules.submodule-1.Enumeration.EnumA.md" + }, + { + "title": "EnumB", + "kind": 8, + "path": "module-1.submodules.submodule-1.Enumeration.EnumB.md" + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "module-1.submodules.submodule-1.Class.ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "module-1.submodules.submodule-1.Class.ClassB.md" + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceA", + "kind": 256, + "path": "module-1.submodules.submodule-1.Interface.InterfaceA.md" + }, + { + "title": "InterfaceB", + "kind": 256, + "path": "module-1.submodules.submodule-1.Interface.InterfaceB.md" + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeA", + "kind": 2097152, + "path": "module-1.submodules.submodule-1.TypeAlias.TypeA.md" + }, + { + "title": "TypeB", + "kind": 2097152, + "path": "module-1.submodules.submodule-1.TypeAlias.TypeB.md" + } + ] + } + ] + }, + { + "title": "module-1/submodules/submodule-2", + "kind": 2, + "path": "module-1.submodules.submodule-2.md", + "children": [ + { + "title": "Enumerations", + "children": [ + { + "title": "EnumA", + "kind": 8, + "path": "module-1.submodules.submodule-2.Enumeration.EnumA.md" + }, + { + "title": "EnumB", + "kind": 8, + "path": "module-1.submodules.submodule-2.Enumeration.EnumB.md" + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "module-1.submodules.submodule-2.Class.ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "module-1.submodules.submodule-2.Class.ClassB.md" + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceA", + "kind": 256, + "path": "module-1.submodules.submodule-2.Interface.InterfaceA.md" + }, + { + "title": "InterfaceB", + "kind": 256, + "path": "module-1.submodules.submodule-2.Interface.InterfaceB.md" + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeA", + "kind": 2097152, + "path": "module-1.submodules.submodule-2.TypeAlias.TypeA.md" + }, + { + "title": "TypeB", + "kind": 2097152, + "path": "module-1.submodules.submodule-2.TypeAlias.TypeB.md" + } + ] + } + ] + }, + { + "title": "module-1/submodules/submodule-3-with-modules/nested-submodule-1", + "kind": 2, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-1.md", + "children": [ + { + "title": "Enumerations", + "children": [ + { + "title": "EnumA", + "kind": 8, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-1.Enumeration.EnumA.md" + }, + { + "title": "EnumB", + "kind": 8, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-1.Enumeration.EnumB.md" + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-1.Class.ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-1.Class.ClassB.md" + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceA", + "kind": 256, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-1.Interface.InterfaceA.md" + }, + { + "title": "InterfaceB", + "kind": 256, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-1.Interface.InterfaceB.md" + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeA", + "kind": 2097152, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-1.TypeAlias.TypeA.md" + }, + { + "title": "TypeB", + "kind": 2097152, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-1.TypeAlias.TypeB.md" + } + ] + } + ] + }, + { + "title": "module-1/submodules/submodule-3-with-modules/nested-submodule-2", + "kind": 2, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-2.md", + "children": [ + { + "title": "Enumerations", + "children": [ + { + "title": "EnumA", + "kind": 8, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-2.Enumeration.EnumA.md" + }, + { + "title": "EnumB", + "kind": 8, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-2.Enumeration.EnumB.md" + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-2.Class.ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-2.Class.ClassB.md" + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceA", + "kind": 256, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-2.Interface.InterfaceA.md" + }, + { + "title": "InterfaceB", + "kind": 256, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-2.Interface.InterfaceB.md" + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeA", + "kind": 2097152, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-2.TypeAlias.TypeA.md" + }, + { + "title": "TypeB", + "kind": 2097152, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-2.TypeAlias.TypeB.md" + } + ] + } + ] + }, + { + "title": "module-2", + "kind": 2, + "path": "module-2.md", + "children": [ + { + "title": "Enumerations", + "children": [ + { + "title": "EnumA", + "kind": 8, + "path": "module-2.Enumeration.EnumA.md" + }, + { + "title": "EnumB", + "kind": 8, + "path": "module-2.Enumeration.EnumB.md" + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "module-2.Class.ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "module-2.Class.ClassB.md" + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "InterfaceA", + "kind": 256, + "path": "module-2.Interface.InterfaceA.md" + }, + { + "title": "InterfaceB", + "kind": 256, + "path": "module-2.Interface.InterfaceB.md" + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "TypeA", + "kind": 2097152, + "path": "module-2.TypeAlias.TypeA.md" + }, + { + "title": "TypeB", + "kind": 2097152, + "path": "module-2.TypeAlias.TypeB.md" + } + ] + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/README.md new file mode 100644 index 000000000..8bc10a451 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/README.md @@ -0,0 +1,9 @@ +# MY README + +> Some block quote + +Some text. + +## Readme heading + +Some text. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/Test_Module_Name.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/Test_Module_Name.md new file mode 100644 index 000000000..818032a34 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/Test_Module_Name.md @@ -0,0 +1,5 @@ +# "/Test/Module/Name" + +## Interfaces + +### InterfaceA diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-1/submodules/submodule-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-1/submodules/submodule-1.md new file mode 100644 index 000000000..b01da6178 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-1/submodules/submodule-1.md @@ -0,0 +1,67 @@ +# module-1/submodules/submodule-1 + +## Enumerations + +### EnumA + +*** + +### EnumB + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](submodule-1.md#classa) + +###### Returns + +[`ClassA`](submodule-1.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](submodule-1.md#classb) + +###### Returns + +[`ClassB`](submodule-1.md#classb) + +## Interfaces + +### InterfaceA + +#### Properties + +##### propA + +> **propA**: `string` + +##### propB + +> **propB**: `string` + +*** + +### InterfaceB + +## Type Aliases + +### TypeA + +> **TypeA**: `string` + +*** + +### TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-1/submodules/submodule-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-1/submodules/submodule-2.md new file mode 100644 index 000000000..84ed67f77 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-1/submodules/submodule-2.md @@ -0,0 +1,67 @@ +# module-1/submodules/submodule-2 + +## Enumerations + +### EnumA + +*** + +### EnumB + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](submodule-2.md#classa) + +###### Returns + +[`ClassA`](submodule-2.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](submodule-2.md#classb) + +###### Returns + +[`ClassB`](submodule-2.md#classb) + +## Interfaces + +### InterfaceA + +#### Properties + +##### propA + +> **propA**: `string` + +##### propB + +> **propB**: `string` + +*** + +### InterfaceB + +## Type Aliases + +### TypeA + +> **TypeA**: `string` + +*** + +### TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1.md new file mode 100644 index 000000000..a116994e1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-1.md @@ -0,0 +1,67 @@ +# module-1/submodules/submodule-3-with-modules/nested-submodule-1 + +## Enumerations + +### EnumA + +*** + +### EnumB + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](nested-submodule-1.md#classa) + +###### Returns + +[`ClassA`](nested-submodule-1.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](nested-submodule-1.md#classb) + +###### Returns + +[`ClassB`](nested-submodule-1.md#classb) + +## Interfaces + +### InterfaceA + +#### Properties + +##### propA + +> **propA**: `string` + +##### propB + +> **propB**: `string` + +*** + +### InterfaceB + +## Type Aliases + +### TypeA + +> **TypeA**: `string` + +*** + +### TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2.md new file mode 100644 index 000000000..f513f1951 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-1/submodules/submodule-3-with-modules/nested-submodule-2.md @@ -0,0 +1,67 @@ +# module-1/submodules/submodule-3-with-modules/nested-submodule-2 + +## Enumerations + +### EnumA + +*** + +### EnumB + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](nested-submodule-2.md#classa) + +###### Returns + +[`ClassA`](nested-submodule-2.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](nested-submodule-2.md#classb) + +###### Returns + +[`ClassB`](nested-submodule-2.md#classb) + +## Interfaces + +### InterfaceA + +#### Properties + +##### propA + +> **propA**: `string` + +##### propB + +> **propB**: `string` + +*** + +### InterfaceB + +## Type Aliases + +### TypeA + +> **TypeA**: `string` + +*** + +### TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-2.md new file mode 100644 index 000000000..d13634485 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/module-2.md @@ -0,0 +1,67 @@ +# module-2 + +## Enumerations + +### EnumA + +*** + +### EnumB + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](module-2.md#classa) + +###### Returns + +[`ClassA`](module-2.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](module-2.md#classb) + +###### Returns + +[`ClassB`](module-2.md#classb) + +## Interfaces + +### InterfaceA + +#### Properties + +##### propA + +> **propA**: `string` + +##### propB + +> **propB**: `string` + +*** + +### InterfaceB + +## Type Aliases + +### TypeA + +> **TypeA**: `string` + +*** + +### TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/modules.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/modules.md new file mode 100644 index 000000000..25e194bc5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/modules.md @@ -0,0 +1,11 @@ +# typedoc-stubs + +## Modules + +- ["/Test/Module/Name"](Test_Module_Name.md) +- [@scope/namespace](namespace.md) +- [module-1/submodules/submodule-1](module-1/submodules/submodule-1.md) +- [module-1/submodules/submodule-2](module-1/submodules/submodule-2.md) +- [module-1/submodules/submodule-3-with-modules/nested-submodule-1](module-1/submodules/submodule-3-with-modules/nested-submodule-1.md) +- [module-1/submodules/submodule-3-with-modules/nested-submodule-2](module-1/submodules/submodule-3-with-modules/nested-submodule-2.md) +- [module-2](module-2.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/namespace.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/namespace.md new file mode 100644 index 000000000..9ecc97cdd --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/namespace.md @@ -0,0 +1,67 @@ +# @scope/namespace + +## Enumerations + +### EnumA + +*** + +### EnumB + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](namespace.md#classa) + +###### Returns + +[`ClassA`](namespace.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](namespace.md#classb) + +###### Returns + +[`ClassB`](namespace.md#classb) + +## Interfaces + +### InterfaceA + +#### Properties + +##### propA + +> **propA**: `string` + +##### propB + +> **propB**: `string` + +*** + +### InterfaceB + +## Type Aliases + +### TypeA + +> **TypeA**: `string` + +*** + +### TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/sidebar.json new file mode 100644 index 000000000..efb40a28f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-1/sidebar.json @@ -0,0 +1,52 @@ +[ + { + "title": "\"/Test/Module/Name\"", + "kind": 2, + "path": "Test_Module_Name.md" + }, + { + "title": "@scope/namespace", + "kind": 2, + "path": "namespace.md" + }, + { + "title": "module-1", + "children": [ + { + "title": "submodules", + "children": [ + { + "title": "submodule-1", + "kind": 2, + "path": "module-1/submodules/submodule-1.md" + }, + { + "title": "submodule-2", + "kind": 2, + "path": "module-1/submodules/submodule-2.md" + }, + { + "title": "submodule-3-with-modules", + "children": [ + { + "title": "nested-submodule-1", + "kind": 2, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-1.md" + }, + { + "title": "nested-submodule-2", + "kind": 2, + "path": "module-1/submodules/submodule-3-with-modules/nested-submodule-2.md" + } + ] + } + ] + } + ] + }, + { + "title": "module-2", + "kind": 2, + "path": "module-2.md" + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/@scope.namespace.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/@scope.namespace.md new file mode 100644 index 000000000..3ae7d5b75 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/@scope.namespace.md @@ -0,0 +1,67 @@ +# @scope/namespace + +## Enumerations + +### EnumA + +*** + +### EnumB + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](@scope.namespace.md#classa) + +###### Returns + +[`ClassA`](@scope.namespace.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](@scope.namespace.md#classb) + +###### Returns + +[`ClassB`](@scope.namespace.md#classb) + +## Interfaces + +### InterfaceA + +#### Properties + +##### propA + +> **propA**: `string` + +##### propB + +> **propB**: `string` + +*** + +### InterfaceB + +## Type Aliases + +### TypeA + +> **TypeA**: `string` + +*** + +### TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/README.md new file mode 100644 index 000000000..8bc10a451 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/README.md @@ -0,0 +1,9 @@ +# MY README + +> Some block quote + +Some text. + +## Readme heading + +Some text. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/Test.Module.Name.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/Test.Module.Name.md new file mode 100644 index 000000000..818032a34 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/Test.Module.Name.md @@ -0,0 +1,5 @@ +# "/Test/Module/Name" + +## Interfaces + +### InterfaceA diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/documentation.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/documentation.md new file mode 100644 index 000000000..02b252a27 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/documentation.md @@ -0,0 +1,11 @@ +# typedoc-stubs + +## Modules + +- ["/Test/Module/Name"](Test.Module.Name.md) +- [@scope/namespace](@scope.namespace.md) +- [module-1/submodules/submodule-1](module-1.submodules.submodule-1.md) +- [module-1/submodules/submodule-2](module-1.submodules.submodule-2.md) +- [module-1/submodules/submodule-3-with-modules/nested-submodule-1](module-1.submodules.submodule-3-with-modules.nested-submodule-1.md) +- [module-1/submodules/submodule-3-with-modules/nested-submodule-2](module-1.submodules.submodule-3-with-modules.nested-submodule-2.md) +- [module-2](module-2.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-1.submodules.submodule-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-1.submodules.submodule-1.md new file mode 100644 index 000000000..b6adf8a90 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-1.submodules.submodule-1.md @@ -0,0 +1,67 @@ +# module-1/submodules/submodule-1 + +## Enumerations + +### EnumA + +*** + +### EnumB + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](module-1.submodules.submodule-1.md#classa) + +###### Returns + +[`ClassA`](module-1.submodules.submodule-1.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](module-1.submodules.submodule-1.md#classb) + +###### Returns + +[`ClassB`](module-1.submodules.submodule-1.md#classb) + +## Interfaces + +### InterfaceA + +#### Properties + +##### propA + +> **propA**: `string` + +##### propB + +> **propB**: `string` + +*** + +### InterfaceB + +## Type Aliases + +### TypeA + +> **TypeA**: `string` + +*** + +### TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-1.submodules.submodule-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-1.submodules.submodule-2.md new file mode 100644 index 000000000..82e12d060 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-1.submodules.submodule-2.md @@ -0,0 +1,67 @@ +# module-1/submodules/submodule-2 + +## Enumerations + +### EnumA + +*** + +### EnumB + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](module-1.submodules.submodule-2.md#classa) + +###### Returns + +[`ClassA`](module-1.submodules.submodule-2.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](module-1.submodules.submodule-2.md#classb) + +###### Returns + +[`ClassB`](module-1.submodules.submodule-2.md#classb) + +## Interfaces + +### InterfaceA + +#### Properties + +##### propA + +> **propA**: `string` + +##### propB + +> **propB**: `string` + +*** + +### InterfaceB + +## Type Aliases + +### TypeA + +> **TypeA**: `string` + +*** + +### TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.md new file mode 100644 index 000000000..1df59cc8b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-1.md @@ -0,0 +1,67 @@ +# module-1/submodules/submodule-3-with-modules/nested-submodule-1 + +## Enumerations + +### EnumA + +*** + +### EnumB + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](module-1.submodules.submodule-3-with-modules.nested-submodule-1.md#classa) + +###### Returns + +[`ClassA`](module-1.submodules.submodule-3-with-modules.nested-submodule-1.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](module-1.submodules.submodule-3-with-modules.nested-submodule-1.md#classb) + +###### Returns + +[`ClassB`](module-1.submodules.submodule-3-with-modules.nested-submodule-1.md#classb) + +## Interfaces + +### InterfaceA + +#### Properties + +##### propA + +> **propA**: `string` + +##### propB + +> **propB**: `string` + +*** + +### InterfaceB + +## Type Aliases + +### TypeA + +> **TypeA**: `string` + +*** + +### TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.md new file mode 100644 index 000000000..dd829212c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-1.submodules.submodule-3-with-modules.nested-submodule-2.md @@ -0,0 +1,67 @@ +# module-1/submodules/submodule-3-with-modules/nested-submodule-2 + +## Enumerations + +### EnumA + +*** + +### EnumB + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](module-1.submodules.submodule-3-with-modules.nested-submodule-2.md#classa) + +###### Returns + +[`ClassA`](module-1.submodules.submodule-3-with-modules.nested-submodule-2.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](module-1.submodules.submodule-3-with-modules.nested-submodule-2.md#classb) + +###### Returns + +[`ClassB`](module-1.submodules.submodule-3-with-modules.nested-submodule-2.md#classb) + +## Interfaces + +### InterfaceA + +#### Properties + +##### propA + +> **propA**: `string` + +##### propB + +> **propB**: `string` + +*** + +### InterfaceB + +## Type Aliases + +### TypeA + +> **TypeA**: `string` + +*** + +### TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-2.md new file mode 100644 index 000000000..d13634485 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/module-2.md @@ -0,0 +1,67 @@ +# module-2 + +## Enumerations + +### EnumA + +*** + +### EnumB + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](module-2.md#classa) + +###### Returns + +[`ClassA`](module-2.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](module-2.md#classb) + +###### Returns + +[`ClassB`](module-2.md#classb) + +## Interfaces + +### InterfaceA + +#### Properties + +##### propA + +> **propA**: `string` + +##### propB + +> **propB**: `string` + +*** + +### InterfaceB + +## Type Aliases + +### TypeA + +> **TypeA**: `string` + +*** + +### TypeB + +> **TypeB**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/sidebar.json new file mode 100644 index 000000000..c18a0a0e3 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/modules/modules/opts-2/sidebar.json @@ -0,0 +1,37 @@ +[ + { + "title": "\"/Test/Module/Name\"", + "kind": 2, + "path": "Test.Module.Name.md" + }, + { + "title": "@scope/namespace", + "kind": 2, + "path": "@scope.namespace.md" + }, + { + "title": "module-1/submodules/submodule-1", + "kind": 2, + "path": "module-1.submodules.submodule-1.md" + }, + { + "title": "module-1/submodules/submodule-2", + "kind": 2, + "path": "module-1.submodules.submodule-2.md" + }, + { + "title": "module-1/submodules/submodule-3-with-modules/nested-submodule-1", + "kind": 2, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-1.md" + }, + { + "title": "module-1/submodules/submodule-3-with-modules/nested-submodule-2", + "kind": 2, + "path": "module-1.submodules.submodule-3-with-modules.nested-submodule-2.md" + }, + { + "title": "module-2", + "kind": 2, + "path": "module-2.md" + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module1/README.md new file mode 100644 index 000000000..80ee43027 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module1/README.md @@ -0,0 +1,16 @@ +[typedoc-stubs](../README.md) / Module1 + +# Module1 + +## Index + +### Interfaces + +#### Category 1 + +- [SomeInterface1](interfaces/SomeInterface1.md) +- [SomeInterface2](interfaces/SomeInterface2.md) + +#### Category 2 + +- [SomeInterface3](interfaces/SomeInterface3.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module1/interfaces/SomeInterface1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module1/interfaces/SomeInterface1.md new file mode 100644 index 000000000..74239d11d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module1/interfaces/SomeInterface1.md @@ -0,0 +1,3 @@ +[typedoc-stubs](../../README.md) / [Module1](../README.md) / SomeInterface1 + +# Interface: SomeInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module1/interfaces/SomeInterface2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module1/interfaces/SomeInterface2.md new file mode 100644 index 000000000..eab077f90 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module1/interfaces/SomeInterface2.md @@ -0,0 +1,3 @@ +[typedoc-stubs](../../README.md) / [Module1](../README.md) / SomeInterface2 + +# Interface: SomeInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module1/interfaces/SomeInterface3.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module1/interfaces/SomeInterface3.md new file mode 100644 index 000000000..78f9affb5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module1/interfaces/SomeInterface3.md @@ -0,0 +1,3 @@ +[typedoc-stubs](../../README.md) / [Module1](../README.md) / SomeInterface3 + +# Interface: SomeInterface3 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module2/README.md new file mode 100644 index 000000000..6bc9c2b65 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module2/README.md @@ -0,0 +1,9 @@ +[typedoc-stubs](../README.md) / Module2 + +# Module2 + +## Index + +### Interfaces + +- [SomeInterface](interfaces/SomeInterface.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module2/interfaces/SomeInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module2/interfaces/SomeInterface.md new file mode 100644 index 000000000..c15954c1a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/Module2/interfaces/SomeInterface.md @@ -0,0 +1,3 @@ +[typedoc-stubs](../../README.md) / [Module2](../README.md) / SomeInterface + +# Interface: SomeInterface diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/README.md new file mode 100644 index 000000000..d8466bd40 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/README.md @@ -0,0 +1,9 @@ +# typedoc-stubs + +## Group 1 + +- [Module1](Module1/README.md) + +## Group 2 + +- [Module2](Module2/README.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/sidebar.json new file mode 100644 index 000000000..0530108e2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-1/sidebar.json @@ -0,0 +1,36 @@ +[ + { + "title": "Module1", + "kind": 2, + "path": "Module1/README.md", + "children": [ + { + "title": "SomeInterface1", + "kind": 256, + "path": "Module1/interfaces/SomeInterface1.md" + }, + { + "title": "SomeInterface2", + "kind": 256, + "path": "Module1/interfaces/SomeInterface2.md" + }, + { + "title": "SomeInterface3", + "kind": 256, + "path": "Module1/interfaces/SomeInterface3.md" + } + ] + }, + { + "title": "Module2", + "kind": 2, + "path": "Module2/README.md", + "children": [ + { + "title": "SomeInterface", + "kind": 256, + "path": "Module2/interfaces/SomeInterface.md" + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module1/README.md new file mode 100644 index 000000000..a83a3f6ce --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module1/README.md @@ -0,0 +1,14 @@ +[typedoc-stubs](../README.md) / Module1 + +# Module1 + +## Index + +### Category 1 + +- [SomeInterface1](interfaces/SomeInterface1.md) +- [SomeInterface2](interfaces/SomeInterface2.md) + +### Category 2 + +- [SomeInterface3](interfaces/SomeInterface3.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module1/interfaces/SomeInterface1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module1/interfaces/SomeInterface1.md new file mode 100644 index 000000000..74239d11d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module1/interfaces/SomeInterface1.md @@ -0,0 +1,3 @@ +[typedoc-stubs](../../README.md) / [Module1](../README.md) / SomeInterface1 + +# Interface: SomeInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module1/interfaces/SomeInterface2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module1/interfaces/SomeInterface2.md new file mode 100644 index 000000000..eab077f90 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module1/interfaces/SomeInterface2.md @@ -0,0 +1,3 @@ +[typedoc-stubs](../../README.md) / [Module1](../README.md) / SomeInterface2 + +# Interface: SomeInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module1/interfaces/SomeInterface3.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module1/interfaces/SomeInterface3.md new file mode 100644 index 000000000..78f9affb5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module1/interfaces/SomeInterface3.md @@ -0,0 +1,3 @@ +[typedoc-stubs](../../README.md) / [Module1](../README.md) / SomeInterface3 + +# Interface: SomeInterface3 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module2/README.md new file mode 100644 index 000000000..6bc9c2b65 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module2/README.md @@ -0,0 +1,9 @@ +[typedoc-stubs](../README.md) / Module2 + +# Module2 + +## Index + +### Interfaces + +- [SomeInterface](interfaces/SomeInterface.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module2/interfaces/SomeInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module2/interfaces/SomeInterface.md new file mode 100644 index 000000000..c15954c1a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/Module2/interfaces/SomeInterface.md @@ -0,0 +1,3 @@ +[typedoc-stubs](../../README.md) / [Module2](../README.md) / SomeInterface + +# Interface: SomeInterface diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/README.md new file mode 100644 index 000000000..d8466bd40 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/README.md @@ -0,0 +1,9 @@ +# typedoc-stubs + +## Group 1 + +- [Module1](Module1/README.md) + +## Group 2 + +- [Module2](Module2/README.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/sidebar.json new file mode 100644 index 000000000..0e70f2fc1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/members/opts-2/sidebar.json @@ -0,0 +1,61 @@ +[ + { + "title": "Group 1", + "children": [ + { + "title": "Module1", + "kind": 2, + "path": "Module1/README.md", + "children": [ + { + "title": "Category 1", + "children": [ + { + "title": "SomeInterface1", + "kind": 256, + "path": "Module1/interfaces/SomeInterface1.md" + }, + { + "title": "SomeInterface2", + "kind": 256, + "path": "Module1/interfaces/SomeInterface2.md" + } + ] + }, + { + "title": "Category 2", + "children": [ + { + "title": "SomeInterface3", + "kind": 256, + "path": "Module1/interfaces/SomeInterface3.md" + } + ] + } + ] + } + ] + }, + { + "title": "Group 2", + "children": [ + { + "title": "Module2", + "kind": 2, + "path": "Module2/README.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "SomeInterface", + "kind": 256, + "path": "Module2/interfaces/SomeInterface.md" + } + ] + } + ] + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-1/Module1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-1/Module1.md new file mode 100644 index 000000000..628727baf --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-1/Module1.md @@ -0,0 +1,17 @@ +[typedoc-stubs](README.md) / Module1 + +# Module1 + +## Interfaces + +### Category 1 + +#### SomeInterface1 + +*** + +#### SomeInterface2 + +### Category 2 + +#### SomeInterface3 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-1/Module2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-1/Module2.md new file mode 100644 index 000000000..f3986df5f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-1/Module2.md @@ -0,0 +1,7 @@ +[typedoc-stubs](README.md) / Module2 + +# Module2 + +## Interfaces + +### SomeInterface diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-1/README.md new file mode 100644 index 000000000..bd20f9664 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-1/README.md @@ -0,0 +1,9 @@ +# typedoc-stubs + +## Group 1 + +- [Module1](Module1.md) + +## Group 2 + +- [Module2](Module2.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-1/sidebar.json new file mode 100644 index 000000000..79bcf9a0d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-1/sidebar.json @@ -0,0 +1,12 @@ +[ + { + "title": "Module1", + "kind": 2, + "path": "Module1.md" + }, + { + "title": "Module2", + "kind": 2, + "path": "Module2.md" + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-2/Module1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-2/Module1.md new file mode 100644 index 000000000..b05de1464 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-2/Module1.md @@ -0,0 +1,15 @@ +[typedoc-stubs](README.md) / Module1 + +# Module1 + +## Category 1 + +### SomeInterface1 + +*** + +### SomeInterface2 + +## Category 2 + +### SomeInterface3 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-2/Module2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-2/Module2.md new file mode 100644 index 000000000..f3986df5f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-2/Module2.md @@ -0,0 +1,7 @@ +[typedoc-stubs](README.md) / Module2 + +# Module2 + +## Interfaces + +### SomeInterface diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-2/README.md new file mode 100644 index 000000000..bd20f9664 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-2/README.md @@ -0,0 +1,9 @@ +# typedoc-stubs + +## Group 1 + +- [Module1](Module1.md) + +## Group 2 + +- [Module2](Module2.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-2/sidebar.json new file mode 100644 index 000000000..2dd2c19f5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/navigation/modules/opts-2/sidebar.json @@ -0,0 +1,22 @@ +[ + { + "title": "Group 1", + "children": [ + { + "title": "Module1", + "kind": 2, + "path": "Module1.md" + } + ] + }, + { + "title": "Group 2", + "children": [ + { + "title": "Module2", + "kind": 2, + "path": "Module2.md" + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/README.md new file mode 100644 index 000000000..8bc10a451 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/README.md @@ -0,0 +1,9 @@ +# MY README + +> Some block quote + +Some text. + +## Readme heading + +Some text. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/AbstractClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/AbstractClass.md new file mode 100644 index 000000000..442876175 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/AbstractClass.md @@ -0,0 +1,36 @@ +# Class: `abstract` AbstractClass + +## Extended by + +- [`DerivedClassA`](DerivedClassA.md) +- [`DerivedClassB`](DerivedClassB.md) + +## Constructors + +### new AbstractClass() + +> **new AbstractClass**(): [`AbstractClass`](AbstractClass.md) + +#### Returns + +[`AbstractClass`](AbstractClass.md) + +## Properties + +### abstractProp + +> `abstract` **abstractProp**: `string` + +Comments for abstractProp + +## Methods + +### abstractMethod() + +> `abstract` **abstractMethod**(): `string` + +Comments for abstractMethod + +#### Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/BaseClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/BaseClass.md new file mode 100644 index 000000000..83886bccf --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/BaseClass.md @@ -0,0 +1,16 @@ +# Class: BaseClass + +## Extended by + +- [`ChildClassA`](ChildClassA.md) +- [`ChildClassB`](ChildClassB.md) + +## Constructors + +### new BaseClass() + +> **new BaseClass**(): [`BaseClass`](BaseClass.md) + +#### Returns + +[`BaseClass`](BaseClass.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/BasicClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/BasicClass.md new file mode 100644 index 000000000..3b978db62 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/BasicClass.md @@ -0,0 +1,33 @@ +# Class: BasicClass + +Comments for BasicClass + +## Constructors + +### new BasicClass() + +> **new BasicClass**(): [`BasicClass`](BasicClass.md) + +#### Returns + +[`BasicClass`](BasicClass.md) + +## Properties + +### prop + +> **prop**: `string` + +Comments for prop + +## Methods + +### method() + +> **method**(): `string` + +Comments for method + +#### Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/CallbacksOptions.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/CallbacksOptions.md new file mode 100644 index 000000000..7d06c159b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/CallbacksOptions.md @@ -0,0 +1,21 @@ +# Class: CallbacksOptions\ + +## Type Parameters + +### P + +Default type [`DisposableClass`](DisposableClass.md) + +### A + +Default type [`ClassWithModifiers`](ClassWithModifiers.md) + +## Constructors + +### new CallbacksOptions() + +> **new CallbacksOptions**\<`P`, `A`\>(): [`CallbacksOptions`](CallbacksOptions.md)\<`P`, `A`\> + +#### Returns + +[`CallbacksOptions`](CallbacksOptions.md)\<`P`, `A`\> diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ChildClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ChildClassA.md new file mode 100644 index 000000000..dd0691b76 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ChildClassA.md @@ -0,0 +1,24 @@ +# Class: ChildClassA + +## Extends + +- [`BaseClass`](BaseClass.md) + +## Extended by + +- [`GrandChildClassA`](GrandChildClassA.md) +- [`GrandChildClassB`](GrandChildClassB.md) + +## Constructors + +### new ChildClassA() + +> **new ChildClassA**(): [`ChildClassA`](ChildClassA.md) + +#### Returns + +[`ChildClassA`](ChildClassA.md) + +#### Inherited from + +[`BaseClass`](BaseClass.md).[`constructor`](BaseClass.md#constructors) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ChildClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ChildClassB.md new file mode 100644 index 000000000..df562ed1f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ChildClassB.md @@ -0,0 +1,19 @@ +# Class: ChildClassB + +## Extends + +- [`BaseClass`](BaseClass.md) + +## Constructors + +### new ChildClassB() + +> **new ChildClassB**(): [`ChildClassB`](ChildClassB.md) + +#### Returns + +[`ChildClassB`](ChildClassB.md) + +#### Inherited from + +[`BaseClass`](BaseClass.md).[`constructor`](BaseClass.md#constructors) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithAccessorKeywords.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithAccessorKeywords.md new file mode 100644 index 000000000..6d80006b2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithAccessorKeywords.md @@ -0,0 +1,39 @@ +# Class: ClassWithAccessorKeywords + +## Constructors + +### new ClassWithAccessorKeywords() + +> **new ClassWithAccessorKeywords**(): [`ClassWithAccessorKeywords`](ClassWithAccessorKeywords.md) + +#### Returns + +[`ClassWithAccessorKeywords`](ClassWithAccessorKeywords.md) + +## Accessors + +### accessor1 + +Accessor comments + +#### Example + +```ts +const x = 1; +``` + +*** + +### accessor2 + +Accessor comments + +#### Remarks + +Remark comments + +*** + +### accessor3 + +Accessor comments diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithAccessors.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithAccessors.md new file mode 100644 index 000000000..8c721b27e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithAccessors.md @@ -0,0 +1,75 @@ +# Class: ClassWithAccessors + +Comments for ClassWithAccessors + +## Constructors + +### new ClassWithAccessors() + +> **new ClassWithAccessors**(): [`ClassWithAccessors`](ClassWithAccessors.md) + +#### Returns + +[`ClassWithAccessors`](ClassWithAccessors.md) + +## Accessors + +### accessor + +#### Get Signature + +> **get** **accessor**(): `string` + +Comments for getter + +##### Returns + +`string` + +#### Set Signature + +> **set** **accessor**(`value`: `string`): `void` + +Comments for setter + +##### Parameters + +###### value + +`string` + +Param comments + +##### Returns + +`void` + +*** + +### noGetter + +#### Set Signature + +> **set** **noGetter**(`x`: `string`): `void` + +##### Parameters + +###### x + +`string` + +##### Returns + +`void` + +*** + +### noSetter + +#### Get Signature + +> **get** **noSetter**(): `string` + +##### Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithComplexProps.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithComplexProps.md new file mode 100644 index 000000000..b5a88995d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithComplexProps.md @@ -0,0 +1,41 @@ +# Class: ClassWithComplexProps + +Comments for ClassWithComplexProps + +## Constructors + +### new ClassWithComplexProps() + +> **new ClassWithComplexProps**(): [`ClassWithComplexProps`](ClassWithComplexProps.md) + +#### Returns + +[`ClassWithComplexProps`](ClassWithComplexProps.md) + +## Properties + +### objecLiteralProp + +> **objecLiteralProp**: \{`someFunction`: (`a`: `string`) => `string`;`someProp`: `string`; \} + +#### someFunction() + +> **someFunction**: (`a`: `string`) => `string` + +Comments for someFunction + +##### Parameters + +###### a + +`string` + +##### Returns + +`string` + +#### someProp + +> **someProp**: `string` = `'someProp'` + +Comments for someProp diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithConstructorOverloads.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithConstructorOverloads.md new file mode 100644 index 000000000..c17b121b1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithConstructorOverloads.md @@ -0,0 +1,55 @@ +# Class: ClassWithConstructorOverloads + +Comments for ClassWithConstructorOverloads + +## Constructors + +### new ClassWithConstructorOverloads() + +> **new ClassWithConstructorOverloads**(`x`: `number`, `y`: `string`): [`ClassWithConstructorOverloads`](ClassWithConstructorOverloads.md) + +#### Parameters + +##### x + +`number` + +Comments for x number + +##### y + +`string` + +#### Returns + +[`ClassWithConstructorOverloads`](ClassWithConstructorOverloads.md) + +### new ClassWithConstructorOverloads() + +> **new ClassWithConstructorOverloads**(`x`: `string`): [`ClassWithConstructorOverloads`](ClassWithConstructorOverloads.md) + +#### Parameters + +##### x + +`string` + +Comments for x string + +#### Returns + +[`ClassWithConstructorOverloads`](ClassWithConstructorOverloads.md) + +### new ClassWithConstructorOverloads() + +> **new ClassWithConstructorOverloads**(`s`: `string`): [`ClassWithConstructorOverloads`](ClassWithConstructorOverloads.md) + +#### Parameters + +##### s + +`string` + +#### Returns + +[`ClassWithConstructorOverloads`](ClassWithConstructorOverloads.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithFlags.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithFlags.md new file mode 100644 index 000000000..127e5cb3c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithFlags.md @@ -0,0 +1,45 @@ +# Class: ClassWithFlags + +Comment for ClassWithFlags + +## Constructors + +### new ClassWithFlags() + +> **new ClassWithFlags**(): [`ClassWithFlags`](ClassWithFlags.md) + +#### Returns + +[`ClassWithFlags`](ClassWithFlags.md) + +## Properties + +### expermintalProp + +> **expermintalProp**: `string` + +**`Experimental`** + +## Methods + +### expermintalMethod() + +> **expermintalMethod**(): `void` + +**`Experimental`** + +#### Returns + +`void` + +*** + +### internalMethod() + +> `protected` **internalMethod**(): `void` + +**`Internal`** + +#### Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithModifiers.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithModifiers.md new file mode 100644 index 000000000..7cb0ceff4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithModifiers.md @@ -0,0 +1,69 @@ +# Class: `abstract` ClassWithModifiers + +Comments for ClassWithModifiers + +## Constructors + +### new ClassWithModifiers() + +> **new ClassWithModifiers**(): [`ClassWithModifiers`](ClassWithModifiers.md) + +#### Returns + +[`ClassWithModifiers`](ClassWithModifiers.md) + +## Properties + +### protectedProp + +> `protected` **protectedProp**: `string` + +Comments for protectedProp + +*** + +### publicPropWithDefault + +> **publicPropWithDefault**: `string` = `'propWithDefault'` + +Comments for propWithDefault + +*** + +### readonlyProp + +> `readonly` **readonlyProp**: `string` + +Comments for abstractProperty + +*** + +### staticProp + +> `static` **staticProp**: `string` + +Comments for staticProp + +## Methods + +### publicMethod() + +> **publicMethod**(): `void` + +Comment for publicMethod + +#### Returns + +`void` + +*** + +### staticMethod() + +> `static` **staticMethod**(): `void` + +Comment for staticMethod + +#### Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithPropCategories.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithPropCategories.md new file mode 100644 index 000000000..9f589a638 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithPropCategories.md @@ -0,0 +1,55 @@ +# Class: ClassWithPropCategories + +## Constructors + +### new ClassWithPropCategories() + +> **new ClassWithPropCategories**(`opts`: \{`a`: `string`;`b`: `string`; \}): [`ClassWithPropCategories`](ClassWithPropCategories.md) + +#### Parameters + +##### opts + +###### opts.a + +`string` + +###### opts.b + +`string` + +#### Returns + +[`ClassWithPropCategories`](ClassWithPropCategories.md) + +## CatA + +### prop1 + +> **prop1**: `string` + +## CatB + +### prop2 + +> **prop2**: `string` + +## Other + +### method1() + +> **method1**(): `void` + +#### Returns + +`void` + +*** + +### method2() + +> **method2**(): `void` + +#### Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithSimpleProps.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithSimpleProps.md new file mode 100644 index 000000000..9df1acdcc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithSimpleProps.md @@ -0,0 +1,58 @@ +# Class: ClassWithSimpleProps + +Comments for ClassWithSimpleProps + +## Constructors + +### new ClassWithSimpleProps() + +> **new ClassWithSimpleProps**(): [`ClassWithSimpleProps`](ClassWithSimpleProps.md) + +#### Returns + +[`ClassWithSimpleProps`](ClassWithSimpleProps.md) + +## Properties + +### propA + +> **propA**: `string` = `'propAValue'` + +Comments for propA + +*** + +### propB + +> **propB**: `string` = `'propBValue'` + +Comments for propB + +#### Default Value + +```ts +'propBDefaultValue' +``` + +*** + +### propC + +> **propC**: `string` + +Comments for propB +on two lines + +#### Default Value + +```ts +'propCDefaultValue' +``` + +*** + +### propD + +> **propD**: `string` + +Comments for propE diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithSymbols.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithSymbols.md new file mode 100644 index 000000000..cc537ed1d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithSymbols.md @@ -0,0 +1,31 @@ +# Class: ClassWithSymbols + +## Constructors + +### new ClassWithSymbols() + +> **new ClassWithSymbols**(): [`ClassWithSymbols`](ClassWithSymbols.md) + +#### Returns + +[`ClassWithSymbols`](ClassWithSymbols.md) + +## Properties + +### \[symbolConst\]()? + +> `static` `optional` **\[symbolConst\]**: () => `void` + +#### Returns + +`void` + +## Methods + +### \[dispose\]() + +> **\[dispose\]**(): `void` + +#### Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithTypeParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithTypeParameters.md new file mode 100644 index 000000000..8bdb78021 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithTypeParameters.md @@ -0,0 +1,31 @@ +# Class: ClassWithTypeParameters\ + +Comments for ClassWithTypeParameters + +## Type Parameters + +### A + +\- + +### B + +*extends*: `string` + +Comments for param B + +### C + +Default type `boolean` + +Comments for param C + +## Constructors + +### new ClassWithTypeParameters() + +> **new ClassWithTypeParameters**\<`A`, `B`, `C`\>(): [`ClassWithTypeParameters`](ClassWithTypeParameters.md)\<`A`, `B`, `C`\> + +#### Returns + +[`ClassWithTypeParameters`](ClassWithTypeParameters.md)\<`A`, `B`, `C`\> diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithoutPropCategories.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithoutPropCategories.md new file mode 100644 index 000000000..30d104c41 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/ClassWithoutPropCategories.md @@ -0,0 +1,55 @@ +# Class: ClassWithoutPropCategories + +## Constructors + +### new ClassWithoutPropCategories() + +> **new ClassWithoutPropCategories**(`opts`: \{`a`: `string`;`b`: `string`; \}): [`ClassWithoutPropCategories`](ClassWithoutPropCategories.md) + +#### Parameters + +##### opts + +###### opts.a + +`string` + +###### opts.b + +`string` + +#### Returns + +[`ClassWithoutPropCategories`](ClassWithoutPropCategories.md) + +## Properties + +### prop1 + +> **prop1**: `string` + +*** + +### prop2 + +> **prop2**: `string` + +## Methods + +### method1() + +> **method1**(): `void` + +#### Returns + +`void` + +*** + +### method2() + +> **method2**(): `void` + +#### Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/DerivedClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/DerivedClassA.md new file mode 100644 index 000000000..fca00296c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/DerivedClassA.md @@ -0,0 +1,65 @@ +# Class: DerivedClassA + +Comments for DerivedClassA + +## Extends + +- [`AbstractClass`](AbstractClass.md) + +## Constructors + +### new DerivedClassA() + +> **new DerivedClassA**(): [`DerivedClassA`](DerivedClassA.md) + +#### Returns + +[`DerivedClassA`](DerivedClassA.md) + +#### Inherited from + +[`AbstractClass`](AbstractClass.md).[`constructor`](AbstractClass.md#constructors) + +## Properties + +### abstractProp + +> **abstractProp**: `string` = `'abstractProp'` + +Comments for abstractProp + +#### Overrides + +[`AbstractClass`](AbstractClass.md).[`abstractProp`](AbstractClass.md#abstractprop) + +*** + +### derivedProp + +> **derivedProp**: `string` + +## Methods + +### abstractMethod() + +> **abstractMethod**(): `string` + +Comments for abstractMethod + +#### Returns + +`string` + +#### Overrides + +[`AbstractClass`](AbstractClass.md).[`abstractMethod`](AbstractClass.md#abstractmethod) + +*** + +### derivedMethod() + +> **derivedMethod**(): `string` + +#### Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/DerivedClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/DerivedClassB.md new file mode 100644 index 000000000..bcb5b5340 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/DerivedClassB.md @@ -0,0 +1,49 @@ +# Class: DerivedClassB + +Comments for DerivedClassB + +## Extends + +- [`AbstractClass`](AbstractClass.md) + +## Constructors + +### new DerivedClassB() + +> **new DerivedClassB**(): [`DerivedClassB`](DerivedClassB.md) + +#### Returns + +[`DerivedClassB`](DerivedClassB.md) + +#### Inherited from + +[`AbstractClass`](AbstractClass.md).[`constructor`](AbstractClass.md#constructors) + +## Properties + +### abstractProp + +> **abstractProp**: `string` = `'abstractProp'` + +Comments for abstractProp + +#### Overrides + +[`AbstractClass`](AbstractClass.md).[`abstractProp`](AbstractClass.md#abstractprop) + +## Methods + +### abstractMethod() + +> **abstractMethod**(): `string` + +Comments for abstractMethod + +#### Returns + +`string` + +#### Overrides + +[`AbstractClass`](AbstractClass.md).[`abstractMethod`](AbstractClass.md#abstractmethod) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/DisposableClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/DisposableClass.md new file mode 100644 index 000000000..88ccd2ef3 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/DisposableClass.md @@ -0,0 +1,29 @@ +# Class: DisposableClass + +## Implements + +- `Disposable` + +## Constructors + +### new DisposableClass() + +> **new DisposableClass**(): [`DisposableClass`](DisposableClass.md) + +#### Returns + +[`DisposableClass`](DisposableClass.md) + +## Methods + +### \[dispose\]() + +> **\[dispose\]**(): `void` + +#### Returns + +`void` + +#### Implementation of + +`Disposable.[dispose]` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/GrandChildClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/GrandChildClassA.md new file mode 100644 index 000000000..396946600 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/GrandChildClassA.md @@ -0,0 +1,19 @@ +# Class: GrandChildClassA + +## Extends + +- [`ChildClassA`](ChildClassA.md) + +## Constructors + +### new GrandChildClassA() + +> **new GrandChildClassA**(): [`GrandChildClassA`](GrandChildClassA.md) + +#### Returns + +[`GrandChildClassA`](GrandChildClassA.md) + +#### Inherited from + +[`ChildClassA`](ChildClassA.md).[`constructor`](ChildClassA.md#constructors) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/GrandChildClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/GrandChildClassB.md new file mode 100644 index 000000000..0090154b1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/classes/GrandChildClassB.md @@ -0,0 +1,19 @@ +# Class: GrandChildClassB + +## Extends + +- [`ChildClassA`](ChildClassA.md) + +## Constructors + +### new GrandChildClassB() + +> **new GrandChildClassB**(): [`GrandChildClassB`](GrandChildClassB.md) + +#### Returns + +[`GrandChildClassB`](GrandChildClassB.md) + +#### Inherited from + +[`ChildClassA`](ChildClassA.md).[`constructor`](ChildClassA.md#constructors) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/enumerations/BasicEnum.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/enumerations/BasicEnum.md new file mode 100644 index 000000000..c807da817 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/enumerations/BasicEnum.md @@ -0,0 +1,19 @@ +# Enumeration: BasicEnum + +Comments for enum + +## Enumeration Members + +### MemberA + +> **MemberA**: `0` + +Comments for MemberA + +*** + +### MemberB + +> **MemberB**: `1` + +Comments for MemberB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/enumerations/EnumWithValues.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/enumerations/EnumWithValues.md new file mode 100644 index 000000000..94d005684 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/enumerations/EnumWithValues.md @@ -0,0 +1,15 @@ +# Enumeration: EnumWithValues + +Comments for enum + +## Enumeration Members + +### MemberA + +> **MemberA**: `"UP"` + +*** + +### MemberB + +> **MemberB**: `"DOWN"` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/basicFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/basicFunction.md new file mode 100644 index 000000000..f5a4b2305 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/basicFunction.md @@ -0,0 +1,21 @@ +# Function: basicFunction() + +> **basicFunction**(`someParam`: `number`): `number` + +This is a function that is assigned to a variable. + +## See + +http://abc.com + +## Parameters + +### someParam + +`number` + +This is some numeric parameter. + +## Returns + +`number` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/basicFunctionWithReturns.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/basicFunctionWithReturns.md new file mode 100644 index 000000000..1ef707916 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/basicFunctionWithReturns.md @@ -0,0 +1,11 @@ +# Function: basicFunctionWithReturns() + +> **basicFunctionWithReturns**(): `number` + +This is a function that is assigned to a variable. + +## Returns + +`number` + +This is a return value diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/curriedFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/curriedFunction.md new file mode 100644 index 000000000..3bfb80dac --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/curriedFunction.md @@ -0,0 +1,61 @@ +# Function: curriedFunction() + +Comments for main curriedFunction + +## Call Signature + +> **curriedFunction**(`searchElement`: `unknown`): \<`Value`\>(`iterable`: `Iterable`\<`Value`, `any`, `any`\>) => `boolean` + +Comments for current function 1 + +### Parameters + +#### searchElement + +`unknown` + +### Returns + +`Function` + +#### Type Parameters + +##### Value + +\- + +#### Parameters + +##### iterable + +`Iterable`\<`Value`, `any`, `any`\> + +Comments for iterable arg + +#### Returns + +`boolean` + +## Call Signature + +> **curriedFunction**\<`Value`\>(`searchElement`: `unknown`, `iterable`: `Iterable`\<`Value`, `any`, `any`\>): `string` + +### Type Parameters + +#### Value + +\- + +### Parameters + +#### searchElement + +`unknown` + +#### iterable + +`Iterable`\<`Value`, `any`, `any`\> + +### Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAFunction.md new file mode 100644 index 000000000..b36a8790f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAFunction.md @@ -0,0 +1,25 @@ +# Function: functionReturningAFunction() + +> **functionReturningAFunction**(): \<`T`\>(`x`: `string`) => `boolean` + +Comments for function + +## Returns + +`Function` + +### Type Parameters + +#### T + +\- + +### Parameters + +#### x + +`string` + +### Returns + +`boolean` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAPromise.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAPromise.md new file mode 100644 index 000000000..e44ad494c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAPromise.md @@ -0,0 +1,15 @@ +# Function: functionReturningAPromise() + +> **functionReturningAPromise**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<\{`prop`: `string`; \}\> + +Comments for function + +## Returns + +[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<\{`prop`: `string`; \}\> + +Return comments + +### prop + +> **prop**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAString.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAString.md new file mode 100644 index 000000000..18f119271 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAString.md @@ -0,0 +1,11 @@ +# Function: functionReturningAString() + +> **functionReturningAString**(): `string` + +Comments for function + +## Returns + +`string` + +Return comments diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAUnionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAUnionType.md new file mode 100644 index 000000000..2060cf626 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAUnionType.md @@ -0,0 +1,11 @@ +# Function: functionReturningAUnionType() + +> **functionReturningAUnionType**(): `string` \| `boolean` \| `"string1"` \| `"string2"` + +Comments for function + +## Returns + +`string` \| `boolean` \| `"string1"` \| `"string2"` + +Return comments diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAnObject.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAnObject.md new file mode 100644 index 000000000..3a50a638c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionReturningAnObject.md @@ -0,0 +1,19 @@ +# Function: functionReturningAnObject() + +> **functionReturningAnObject**(): \{`x`: `number`;`y`: `number`; \} + +Comments for function + +## Returns + +\{`x`: `number`;`y`: `number`; \} + +Return comments + +### x + +> **x**: `number` = `1` + +### y + +> **y**: `number` = `2` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithArrayOfOptionalStuff.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithArrayOfOptionalStuff.md new file mode 100644 index 000000000..61e052d2e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithArrayOfOptionalStuff.md @@ -0,0 +1,15 @@ +# Function: functionWithArrayOfOptionalStuff() + +> **functionWithArrayOfOptionalStuff**(`a`: [[`Stuff`](../type-aliases/Stuff.md)?]): `void` + +Comments for array of stuff? + +## Parameters + +### a + +[[`Stuff`](../type-aliases/Stuff.md)?] + +## Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithArrayOfStuff.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithArrayOfStuff.md new file mode 100644 index 000000000..a6b1f0ab9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithArrayOfStuff.md @@ -0,0 +1,15 @@ +# Function: functionWithArrayOfStuff() + +> **functionWithArrayOfStuff**(`a`: [[`Stuff`](../type-aliases/Stuff.md)]): `void` + +Comments for array of stuff + +## Parameters + +### a + +[[`Stuff`](../type-aliases/Stuff.md)] + +## Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithComplexParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithComplexParams.md new file mode 100644 index 000000000..e5e6f6a26 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithComplexParams.md @@ -0,0 +1,21 @@ +# Function: functionWithComplexParams() + +> **functionWithComplexParams**(`paramA`: (`a`: `string`) => `true`, `paramB`: \{`x`: `1`; \}): `boolean` + +Function with function parmas + +## Parameters + +### paramA + +(`a`: `string`) => `true` + +### paramB + +#### paramB.x + +`1` + +## Returns + +`boolean` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithDefaultParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithDefaultParameters.md new file mode 100644 index 000000000..9cfc22c2e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithDefaultParameters.md @@ -0,0 +1,45 @@ +# Function: functionWithDefaultParameters() + +> **functionWithDefaultParameters**(`valueA`: `string`, `valueB`: `number`, `valueC`: `number`, `valueD`: `boolean`, `valueE`: `boolean`, `valueF`: `string`): `string` + +This is a function with a parameter that has a default value. + +## Parameters + +### valueA + +`string` = `'defaultValue'` + +A parameter with a default string value. + +### valueB + +`number` = `100` + +A parameter with a default numeric value. + +### valueC + +`number` = `Number.NaN` + +A parameter with a default NaN value. + +### valueD + +`boolean` = `true` + +A parameter with a default boolean value. + +### valueE + +`boolean` = `true` + +A parameter with a default null value. + +### valueF + +`string` = `''` + +## Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithMultipleSignatures.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithMultipleSignatures.md new file mode 100644 index 000000000..1cabab08a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithMultipleSignatures.md @@ -0,0 +1,43 @@ +# Function: functionWithMultipleSignatures() + +Main function comment. + +## Call Signature + +> **functionWithMultipleSignatures**(`value`: `string`): `string` + +This is the first signature of a function with multiple signatures. + +### Parameters + +#### value + +`string` + +The name value. + +### Returns + +`string` + +## Call Signature + +> **functionWithMultipleSignatures**(`value`: \{`name`: `string`; \}): `string` + +This is the second signature of a function with multiple signatures. + +### Parameters + +#### value + +An object containing the name value. + +##### value.name + +`string` + +A value of the object. + +### Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithNamedParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithNamedParams.md new file mode 100644 index 000000000..fecb339ad --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithNamedParams.md @@ -0,0 +1,27 @@ +# Function: functionWithNamedParams() + +> **functionWithNamedParams**(`__namedParameters`: \{`bar`: `number`;`foo`: `number`; \}, `anotherParam`: `string`): `void` + +## Parameters + +### \_\_namedParameters + +various options + +#### __namedParameters.bar + +`number` = `43` + +#### __namedParameters.foo + +`number` = `42` + +### anotherParam + +`string` + +Another param comment + +## Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithNestedParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithNestedParameters.md new file mode 100644 index 000000000..e47a9ee0e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithNestedParameters.md @@ -0,0 +1,57 @@ +# Function: functionWithNestedParameters() + +> **functionWithNestedParameters**(`params`: \{`name`: `string`;`nestedObj`: \{`name`: `string`;`obj`: \{`name`: () => `void`; \};`value`: `number`; \};`parent`: `number`; \}, `context`: `any`, `somethingElse`?: `string`): `boolean` + +Some nested params. + +## Parameters + +### params + +The parameters passed to the method. + +#### params.name + +`string` + +The name of the new group. + +#### params.nestedObj + +\{`name`: `string`;`obj`: \{`name`: () => `void`; \};`value`: `number`; \} + +A nested object. + +#### params.nestedObj.name + +`string` + +#### params.nestedObj.obj + +\{`name`: () => `void`; \} + +#### params.nestedObj.obj.name + +() => `void` + +#### params.nestedObj.value + +`number` + +#### params.parent + +`number` + +### context + +`any` + +The context of the method call. + +### somethingElse? + +`string` + +## Returns + +`boolean` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithOptionalParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithOptionalParameters.md new file mode 100644 index 000000000..6e214cd66 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithOptionalParameters.md @@ -0,0 +1,31 @@ +# Function: functionWithOptionalParameters() + +> **functionWithOptionalParameters**(`firstParamWithDefault`: `boolean`, `requiredParam`: `string`, `optionalParam`?: `string`, `paramWithDefault`?: `number`): `void` + +This is a function with a parameters. + +## Parameters + +### firstParamWithDefault + +`boolean` = `true` + +### requiredParam + +`string` + +A normal parameter. + +### optionalParam? + +`string` + +An optional parameter. + +### paramWithDefault? + +`number` = `0` + +## Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithRestParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithRestParams.md new file mode 100644 index 000000000..43498f855 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithRestParams.md @@ -0,0 +1,19 @@ +# Function: functionWithRestParams() + +> **functionWithRestParams**(`param`: `string`, ...`restParams`: `string`[]): `boolean` + +Function with reset parmas + +## Parameters + +### param + +`string` + +### restParams + +...`string`[] + +## Returns + +`boolean` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithTypeParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithTypeParameters.md new file mode 100644 index 000000000..c75e4fd85 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithTypeParameters.md @@ -0,0 +1,19 @@ +# Function: functionWithTypeParameters() + +> **functionWithTypeParameters**\<`T`, `Item`\>(): `boolean` + +Function with type parameters + +## Type Parameters + +### T + +Comments for T + +### Item + +Default type `string` \| `boolean` + +## Returns + +`boolean` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithUnionParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithUnionParams.md new file mode 100644 index 000000000..7d941ad7c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/functions/functionWithUnionParams.md @@ -0,0 +1,51 @@ +# Function: functionWithUnionParams() + +> **functionWithUnionParams**(`primitiveUnions`: `string` \| `number`, `objectUnions`: \{`a`: `string`;`b`: `1`; \}, `mixedUnions`: `string` \| \{`a`: `string`;`b`: `string`; \}, `noUnions`: `string`): `undefined` + +## Parameters + +### primitiveUnions + +`string` | `number` + +### objectUnions + +Comments for objectUnions + +#### objectUnions.a + +`string` + +Comments for a + +#### objectUnions.b + +`1` + +### mixedUnions + +`string` + +\{`a`: `string`;`b`: `string`; \} + +#### mixedUnions.a + +`string` = `''` + +a comments + +#### mixedUnions.b + +`string` = `''` + +b comments + +### noUnions + +`string` + +Comments for noUnions + +## Returns + +`undefined` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/globals.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/globals.md new file mode 100644 index 000000000..be02bee29 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/globals.md @@ -0,0 +1,103 @@ +# typedoc-stubs + +Module comments + +## Enumerations + +- [BasicEnum](enumerations/BasicEnum.md) +- [EnumWithValues](enumerations/EnumWithValues.md) + +## Classes + +- [AbstractClass](classes/AbstractClass.md) +- [BaseClass](classes/BaseClass.md) +- [BasicClass](classes/BasicClass.md) +- [CallbacksOptions](classes/CallbacksOptions.md) +- [ChildClassA](classes/ChildClassA.md) +- [ChildClassB](classes/ChildClassB.md) +- [ClassWithAccessorKeywords](classes/ClassWithAccessorKeywords.md) +- [ClassWithAccessors](classes/ClassWithAccessors.md) +- [ClassWithComplexProps](classes/ClassWithComplexProps.md) +- [ClassWithConstructorOverloads](classes/ClassWithConstructorOverloads.md) +- [ClassWithFlags](classes/ClassWithFlags.md) +- [ClassWithModifiers](classes/ClassWithModifiers.md) +- [ClassWithoutPropCategories](classes/ClassWithoutPropCategories.md) +- [ClassWithPropCategories](classes/ClassWithPropCategories.md) +- [ClassWithSimpleProps](classes/ClassWithSimpleProps.md) +- [ClassWithSymbols](classes/ClassWithSymbols.md) +- [ClassWithTypeParameters](classes/ClassWithTypeParameters.md) +- [DerivedClassA](classes/DerivedClassA.md) +- [DerivedClassB](classes/DerivedClassB.md) +- [DisposableClass](classes/DisposableClass.md) +- [GrandChildClassA](classes/GrandChildClassA.md) +- [GrandChildClassB](classes/GrandChildClassB.md) + +## Interfaces + +- [BasicInterface](interfaces/BasicInterface.md) +- [CustomEventInterface](interfaces/CustomEventInterface.md) +- [ExtendedInterface](interfaces/ExtendedInterface.md) +- [IndexableInterface](interfaces/IndexableInterface.md) +- [InterfaceWithComments](interfaces/InterfaceWithComments.md) +- [InterfaceWithEventProperties](interfaces/InterfaceWithEventProperties.md) +- [InterfaceWithFlags](interfaces/InterfaceWithFlags.md) +- [InterfaceWithTypeParameters](interfaces/InterfaceWithTypeParameters.md) +- [MultipleIndexableInterface](interfaces/MultipleIndexableInterface.md) + +## Type Aliases + +- [\_\_TypeDeclarationWithSpecialCharacters\_](type-aliases/TypeDeclarationWithSpecialCharacters.md) +- [ArrayOfStuff](type-aliases/ArrayOfStuff.md) +- [ArrayType](type-aliases/ArrayType.md) +- [ConditionalType](type-aliases/ConditionalType.md) +- [ExternalReferenceType](type-aliases/ExternalReferenceType.md) +- [FunctionType](type-aliases/FunctionType.md) +- [IndexAccessType](type-aliases/IndexAccessType.md) +- [IntersectionType](type-aliases/IntersectionType.md) +- [LiteralType](type-aliases/LiteralType.md) +- [PartialMappedType](type-aliases/PartialMappedType.md) +- [PrimitiveType](type-aliases/PrimitiveType.md) +- [PromiseTypeWithObject](type-aliases/PromiseTypeWithObject.md) +- [PromiseTypeWithSymbol](type-aliases/PromiseTypeWithSymbol.md) +- [QueryType](type-aliases/QueryType.md) +- [ReadonlyMappedType](type-aliases/ReadonlyMappedType.md) +- [StringLiteralType](type-aliases/StringLiteralType.md) +- [Stuff](type-aliases/Stuff.md) +- [TupleType](type-aliases/TupleType.md) +- [TypeWithExternalSymbolLinkMapping](type-aliases/TypeWithExternalSymbolLinkMapping.md) +- [TypeWithReturns](type-aliases/TypeWithReturns.md) +- [TypeWithTypeParams](type-aliases/TypeWithTypeParams.md) +- [UnionType](type-aliases/UnionType.md) +- [UnionTypeWithTemplateStrings](type-aliases/UnionTypeWithTemplateStrings.md) +- [UsefulUnionType](type-aliases/UsefulUnionType.md) + +## Variables + +- [objectLiteralVariable](variables/objectLiteralVariable.md) +- [objectWithSymbol](variables/objectWithSymbol.md) +- [someQuery](variables/someQuery.md) +- [stringVariable](variables/stringVariable.md) +- [templateVariableString](variables/templateVariableString.md) +- [typeOperatorVariable](variables/typeOperatorVariable.md) + +## Functions + +- [basicFunction](functions/basicFunction.md) +- [basicFunctionWithReturns](functions/basicFunctionWithReturns.md) +- [curriedFunction](functions/curriedFunction.md) +- [functionReturningAFunction](functions/functionReturningAFunction.md) +- [functionReturningAnObject](functions/functionReturningAnObject.md) +- [functionReturningAPromise](functions/functionReturningAPromise.md) +- [functionReturningAString](functions/functionReturningAString.md) +- [functionReturningAUnionType](functions/functionReturningAUnionType.md) +- [functionWithArrayOfOptionalStuff](functions/functionWithArrayOfOptionalStuff.md) +- [functionWithArrayOfStuff](functions/functionWithArrayOfStuff.md) +- [functionWithComplexParams](functions/functionWithComplexParams.md) +- [functionWithDefaultParameters](functions/functionWithDefaultParameters.md) +- [functionWithMultipleSignatures](functions/functionWithMultipleSignatures.md) +- [functionWithNamedParams](functions/functionWithNamedParams.md) +- [functionWithNestedParameters](functions/functionWithNestedParameters.md) +- [functionWithOptionalParameters](functions/functionWithOptionalParameters.md) +- [functionWithRestParams](functions/functionWithRestParams.md) +- [functionWithTypeParameters](functions/functionWithTypeParameters.md) +- [functionWithUnionParams](functions/functionWithUnionParams.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/BasicInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/BasicInterface.md new file mode 100644 index 000000000..f4cd52b5b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/BasicInterface.md @@ -0,0 +1,193 @@ +# Interface: BasicInterface + +Comments for BasicInterface + +## Extended by + +- [`ExtendedInterface`](ExtendedInterface.md) + +## Properties + +### ~~deprecatedProp~~ + +> **deprecatedProp**: `string` + +#### Deprecated + +This prop is deprecated + +#### See + +Comments for some tag + +*** + +### functionProp() + +> **functionProp**: (`s`: `string`) => `boolean` + +Comments for functionProper + +#### Parameters + +##### s + +`string` + +Comment for param s + +#### Returns + +`boolean` + +*** + +### optionalProp? + +> `optional` **optionalProp**: `string` + +Comments for optional prop + +*** + +### prop + +> **prop**: `string` + +Comments for prop + +*** + +### propReturningObjectDeclaration + +> **propReturningObjectDeclaration**: \{`a`: `boolean`;`b`: `string`; \} + +Comments for propReturningObjectDeclaration + +#### a + +> **a**: `boolean` + +#### b + +> **b**: `string` + +*** + +### propReturningObjectDeclarations + +> **propReturningObjectDeclarations**: \{`a`: `boolean`;`b`: `string`; \} & \{`c`: `boolean`;`d`: `string`; \} + +Comments for propReturningObjectDeclarations + +#### Type declaration + +##### a + +> **a**: `boolean` + +##### b + +> **b**: `string` + +#### Type declaration + +##### c + +> **c**: `boolean` + +##### d + +> **d**: `string` + +*** + +### propReturningSignatureDeclaration()? + +> `optional` **propReturningSignatureDeclaration**: () => `string` \| `number` \| `boolean` + +Comments for propReturningSignatureDeclaration + +#### Returns + +`string` \| `number` \| `boolean` + +*** + +### propReturningSignatureDeclarations + +> **propReturningSignatureDeclarations**: () => `any` & (`paramsA`: `true` \| `any`[], `paramsB`?: `any`) => `any` & (`paramsC`: `any`) => `any` + +Comments for propReturningSignatureDeclarations + +*** + +### propWithFunction() + +> **propWithFunction**: (`options`: \{`a`: `boolean`;`b`: `string`; \}) => `boolean` + +Comments for propWithFunction + +#### Parameters + +##### options + +###### options.a + +`boolean` + +###### options.b + +`string` + +#### Returns + +`boolean` + +*** + +### propWithProps + +> **propWithProps**: \{`callbacks`: `Partial`\<[`CallbacksOptions`](../classes/CallbacksOptions.md)\<[`DisposableClass`](../classes/DisposableClass.md), [`ClassWithModifiers`](../classes/ClassWithModifiers.md)\>\>;`nestedPropA`: `string`;`nestedPropB`: `boolean`;`nestedPropC`: \{`nestedPropCA`: `string`; \};`nestedPropD`: () => `boolean`; \} + +Comments for propWithProps + +#### callbacks? + +> `optional` **callbacks**: `Partial`\<[`CallbacksOptions`](../classes/CallbacksOptions.md)\<[`DisposableClass`](../classes/DisposableClass.md), [`ClassWithModifiers`](../classes/ClassWithModifiers.md)\>\> + +Comments for callbacks + +#### nestedPropA + +> **nestedPropA**: `string` + +Comments for nestedPropA + +#### nestedPropB + +> **nestedPropB**: `boolean` + +Comments for nestedPropB + +#### nestedPropC + +> **nestedPropC**: \{`nestedPropCA`: `string`; \} + +Comments for nestedPropC + +##### nestedPropC.nestedPropCA + +> **nestedPropCA**: `string` + +Comments for nestedPropCA + +#### nestedPropD() + +> **nestedPropD**: () => `boolean` + +Comments for nestedPropD + +##### Returns + +`boolean` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/CustomEventInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/CustomEventInterface.md new file mode 100644 index 000000000..4c6b1b6e0 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/CustomEventInterface.md @@ -0,0 +1,19 @@ +# Interface: CustomEventInterface\ + +## Type Parameters + +### T + +\- + +## Properties + +### detail + +> **detail**: `string` + +*** + +### target + +> **target**: `T` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/ExtendedInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/ExtendedInterface.md new file mode 100644 index 000000000..68de67eb1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/ExtendedInterface.md @@ -0,0 +1,239 @@ +# Interface: ExtendedInterface + +Comments for ExtendedInterface + +## Extends + +- [`BasicInterface`](BasicInterface.md) + +## Properties + +### ~~deprecatedProp~~ + +> **deprecatedProp**: `string` + +#### Deprecated + +This prop is deprecated + +#### See + +Comments for some tag + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`deprecatedProp`](BasicInterface.md#deprecatedprop) + +*** + +### extendedProp + +> **extendedProp**: `string` + +*** + +### functionProp() + +> **functionProp**: (`s`: `string`) => `boolean` + +Comments for functionProper + +#### Parameters + +##### s + +`string` + +Comment for param s + +#### Returns + +`boolean` + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`functionProp`](BasicInterface.md#functionprop) + +*** + +### optionalProp? + +> `optional` **optionalProp**: `string` + +Comments for optional prop + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`optionalProp`](BasicInterface.md#optionalprop) + +*** + +### prop + +> **prop**: `string` + +Comments for prop + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`prop`](BasicInterface.md#prop) + +*** + +### propReturningObjectDeclaration + +> **propReturningObjectDeclaration**: \{`a`: `boolean`;`b`: `string`; \} + +Comments for propReturningObjectDeclaration + +#### a + +> **a**: `boolean` + +#### b + +> **b**: `string` + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`propReturningObjectDeclaration`](BasicInterface.md#propreturningobjectdeclaration) + +*** + +### propReturningObjectDeclarations + +> **propReturningObjectDeclarations**: \{`a`: `boolean`;`b`: `string`; \} & \{`c`: `boolean`;`d`: `string`; \} + +Comments for propReturningObjectDeclarations + +#### Type declaration + +##### a + +> **a**: `boolean` + +##### b + +> **b**: `string` + +#### Type declaration + +##### c + +> **c**: `boolean` + +##### d + +> **d**: `string` + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`propReturningObjectDeclarations`](BasicInterface.md#propreturningobjectdeclarations) + +*** + +### propReturningSignatureDeclaration()? + +> `optional` **propReturningSignatureDeclaration**: () => `string` \| `number` \| `boolean` + +Comments for propReturningSignatureDeclaration + +#### Returns + +`string` \| `number` \| `boolean` + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`propReturningSignatureDeclaration`](BasicInterface.md#propreturningsignaturedeclaration) + +*** + +### propReturningSignatureDeclarations + +> **propReturningSignatureDeclarations**: () => `any` & (`paramsA`: `true` \| `any`[], `paramsB`?: `any`) => `any` & (`paramsC`: `any`) => `any` + +Comments for propReturningSignatureDeclarations + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`propReturningSignatureDeclarations`](BasicInterface.md#propreturningsignaturedeclarations) + +*** + +### propWithFunction() + +> **propWithFunction**: (`options`: \{`a`: `boolean`;`b`: `string`; \}) => `boolean` + +Comments for propWithFunction + +#### Parameters + +##### options + +###### options.a + +`boolean` + +###### options.b + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`propWithFunction`](BasicInterface.md#propwithfunction) + +*** + +### propWithProps + +> **propWithProps**: \{`callbacks`: `Partial`\<[`CallbacksOptions`](../classes/CallbacksOptions.md)\<[`DisposableClass`](../classes/DisposableClass.md), [`ClassWithModifiers`](../classes/ClassWithModifiers.md)\>\>;`nestedPropA`: `string`;`nestedPropB`: `boolean`;`nestedPropC`: \{`nestedPropCA`: `string`; \};`nestedPropD`: () => `boolean`; \} + +Comments for propWithProps + +#### callbacks? + +> `optional` **callbacks**: `Partial`\<[`CallbacksOptions`](../classes/CallbacksOptions.md)\<[`DisposableClass`](../classes/DisposableClass.md), [`ClassWithModifiers`](../classes/ClassWithModifiers.md)\>\> + +Comments for callbacks + +#### nestedPropA + +> **nestedPropA**: `string` + +Comments for nestedPropA + +#### nestedPropB + +> **nestedPropB**: `boolean` + +Comments for nestedPropB + +#### nestedPropC + +> **nestedPropC**: \{`nestedPropCA`: `string`; \} + +Comments for nestedPropC + +##### nestedPropC.nestedPropCA + +> **nestedPropCA**: `string` + +Comments for nestedPropCA + +#### nestedPropD() + +> **nestedPropD**: () => `boolean` + +Comments for nestedPropD + +##### Returns + +`boolean` + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`propWithProps`](BasicInterface.md#propwithprops) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/IndexableInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/IndexableInterface.md new file mode 100644 index 000000000..65fbd6457 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/IndexableInterface.md @@ -0,0 +1,13 @@ +# Interface: IndexableInterface + +Comments for IndexableInterface + +## Indexable + + \[`s`: `string`\]: `string` + +## Properties + +### prop + +> **prop**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/InterfaceWithComments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/InterfaceWithComments.md new file mode 100644 index 000000000..991f0d6b5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/InterfaceWithComments.md @@ -0,0 +1,51 @@ +# Interface: InterfaceWithComments\ + +Comments for interface +over two lines + +And some more comments + +## Type Parameters + +### A + +This is a parameter. + +### B + +Comments for a parameter. +This sentence is on a soft new line. + +### C + +This is a parameter. + + Documentation with a double line + +### D + +

These are comments with paras

+

These are comments with paras

+Other comments +Comments with

paras

+ +

These are comments with paras

+ +## Properties + +### ~~propertyWithComments~~ + +> **propertyWithComments**: `string` + +Some text. + +- list item +- list item + +#### Deprecated + +This is a deprecated property + +#### See + +https://example.com diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/InterfaceWithEventProperties.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/InterfaceWithEventProperties.md new file mode 100644 index 000000000..ed6bfc845 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/InterfaceWithEventProperties.md @@ -0,0 +1,39 @@ +# Interface: InterfaceWithEventProperties + +## Properties + +### someProp? + +> `optional` **someProp**: `boolean` + +Description for prop someProp + +## Events + +### anotherEvent + +> **anotherEvent**: `MouseEvent` + +*** + +### ~~someEvent()?~~ + +> `optional` **someEvent**: (`eventParam`: [`CustomEventInterface`](CustomEventInterface.md)\<`MouseEvent`\>) => `void` + +Description for event someEvent + +#### Deprecated + +Deprectaed comments + +#### Parameters + +##### eventParam + +[`CustomEventInterface`](CustomEventInterface.md)\<`MouseEvent`\> + +Comments for param eventParam + +#### Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/InterfaceWithFlags.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/InterfaceWithFlags.md new file mode 100644 index 000000000..622faa199 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/InterfaceWithFlags.md @@ -0,0 +1,21 @@ +# Interface: InterfaceWithFlags + +Comments for InterfaceWithFlags + +## Properties + +### expermintalProp? + +> `optional` **expermintalProp**: `string` + +**`Experimental`** + +*** + +### internalProp + +> **internalProp**: `string` + +**`Internal`** + +Comments for internalProp diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/InterfaceWithTypeParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/InterfaceWithTypeParameters.md new file mode 100644 index 000000000..85ad2de41 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/InterfaceWithTypeParameters.md @@ -0,0 +1,17 @@ +# Interface: InterfaceWithTypeParameters\ + +Comments for InterfaceWithTypeParameters + +## Type Parameters + +### A + +\- + +## Properties + +### prop + +> **prop**: `A` + +Comments for prop diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/MultipleIndexableInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/MultipleIndexableInterface.md new file mode 100644 index 000000000..bc1392d6f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/interfaces/MultipleIndexableInterface.md @@ -0,0 +1,15 @@ +# Interface: MultipleIndexableInterface + +## Indexable + + \[`key`: `string`\]: `string` + + \[`index`: `number`\]: `string` + +## Properties + +### prop + +> **prop**: `string` + +Prop diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ArrayOfStuff.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ArrayOfStuff.md new file mode 100644 index 000000000..172143742 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ArrayOfStuff.md @@ -0,0 +1,3 @@ +# Type Alias: ArrayOfStuff + +> **ArrayOfStuff**: \{`age`: `number`;`name`: `string`; \}[] diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ArrayType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ArrayType.md new file mode 100644 index 000000000..9045ba144 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ArrayType.md @@ -0,0 +1,5 @@ +# Type Alias: ArrayType + +> **ArrayType**: `string`[] + +Comments for ArrayType diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ConditionalType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ConditionalType.md new file mode 100644 index 000000000..98f8b1e94 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ConditionalType.md @@ -0,0 +1,11 @@ +# Type Alias: ConditionalType\ + +> **ConditionalType**\<`T`\>: `T` *extends* `string` ? `"string"` : `T` *extends* `number` ? `"number"` : `T` *extends* `boolean` ? `"boolean"` : `T` *extends* `undefined` ? `"undefined"` : `"object"` + +Comments for ConditionalType + +## Type Parameters + +### T + +\- diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ExternalReferenceType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ExternalReferenceType.md new file mode 100644 index 000000000..e7eee7994 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ExternalReferenceType.md @@ -0,0 +1,5 @@ +# Type Alias: ExternalReferenceType + +> **ExternalReferenceType**: [`ClassWithTypeParameters`](../classes/ClassWithTypeParameters.md)\<`"x"`, `"y"`\> + +Comments for ExternalReferenceType diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/FunctionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/FunctionType.md new file mode 100644 index 000000000..87e05ed9c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/FunctionType.md @@ -0,0 +1,19 @@ +# Type Alias: FunctionType() + +> **FunctionType**: (`name`: `string`, `value`: `unknown`) => `void` + +Comments for FunctionType + +## Parameters + +### name + +`string` + +### value + +`unknown` + +## Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/IndexAccessType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/IndexAccessType.md new file mode 100644 index 000000000..37efd85c2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/IndexAccessType.md @@ -0,0 +1,5 @@ +# Type Alias: IndexAccessType + +> **IndexAccessType**: [`ArrayOfStuff`](ArrayOfStuff.md)\[`number`\] + +Comments for IndexAccessType diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/IntersectionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/IntersectionType.md new file mode 100644 index 000000000..3a1daa23e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/IntersectionType.md @@ -0,0 +1,11 @@ +# Type Alias: IntersectionType + +> **IntersectionType**: [`TupleType`](TupleType.md) & [`ArrayType`](ArrayType.md) & \{`bar`: `number`; \} + +Comments for IntersectionType + +## Type declaration + +### bar + +> **bar**: `number` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/LiteralType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/LiteralType.md new file mode 100644 index 000000000..bb6b860da --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/LiteralType.md @@ -0,0 +1,137 @@ +# Type Alias: LiteralType + +> **LiteralType**: \{`someFunctionWithArrow`: () => `string`;`x`: `string`;`y`: \{`x`: `string`;`y`: `boolean` \| `string`;`z`: (`x`: `string`) => `string`; \};`z`: (`x`: `string`) => `string`;get set `accessorA`: [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\>;get set `accessorB`: `string`;`someFunction`: [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\>; \} + +Comments for LiteralType + +## Type declaration + +### someFunctionWithArrow() + +> **someFunctionWithArrow**: () => `string` + +Comments for someFunctionWithArrow + +#### Returns + +`string` + +### x? + +> `optional` **x**: `string` + +comment for x + +### y + +> **y**: \{`x`: `string`;`y`: `boolean` \| `string`;`z`: (`x`: `string`) => `string`; \} + +comment for y + +#### y.x + +> **x**: `string` + +comment for y.x + +#### y.y? + +> `optional` **y**: `boolean` \| `string` + +comment for y.y + +#### y.z() + +> **z**: (`x`: `string`) => `string` + +comment for y.z + +##### Parameters + +###### x + +`string` + +##### Returns + +`string` + +### z() + +> **z**: (`x`: `string`) => `string` + +#### Parameters + +##### x + +`string` + +#### Returns + +`string` + +### accessorA + +#### Get Signature + +> **get** **accessorA**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\> + +Comments for accessorA getter + +##### Returns + +[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\> + +#### Set Signature + +> **set** **accessorA**(`x`: [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\>): `void` + +Comments for accessorA setter + +##### Parameters + +###### x + +[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\> + +##### Returns + +`void` + +### accessorB + +#### Get Signature + +> **get** **accessorB**(): `string` + +##### Returns + +`string` + +#### Set Signature + +> **set** **accessorB**(`x`: `string`): `void` + +##### Parameters + +###### x + +`string` + +##### Returns + +`void` + +### someFunction() + +Comments for someFunction + +#### Parameters + +##### param + +`string` + +#### Returns + +[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/PartialMappedType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/PartialMappedType.md new file mode 100644 index 000000000..996aaeccc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/PartialMappedType.md @@ -0,0 +1,11 @@ +# Type Alias: PartialMappedType\ + +> **PartialMappedType**\<`T`\>: `{ [P in keyof T]?: T[P] }` + +Comments for PartialMappedType + +## Type Parameters + +### T + +\- diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/PrimitiveType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/PrimitiveType.md new file mode 100644 index 000000000..489380b92 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/PrimitiveType.md @@ -0,0 +1,5 @@ +# Type Alias: PrimitiveType + +> **PrimitiveType**: `boolean` + +Comments for PrimitiveType diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/PromiseTypeWithObject.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/PromiseTypeWithObject.md new file mode 100644 index 000000000..ee2116760 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/PromiseTypeWithObject.md @@ -0,0 +1,13 @@ +# Type Alias: PromiseTypeWithObject + +> **PromiseTypeWithObject**: [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<\{`x`: `1`; \}\> + +Comments for promise type returning object + +## Type declaration + +### x + +> **x**: `1` + +comments for x diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/PromiseTypeWithSymbol.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/PromiseTypeWithSymbol.md new file mode 100644 index 000000000..6f634f85e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/PromiseTypeWithSymbol.md @@ -0,0 +1,5 @@ +# Type Alias: PromiseTypeWithSymbol + +> **PromiseTypeWithSymbol**: [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`IndexAccessType`](IndexAccessType.md)\> + +Comments for promise type returning symbol diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/QueryType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/QueryType.md new file mode 100644 index 000000000..5ce45e46a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/QueryType.md @@ -0,0 +1,5 @@ +# Type Alias: QueryType + +> **QueryType**: *typeof* [`someQuery`](../variables/someQuery.md) + +Comments for query type diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ReadonlyMappedType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ReadonlyMappedType.md new file mode 100644 index 000000000..ed884b43e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/ReadonlyMappedType.md @@ -0,0 +1,11 @@ +# Type Alias: ReadonlyMappedType\ + +> **ReadonlyMappedType**\<`T`\>: `{ readonly [P in keyof T]: T[P] }` + +Comments for ReadonlyMapedType + +## Type Parameters + +### T + +\- diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/StringLiteralType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/StringLiteralType.md new file mode 100644 index 000000000..dec0165d7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/StringLiteralType.md @@ -0,0 +1,5 @@ +# Type Alias: StringLiteralType + +> **StringLiteralType**: `" "` \| `"string"` \| "string\|with\|pipes" \| "string\`with\`backticks" \| `""` \| `"*"` + +Comments for StringLiteralType diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/Stuff.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/Stuff.md new file mode 100644 index 000000000..c63e96bc1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/Stuff.md @@ -0,0 +1,13 @@ +# Type Alias: Stuff + +> **Stuff**: \{`a`: `string`;`b`: `string`; \} + +## Type declaration + +### a + +> **a**: `string` + +### b + +> **b**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TupleType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TupleType.md new file mode 100644 index 000000000..da3fec4fe --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TupleType.md @@ -0,0 +1,5 @@ +# Type Alias: TupleType + +> **TupleType**: [`string`, `number`] + +Comments for TupleType diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TypeDeclarationWithSpecialCharacters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TypeDeclarationWithSpecialCharacters.md new file mode 100644 index 000000000..5f82ddf37 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TypeDeclarationWithSpecialCharacters.md @@ -0,0 +1,107 @@ +# Type Alias: \_\_TypeDeclarationWithSpecialCharacters\_\ + +> **\_\_TypeDeclarationWithSpecialCharacters\_**\<`T`, `U`\>: \{`_`: `"_"`;`_foo_`: `"_foo_"`;`_prop_with_underscore_`: `"_prop_with_underscore_"`;`_x`: (`_param`: `T`) => `U`;`?`: `T` \| `U`;`{prop-with-brackets}`: `"{prop-with-brackets}"`;`*`: `"*"`;`**foo**`: `"**foo**"`;`*foo*`: `"*foo*"`;\: "\\";\a: "\\a";\n: "\\n";\`: "\`";\`prop\`with\`backticks\`: "\`prop\`with\`backticks\`";`<`: `"<"`;``: `""`;`>`: `">"`;\|: "\|";\|prop\|with\|pipes\|: "\|prop\|with\|pipes\|";`~`: `"~"`; \} + +Comments for object with special characters + +## Type Parameters + +### T + +\- + +### U + +\- + +## Type declaration + +### \_ + +> **\_**: `"_"` + +### \_foo\_ + +> **\_foo\_**: `"_foo_"` + +### \_prop\_with\_underscore\_ + +> **\_prop\_with\_underscore\_**: `"_prop_with_underscore_"` + +### \_x() + +> **\_x**: (`_param`: `T`) => `U` + +#### Parameters + +##### \_param + +`T` + +#### Returns + +`U` + +### ? + +> **?**: `T` \| `U` + +### \{prop-with-brackets\} + +> **\{prop-with-brackets\}**: `"{prop-with-brackets}"` + +### \* + +> **\***: `"*"` + +### \*\*foo\*\* + +> **\*\*foo\*\***: `"**foo**"` + +### \*foo\* + +> **\*foo\***: `"*foo*"` + +### \ + +> \: "\\" + +### \a + +> \a: "\\a" + +### \n + +> \n: "\\n" + +### \` + +> \`: "\`" + +### \`prop\`with\`backticks\` + +> \`prop\`with\`backticks\`: "\`prop\`with\`backticks\`" + +### \< + +> **\<**: `"<"` + +### \ + +> **\**: `""` + +### \> + +> **\>**: `">"` + +### \| + +> **\|**: "\|" + +### \|prop\|with\|pipes\| + +> **\|prop\|with\|pipes\|**: "\|prop\|with\|pipes\|" + +### ~ + +> **~**: `"~"` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TypeWithExternalSymbolLinkMapping.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TypeWithExternalSymbolLinkMapping.md new file mode 100644 index 000000000..f002b076b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TypeWithExternalSymbolLinkMapping.md @@ -0,0 +1,5 @@ +# Type Alias: TypeWithExternalSymbolLinkMapping + +> **TypeWithExternalSymbolLinkMapping**: [`Application`](https://typedoc.org/api/classes/Application.html) + +Comments for TypeWithExternalSymbolLinkMapping diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TypeWithReturns.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TypeWithReturns.md new file mode 100644 index 000000000..fcba98a1f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TypeWithReturns.md @@ -0,0 +1,9 @@ +# Type Alias: TypeWithReturns + +> **TypeWithReturns**: `string` + +Comments for TypeWithReturns + +## Returns + +- return comments. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TypeWithTypeParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TypeWithTypeParams.md new file mode 100644 index 000000000..974a4c8c4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/TypeWithTypeParams.md @@ -0,0 +1,15 @@ +# Type Alias: TypeWithTypeParams\ + +> **TypeWithTypeParams**\<`T`, `R`\>: [`T`, `R`] + +Comments for TypeWithTypeParams + +## Type Parameters + +### T + +\- + +### R + +\- diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/UnionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/UnionType.md new file mode 100644 index 000000000..6816da829 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/UnionType.md @@ -0,0 +1,5 @@ +# Type Alias: UnionType + +> **UnionType**: `string` \| `boolean` \| \{`z`: `string`; \} + +Comments for UnionType diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/UnionTypeWithTemplateStrings.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/UnionTypeWithTemplateStrings.md new file mode 100644 index 000000000..bd29ea877 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/UnionTypeWithTemplateStrings.md @@ -0,0 +1,5 @@ +# Type Alias: UnionTypeWithTemplateStrings + +> **UnionTypeWithTemplateStrings**: \`v$\{number\}\` \| \`v$\{number\}.$\{number\}\` \| \`v$\{number\}.$\{number\}.$\{number\}\` + +Union with template strings diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/UsefulUnionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/UsefulUnionType.md new file mode 100644 index 000000000..4acdd1665 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/type-aliases/UsefulUnionType.md @@ -0,0 +1,19 @@ +# Type Alias: UsefulUnionType + +> **UsefulUnionType**: `string` \| `boolean` \| \{`z`: `string`; \} + +Comments for useful UnionType + +## Type declaration + +`string` + +`boolean` + +\{`z`: `string`; \} + +### z + +> **z**: `string` + +Comments for z diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/objectLiteralVariable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/objectLiteralVariable.md new file mode 100644 index 000000000..cdd00f2f5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/objectLiteralVariable.md @@ -0,0 +1,89 @@ +# Variable: objectLiteralVariable + +> `const` **objectLiteralVariable**: \{`valueA`: `number`;`valueB`: `boolean`;`valueX`: \{`valueA`: `number`[];`valueY`: (`z`: `string`) => \{`a`: `string`;`b`: `string`;`c`: \{`a`: `number`;`b`: `number`; \}; \};`valueZ`: `string`; \};`valueY`: (`unionParam`: `"a"` \| `"b"`, `_undercoreParam_`: `string`) => `string`; \} + +Comments for objectLiteralVariable + +## See + +xyz.com + +## Type declaration + +### valueA + +> **valueA**: `number` = `100` + +Comments for valueA + +### valueB + +> **valueB**: `boolean` = `true` + +### valueX + +> **valueX**: \{`valueA`: `number`[];`valueY`: (`z`: `string`) => \{`a`: `string`;`b`: `string`;`c`: \{`a`: `number`;`b`: `number`; \}; \};`valueZ`: `string`; \} + +Comments for valueX + +#### valueX.valueA + +> **valueA**: `number`[] + +Comment for valueX.valueA + +#### valueX.valueY() + +> **valueY**: (`z`: `string`) => \{`a`: `string`;`b`: `string`;`c`: \{`a`: `number`;`b`: `number`; \}; \} + +##### Parameters + +###### z + +`string` + +##### Returns + +\{`a`: `string`;`b`: `string`;`c`: \{`a`: `number`;`b`: `number`; \}; \} + +###### a + +> **a**: `string` = `'test'` + +###### b + +> **b**: `string` = `z` + +###### c + +> **c**: \{`a`: `number`;`b`: `number`; \} + +###### c.a + +> **a**: `number` = `1` + +###### c.b + +> **b**: `number` = `2` + +#### valueX.valueZ + +> **valueZ**: `string` = `'foo'` + +### valueY() + +> **valueY**: (`unionParam`: `"a"` \| `"b"`, `_undercoreParam_`: `string`) => `string` + +#### Parameters + +##### unionParam + +`"a"` | `"b"` + +##### \_undercoreParam\_ + +`string` + +#### Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/objectWithSymbol.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/objectWithSymbol.md new file mode 100644 index 000000000..cde816ad5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/objectWithSymbol.md @@ -0,0 +1,13 @@ +# Variable: objectWithSymbol + +> `const` **objectWithSymbol**: \{`[sym]`: `string`; \} + +Comments variable with symbol + +## Type declaration + +### \[sym\] + +> **\[sym\]**: `string` = `'value'` + +Comments for symbol diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/someQuery.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/someQuery.md new file mode 100644 index 000000000..0678f16b5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/someQuery.md @@ -0,0 +1,3 @@ +# Variable: someQuery + +> `const` **someQuery**: `1` = `1` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/stringVariable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/stringVariable.md new file mode 100644 index 000000000..c097f0ab9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/stringVariable.md @@ -0,0 +1,5 @@ +# Variable: stringVariable + +> `const` **stringVariable**: `"stringConstWithDefaultValue"` = `'stringConstWithDefaultValue'` + +A simple string variable diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/templateVariableString.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/templateVariableString.md new file mode 100644 index 000000000..398107060 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/templateVariableString.md @@ -0,0 +1,5 @@ +# Variable: templateVariableString + +> `const` **templateVariableString**: "\nThis is a template string\n/\* with a comment \*/\nAnd a \\\n" + +A template variable string diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/typeOperatorVariable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/typeOperatorVariable.md new file mode 100644 index 000000000..32679f174 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-1/variables/typeOperatorVariable.md @@ -0,0 +1,5 @@ +# Variable: typeOperatorVariable + +> `const` **typeOperatorVariable**: unique `symbol` + +Comments for typeOperatorVariable diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/README.md new file mode 100644 index 000000000..8bc10a451 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/README.md @@ -0,0 +1,9 @@ +# MY README + +> Some block quote + +Some text. + +## Readme heading + +Some text. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/AbstractClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/AbstractClass.md new file mode 100644 index 000000000..40f2a06ad --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/AbstractClass.md @@ -0,0 +1,38 @@ +# Class: `abstract` AbstractClass + +## Extended by + +- [`DerivedClassA`](DerivedClassA.md) +- [`DerivedClassB`](DerivedClassB.md) + +## Constructors + +### new AbstractClass() + +```ts +new AbstractClass(): AbstractClass +``` + +#### Returns + +[`AbstractClass`](AbstractClass.md) + +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `abstractProp` | `abstract` | `string` | Comments for abstractProp | + +## Methods + +### abstractMethod() + +```ts +abstract abstractMethod(): string +``` + +Comments for abstractMethod + +#### Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/BaseClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/BaseClass.md new file mode 100644 index 000000000..0a546c636 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/BaseClass.md @@ -0,0 +1,18 @@ +# Class: BaseClass + +## Extended by + +- [`ChildClassA`](ChildClassA.md) +- [`ChildClassB`](ChildClassB.md) + +## Constructors + +### new BaseClass() + +```ts +new BaseClass(): BaseClass +``` + +#### Returns + +[`BaseClass`](BaseClass.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/BasicClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/BasicClass.md new file mode 100644 index 000000000..a6d4e0004 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/BasicClass.md @@ -0,0 +1,35 @@ +# Class: BasicClass + +Comments for BasicClass + +## Constructors + +### new BasicClass() + +```ts +new BasicClass(): BasicClass +``` + +#### Returns + +[`BasicClass`](BasicClass.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `prop` | `string` | Comments for prop | + +## Methods + +### method() + +```ts +method(): string +``` + +Comments for method + +#### Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/CallbacksOptions.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/CallbacksOptions.md new file mode 100644 index 000000000..fa8c0bb57 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/CallbacksOptions.md @@ -0,0 +1,20 @@ +# Class: CallbacksOptions\ + +## Type Parameters + +| Type Parameter | Default type | +| :------ | :------ | +| `P` | [`DisposableClass`](DisposableClass.md) | +| `A` | [`ClassWithModifiers`](ClassWithModifiers.md) | + +## Constructors + +### new CallbacksOptions() + +```ts +new CallbacksOptions(): CallbacksOptions +``` + +#### Returns + +[`CallbacksOptions`](CallbacksOptions.md)\<`P`, `A`\> diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ChildClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ChildClassA.md new file mode 100644 index 000000000..69ea2706a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ChildClassA.md @@ -0,0 +1,26 @@ +# Class: ChildClassA + +## Extends + +- [`BaseClass`](BaseClass.md) + +## Extended by + +- [`GrandChildClassA`](GrandChildClassA.md) +- [`GrandChildClassB`](GrandChildClassB.md) + +## Constructors + +### new ChildClassA() + +```ts +new ChildClassA(): ChildClassA +``` + +#### Returns + +[`ChildClassA`](ChildClassA.md) + +#### Inherited from + +[`BaseClass`](BaseClass.md).[`constructor`](BaseClass.md#constructors) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ChildClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ChildClassB.md new file mode 100644 index 000000000..52d4dd04b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ChildClassB.md @@ -0,0 +1,21 @@ +# Class: ChildClassB + +## Extends + +- [`BaseClass`](BaseClass.md) + +## Constructors + +### new ChildClassB() + +```ts +new ChildClassB(): ChildClassB +``` + +#### Returns + +[`ChildClassB`](ChildClassB.md) + +#### Inherited from + +[`BaseClass`](BaseClass.md).[`constructor`](BaseClass.md#constructors) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithAccessorKeywords.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithAccessorKeywords.md new file mode 100644 index 000000000..e5053063b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithAccessorKeywords.md @@ -0,0 +1,41 @@ +# Class: ClassWithAccessorKeywords + +## Constructors + +### new ClassWithAccessorKeywords() + +```ts +new ClassWithAccessorKeywords(): ClassWithAccessorKeywords +``` + +#### Returns + +[`ClassWithAccessorKeywords`](ClassWithAccessorKeywords.md) + +## Accessors + +### accessor1 + +Accessor comments + +#### Example + +```ts +const x = 1; +``` + +*** + +### accessor2 + +Accessor comments + +#### Remarks + +Remark comments + +*** + +### accessor3 + +Accessor comments diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithAccessors.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithAccessors.md new file mode 100644 index 000000000..eda7ef44b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithAccessors.md @@ -0,0 +1,83 @@ +# Class: ClassWithAccessors + +Comments for ClassWithAccessors + +## Constructors + +### new ClassWithAccessors() + +```ts +new ClassWithAccessors(): ClassWithAccessors +``` + +#### Returns + +[`ClassWithAccessors`](ClassWithAccessors.md) + +## Accessors + +### accessor + +#### Get Signature + +```ts +get accessor(): string +``` + +Comments for getter + +##### Returns + +`string` + +#### Set Signature + +```ts +set accessor(value: string): void +``` + +Comments for setter + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `value` | `string` | Param comments | + +##### Returns + +`void` + +*** + +### noGetter + +#### Set Signature + +```ts +set noGetter(x: string): void +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `x` | `string` | + +##### Returns + +`void` + +*** + +### noSetter + +#### Get Signature + +```ts +get noSetter(): string +``` + +##### Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithComplexProps.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithComplexProps.md new file mode 100644 index 000000000..0f0814e81 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithComplexProps.md @@ -0,0 +1,23 @@ +# Class: ClassWithComplexProps + +Comments for ClassWithComplexProps + +## Constructors + +### new ClassWithComplexProps() + +```ts +new ClassWithComplexProps(): ClassWithComplexProps +``` + +#### Returns + +[`ClassWithComplexProps`](ClassWithComplexProps.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `objecLiteralProp` | \{ `someFunction`: (`a`: `string`) => `string`; `someProp`: `string`; \} | - | +| `objecLiteralProp.someFunction` | (`a`: `string`) => `string` | Comments for someFunction | +| `objecLiteralProp.someProp` | `string` | Comments for someProp | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithConstructorOverloads.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithConstructorOverloads.md new file mode 100644 index 000000000..27902918f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithConstructorOverloads.md @@ -0,0 +1,54 @@ +# Class: ClassWithConstructorOverloads + +Comments for ClassWithConstructorOverloads + +## Constructors + +### new ClassWithConstructorOverloads() + +```ts +new ClassWithConstructorOverloads(x: number, y: string): ClassWithConstructorOverloads +``` + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `x` | `number` | Comments for x number | +| `y` | `string` | | + +#### Returns + +[`ClassWithConstructorOverloads`](ClassWithConstructorOverloads.md) + +### new ClassWithConstructorOverloads() + +```ts +new ClassWithConstructorOverloads(x: string): ClassWithConstructorOverloads +``` + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `x` | `string` | Comments for x string | + +#### Returns + +[`ClassWithConstructorOverloads`](ClassWithConstructorOverloads.md) + +### new ClassWithConstructorOverloads() + +```ts +new ClassWithConstructorOverloads(s: string): ClassWithConstructorOverloads +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `s` | `string` | + +#### Returns + +[`ClassWithConstructorOverloads`](ClassWithConstructorOverloads.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithFlags.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithFlags.md new file mode 100644 index 000000000..262373be6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithFlags.md @@ -0,0 +1,49 @@ +# Class: ClassWithFlags + +Comment for ClassWithFlags + +## Constructors + +### new ClassWithFlags() + +```ts +new ClassWithFlags(): ClassWithFlags +``` + +#### Returns + +[`ClassWithFlags`](ClassWithFlags.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `expermintalProp` | `string` | **`Experimental`** | + +## Methods + +### expermintalMethod() + +```ts +expermintalMethod(): void +``` + +**`Experimental`** + +#### Returns + +`void` + +*** + +### internalMethod() + +```ts +protected internalMethod(): void +``` + +**`Internal`** + +#### Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithModifiers.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithModifiers.md new file mode 100644 index 000000000..9ce457371 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithModifiers.md @@ -0,0 +1,52 @@ +# Class: `abstract` ClassWithModifiers + +Comments for ClassWithModifiers + +## Constructors + +### new ClassWithModifiers() + +```ts +new ClassWithModifiers(): ClassWithModifiers +``` + +#### Returns + +[`ClassWithModifiers`](ClassWithModifiers.md) + +## Properties + +| Property | Modifier | Type | Default value | Description | +| :------ | :------ | :------ | :------ | :------ | +| `protectedProp` | `protected` | `string` | `undefined` | Comments for protectedProp | +| `publicPropWithDefault` | `public` | `string` | `'propWithDefault'` | Comments for propWithDefault | +| `readonlyProp` | `readonly` | `string` | `undefined` | Comments for abstractProperty | +| `staticProp` | `static` | `string` | `undefined` | Comments for staticProp | + +## Methods + +### publicMethod() + +```ts +publicMethod(): void +``` + +Comment for publicMethod + +#### Returns + +`void` + +*** + +### staticMethod() + +```ts +static staticMethod(): void +``` + +Comment for staticMethod + +#### Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithPropCategories.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithPropCategories.md new file mode 100644 index 000000000..7fe8def63 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithPropCategories.md @@ -0,0 +1,64 @@ +# Class: ClassWithPropCategories + +## Constructors + +### new ClassWithPropCategories() + +```ts +new ClassWithPropCategories(opts: { + a: string; + b: string; + }): ClassWithPropCategories +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `opts` | \{ `a`: `string`; `b`: `string`; \} | +| `opts.a` | `string` | +| `opts.b` | `string` | + +#### Returns + +[`ClassWithPropCategories`](ClassWithPropCategories.md) + +## CatA + +### prop1 + +```ts +prop1: string; +``` + +## CatB + +### prop2 + +```ts +prop2: string; +``` + +## Other + +### method1() + +```ts +method1(): void +``` + +#### Returns + +`void` + +*** + +### method2() + +```ts +method2(): void +``` + +#### Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithSimpleProps.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithSimpleProps.md new file mode 100644 index 000000000..77af27bf2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithSimpleProps.md @@ -0,0 +1,24 @@ +# Class: ClassWithSimpleProps + +Comments for ClassWithSimpleProps + +## Constructors + +### new ClassWithSimpleProps() + +```ts +new ClassWithSimpleProps(): ClassWithSimpleProps +``` + +#### Returns + +[`ClassWithSimpleProps`](ClassWithSimpleProps.md) + +## Properties + +| Property | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `propA` | `string` | `'propAValue'` | Comments for propA | +| `propB` | `string` | `'propBDefaultValue'` | Comments for propB | +| `propC` | `string` | `'propCDefaultValue'` | Comments for propB on two lines | +| `propD` | `string` | `undefined` | Comments for propE | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithSymbols.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithSymbols.md new file mode 100644 index 000000000..2051e28f7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithSymbols.md @@ -0,0 +1,31 @@ +# Class: ClassWithSymbols + +## Constructors + +### new ClassWithSymbols() + +```ts +new ClassWithSymbols(): ClassWithSymbols +``` + +#### Returns + +[`ClassWithSymbols`](ClassWithSymbols.md) + +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `[symbolConst]?` | `static` | () => `void` | + +## Methods + +### \[dispose\]() + +```ts +dispose: void +``` + +#### Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithTypeParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithTypeParameters.md new file mode 100644 index 000000000..2c3cae64e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithTypeParameters.md @@ -0,0 +1,23 @@ +# Class: ClassWithTypeParameters\ + +Comments for ClassWithTypeParameters + +## Type Parameters + +| Type Parameter | Default type | Description | +| :------ | :------ | :------ | +| `A` | - | - | +| `B` *extends* `string` | - | Comments for param B | +| `C` | `boolean` | Comments for param C | + +## Constructors + +### new ClassWithTypeParameters() + +```ts +new ClassWithTypeParameters(): ClassWithTypeParameters +``` + +#### Returns + +[`ClassWithTypeParameters`](ClassWithTypeParameters.md)\<`A`, `B`, `C`\> diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithoutPropCategories.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithoutPropCategories.md new file mode 100644 index 000000000..abc0c0534 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/ClassWithoutPropCategories.md @@ -0,0 +1,55 @@ +# Class: ClassWithoutPropCategories + +## Constructors + +### new ClassWithoutPropCategories() + +```ts +new ClassWithoutPropCategories(opts: { + a: string; + b: string; + }): ClassWithoutPropCategories +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `opts` | \{ `a`: `string`; `b`: `string`; \} | +| `opts.a` | `string` | +| `opts.b` | `string` | + +#### Returns + +[`ClassWithoutPropCategories`](ClassWithoutPropCategories.md) + +## Properties + +| Property | Type | +| :------ | :------ | +| `prop1` | `string` | +| `prop2` | `string` | + +## Methods + +### method1() + +```ts +method1(): void +``` + +#### Returns + +`void` + +*** + +### method2() + +```ts +method2(): void +``` + +#### Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/DerivedClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/DerivedClassA.md new file mode 100644 index 000000000..eb5719112 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/DerivedClassA.md @@ -0,0 +1,60 @@ +# Class: DerivedClassA + +Comments for DerivedClassA + +## Extends + +- [`AbstractClass`](AbstractClass.md) + +## Constructors + +### new DerivedClassA() + +```ts +new DerivedClassA(): DerivedClassA +``` + +#### Returns + +[`DerivedClassA`](DerivedClassA.md) + +#### Inherited from + +[`AbstractClass`](AbstractClass.md).[`constructor`](AbstractClass.md#constructors) + +## Properties + +| Property | Type | Default value | Description | Overrides | +| :------ | :------ | :------ | :------ | :------ | +| `abstractProp` | `string` | `'abstractProp'` | Comments for abstractProp | [`AbstractClass`](AbstractClass.md).`abstractProp` | +| `derivedProp` | `string` | `undefined` | - | - | + +## Methods + +### abstractMethod() + +```ts +abstractMethod(): string +``` + +Comments for abstractMethod + +#### Returns + +`string` + +#### Overrides + +[`AbstractClass`](AbstractClass.md).[`abstractMethod`](AbstractClass.md#abstractmethod) + +*** + +### derivedMethod() + +```ts +derivedMethod(): string +``` + +#### Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/DerivedClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/DerivedClassB.md new file mode 100644 index 000000000..09b358c23 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/DerivedClassB.md @@ -0,0 +1,47 @@ +# Class: DerivedClassB + +Comments for DerivedClassB + +## Extends + +- [`AbstractClass`](AbstractClass.md) + +## Constructors + +### new DerivedClassB() + +```ts +new DerivedClassB(): DerivedClassB +``` + +#### Returns + +[`DerivedClassB`](DerivedClassB.md) + +#### Inherited from + +[`AbstractClass`](AbstractClass.md).[`constructor`](AbstractClass.md#constructors) + +## Properties + +| Property | Type | Default value | Description | Overrides | +| :------ | :------ | :------ | :------ | :------ | +| `abstractProp` | `string` | `'abstractProp'` | Comments for abstractProp | [`AbstractClass`](AbstractClass.md).`abstractProp` | + +## Methods + +### abstractMethod() + +```ts +abstractMethod(): string +``` + +Comments for abstractMethod + +#### Returns + +`string` + +#### Overrides + +[`AbstractClass`](AbstractClass.md).[`abstractMethod`](AbstractClass.md#abstractmethod) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/DisposableClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/DisposableClass.md new file mode 100644 index 000000000..6e8be3a57 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/DisposableClass.md @@ -0,0 +1,33 @@ +# Class: DisposableClass + +## Implements + +- `Disposable` + +## Constructors + +### new DisposableClass() + +```ts +new DisposableClass(): DisposableClass +``` + +#### Returns + +[`DisposableClass`](DisposableClass.md) + +## Methods + +### \[dispose\]() + +```ts +dispose: void +``` + +#### Returns + +`void` + +#### Implementation of + +`Disposable.[dispose]` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/GrandChildClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/GrandChildClassA.md new file mode 100644 index 000000000..6b1171ff9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/GrandChildClassA.md @@ -0,0 +1,21 @@ +# Class: GrandChildClassA + +## Extends + +- [`ChildClassA`](ChildClassA.md) + +## Constructors + +### new GrandChildClassA() + +```ts +new GrandChildClassA(): GrandChildClassA +``` + +#### Returns + +[`GrandChildClassA`](GrandChildClassA.md) + +#### Inherited from + +[`ChildClassA`](ChildClassA.md).[`constructor`](ChildClassA.md#constructors) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/GrandChildClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/GrandChildClassB.md new file mode 100644 index 000000000..8dff5dca0 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/classes/GrandChildClassB.md @@ -0,0 +1,21 @@ +# Class: GrandChildClassB + +## Extends + +- [`ChildClassA`](ChildClassA.md) + +## Constructors + +### new GrandChildClassB() + +```ts +new GrandChildClassB(): GrandChildClassB +``` + +#### Returns + +[`GrandChildClassB`](GrandChildClassB.md) + +#### Inherited from + +[`ChildClassA`](ChildClassA.md).[`constructor`](ChildClassA.md#constructors) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/enumerations/BasicEnum.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/enumerations/BasicEnum.md new file mode 100644 index 000000000..d1ca4e581 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/enumerations/BasicEnum.md @@ -0,0 +1,23 @@ +# Enumeration: BasicEnum + +Comments for enum + +## Enumeration Members + +### MemberA + +```ts +MemberA: 0; +``` + +Comments for MemberA + +*** + +### MemberB + +```ts +MemberB: 1; +``` + +Comments for MemberB diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/enumerations/EnumWithValues.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/enumerations/EnumWithValues.md new file mode 100644 index 000000000..992b0c0f4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/enumerations/EnumWithValues.md @@ -0,0 +1,19 @@ +# Enumeration: EnumWithValues + +Comments for enum + +## Enumeration Members + +### MemberA + +```ts +MemberA: "UP"; +``` + +*** + +### MemberB + +```ts +MemberB: "DOWN"; +``` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/basicFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/basicFunction.md new file mode 100644 index 000000000..0b19b16dc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/basicFunction.md @@ -0,0 +1,21 @@ +# Function: basicFunction() + +```ts +function basicFunction(someParam: number): number +``` + +This is a function that is assigned to a variable. + +## See + +http://abc.com + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `someParam` | `number` | This is some numeric parameter. | + +## Returns + +`number` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/basicFunctionWithReturns.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/basicFunctionWithReturns.md new file mode 100644 index 000000000..31c5636af --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/basicFunctionWithReturns.md @@ -0,0 +1,13 @@ +# Function: basicFunctionWithReturns() + +```ts +function basicFunctionWithReturns(): number +``` + +This is a function that is assigned to a variable. + +## Returns + +`number` + +This is a return value diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/curriedFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/curriedFunction.md new file mode 100644 index 000000000..7ceff14d1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/curriedFunction.md @@ -0,0 +1,60 @@ +# Function: curriedFunction() + +Comments for main curriedFunction + +## Call Signature + +```ts +function curriedFunction(searchElement: unknown): (iterable: Iterable) => boolean +``` + +Comments for current function 1 + +### Parameters + +| Parameter | Type | +| :------ | :------ | +| `searchElement` | `unknown` | + +### Returns + +`Function` + +#### Type Parameters + +| Type Parameter | +| :------ | +| `Value` | + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `iterable` | `Iterable`\<`Value`, `any`, `any`\> | Comments for iterable arg | + +#### Returns + +`boolean` + +## Call Signature + +```ts +function curriedFunction(searchElement: unknown, iterable: Iterable): string +``` + +### Type Parameters + +| Type Parameter | +| :------ | +| `Value` | + +### Parameters + +| Parameter | Type | +| :------ | :------ | +| `searchElement` | `unknown` | +| `iterable` | `Iterable`\<`Value`, `any`, `any`\> | + +### Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAFunction.md new file mode 100644 index 000000000..a09a7012b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAFunction.md @@ -0,0 +1,27 @@ +# Function: functionReturningAFunction() + +```ts +function functionReturningAFunction(): (x: string) => boolean +``` + +Comments for function + +## Returns + +`Function` + +### Type Parameters + +| Type Parameter | +| :------ | +| `T` | + +### Parameters + +| Parameter | Type | +| :------ | :------ | +| `x` | `string` | + +### Returns + +`boolean` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAPromise.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAPromise.md new file mode 100644 index 000000000..3686ac7dd --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAPromise.md @@ -0,0 +1,23 @@ +# Function: functionReturningAPromise() + +```ts +function functionReturningAPromise(): Promise<{ + prop: string; +}> +``` + +Comments for function + +## Returns + +[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<\{ + `prop`: `string`; + \}\> + +Return comments + +### prop + +```ts +prop: string; +``` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAString.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAString.md new file mode 100644 index 000000000..60acf0eb1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAString.md @@ -0,0 +1,13 @@ +# Function: functionReturningAString() + +```ts +function functionReturningAString(): string +``` + +Comments for function + +## Returns + +`string` + +Return comments diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAUnionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAUnionType.md new file mode 100644 index 000000000..81fe79084 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAUnionType.md @@ -0,0 +1,13 @@ +# Function: functionReturningAUnionType() + +```ts +function functionReturningAUnionType(): string | boolean | "string1" | "string2" +``` + +Comments for function + +## Returns + +`string` \| `boolean` \| `"string1"` \| `"string2"` + +Return comments diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAnObject.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAnObject.md new file mode 100644 index 000000000..fe12bc4ce --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionReturningAnObject.md @@ -0,0 +1,33 @@ +# Function: functionReturningAnObject() + +```ts +function functionReturningAnObject(): { + x: number; + y: number; +} +``` + +Comments for function + +## Returns + +```ts +{ + x: number; + y: number; +} +``` + +Return comments + +### x + +```ts +x: number = 1; +``` + +### y + +```ts +y: number = 2; +``` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithArrayOfOptionalStuff.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithArrayOfOptionalStuff.md new file mode 100644 index 000000000..4a25a738d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithArrayOfOptionalStuff.md @@ -0,0 +1,17 @@ +# Function: functionWithArrayOfOptionalStuff() + +```ts +function functionWithArrayOfOptionalStuff(a: [Stuff?]): void +``` + +Comments for array of stuff? + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `a` | [[`Stuff`](../type-aliases/Stuff.md)?] | + +## Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithArrayOfStuff.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithArrayOfStuff.md new file mode 100644 index 000000000..2aa9a0b9e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithArrayOfStuff.md @@ -0,0 +1,17 @@ +# Function: functionWithArrayOfStuff() + +```ts +function functionWithArrayOfStuff(a: [Stuff]): void +``` + +Comments for array of stuff + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `a` | [[`Stuff`](../type-aliases/Stuff.md)] | + +## Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithComplexParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithComplexParams.md new file mode 100644 index 000000000..5d3071486 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithComplexParams.md @@ -0,0 +1,21 @@ +# Function: functionWithComplexParams() + +```ts +function functionWithComplexParams(paramA: (a: string) => true, paramB: { + x: 1; + }): boolean +``` + +Function with function parmas + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `paramA` | (`a`: `string`) => `true` | +| `paramB` | \{ `x`: `1`; \} | +| `paramB.x` | `1` | + +## Returns + +`boolean` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithDefaultParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithDefaultParameters.md new file mode 100644 index 000000000..cd6d7befd --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithDefaultParameters.md @@ -0,0 +1,28 @@ +# Function: functionWithDefaultParameters() + +```ts +function functionWithDefaultParameters( + valueA: string, + valueB: number, + valueC: number, + valueD: boolean, + valueE: boolean, + valueF: string): string +``` + +This is a function with a parameter that has a default value. + +## Parameters + +| Parameter | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `valueA` | `string` | `'defaultValue'` | A parameter with a default string value. | +| `valueB` | `number` | `100` | A parameter with a default numeric value. | +| `valueC` | `number` | `Number.NaN` | A parameter with a default NaN value. | +| `valueD` | `boolean` | `true` | A parameter with a default boolean value. | +| `valueE` | `boolean` | `true` | A parameter with a default null value. | +| `valueF` | `string` | `''` | - | + +## Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithMultipleSignatures.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithMultipleSignatures.md new file mode 100644 index 000000000..c26f3c1c2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithMultipleSignatures.md @@ -0,0 +1,42 @@ +# Function: functionWithMultipleSignatures() + +Main function comment. + +## Call Signature + +```ts +function functionWithMultipleSignatures(value: string): string +``` + +This is the first signature of a function with multiple signatures. + +### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `value` | `string` | The name value. | + +### Returns + +`string` + +## Call Signature + +```ts +function functionWithMultipleSignatures(value: { + name: string; + }): string +``` + +This is the second signature of a function with multiple signatures. + +### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `value` | \{ `name`: `string`; \} | An object containing the name value. | +| `value.name` | `string` | A value of the object. | + +### Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithNamedParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithNamedParams.md new file mode 100644 index 000000000..e62c83c97 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithNamedParams.md @@ -0,0 +1,21 @@ +# Function: functionWithNamedParams() + +```ts +function functionWithNamedParams(__namedParameters: { + bar: number; + foo: number; + }, anotherParam: string): void +``` + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `__namedParameters` | \{ `bar`: `number`; `foo`: `number`; \} | various options | +| `__namedParameters.bar`? | `number` | - | +| `__namedParameters.foo`? | `number` | - | +| `anotherParam` | `string` | Another param comment | + +## Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithNestedParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithNestedParameters.md new file mode 100644 index 000000000..e154da70d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithNestedParameters.md @@ -0,0 +1,39 @@ +# Function: functionWithNestedParameters() + +```ts +function functionWithNestedParameters( + params: { + name: string; + nestedObj: { + name: string; + obj: { + name: () => void; + }; + value: number; + }; + parent: number; + }, + context: any, + somethingElse?: string): boolean +``` + +Some nested params. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `params` | \{ `name`: `string`; `nestedObj`: \{ `name`: `string`; `obj`: \{ `name`: () => `void`; \}; `value`: `number`; \}; `parent`: `number`; \} | The parameters passed to the method. | +| `params.name` | `string` | The name of the new group. | +| `params.nestedObj` | \{ `name`: `string`; `obj`: \{ `name`: () => `void`; \}; `value`: `number`; \} | A nested object. | +| `params.nestedObj.name`? | `string` | - | +| `params.nestedObj.obj`? | \{ `name`: () => `void`; \} | - | +| `params.nestedObj.obj.name`? | () => `void` | - | +| `params.nestedObj.value`? | `number` | - | +| `params.parent`? | `number` | - | +| `context`? | `any` | The context of the method call. | +| `somethingElse`? | `string` | - | + +## Returns + +`boolean` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithOptionalParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithOptionalParameters.md new file mode 100644 index 000000000..ab1626d00 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithOptionalParameters.md @@ -0,0 +1,24 @@ +# Function: functionWithOptionalParameters() + +```ts +function functionWithOptionalParameters( + firstParamWithDefault: boolean, + requiredParam: string, + optionalParam?: string, + paramWithDefault?: number): void +``` + +This is a function with a parameters. + +## Parameters + +| Parameter | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `firstParamWithDefault` | `boolean` | `true` | - | +| `requiredParam` | `string` | `undefined` | A normal parameter. | +| `optionalParam`? | `string` | `undefined` | An optional parameter. | +| `paramWithDefault`? | `number` | `0` | - | + +## Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithRestParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithRestParams.md new file mode 100644 index 000000000..aaace837f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithRestParams.md @@ -0,0 +1,18 @@ +# Function: functionWithRestParams() + +```ts +function functionWithRestParams(param: string, ...restParams: string[]): boolean +``` + +Function with reset parmas + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `param` | `string` | +| ...`restParams` | `string`[] | + +## Returns + +`boolean` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithTypeParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithTypeParameters.md new file mode 100644 index 000000000..56d224ab7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithTypeParameters.md @@ -0,0 +1,18 @@ +# Function: functionWithTypeParameters() + +```ts +function functionWithTypeParameters(): boolean +``` + +Function with type parameters + +## Type Parameters + +| Type Parameter | Default type | Description | +| :------ | :------ | :------ | +| `T` | - | Comments for T | +| `Item` | `string` \| `boolean` | - | + +## Returns + +`boolean` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithUnionParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithUnionParams.md new file mode 100644 index 000000000..93522eacb --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/functions/functionWithUnionParams.md @@ -0,0 +1,30 @@ +# Function: functionWithUnionParams() + +```ts +function functionWithUnionParams( + primitiveUnions: string | number, + objectUnions: { + a: string; + b: 1; + }, + mixedUnions: string | { + a: string; + b: string; + }, + noUnions: string): undefined +``` + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `primitiveUnions` | `string` \| `number` | Comments for primitiveUnions | +| `objectUnions` | \{ `a`: `string`; `b`: `1`; \} | Comments for objectUnions | +| `objectUnions.a` | `string` | Comments for a | +| `objectUnions.b` | `1` | - | +| `mixedUnions` | `string` \| \{ `a`: `string`; `b`: `string`; \} | - | +| `noUnions` | `string` | Comments for noUnions | + +## Returns + +`undefined` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/globals.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/globals.md new file mode 100644 index 000000000..be02bee29 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/globals.md @@ -0,0 +1,103 @@ +# typedoc-stubs + +Module comments + +## Enumerations + +- [BasicEnum](enumerations/BasicEnum.md) +- [EnumWithValues](enumerations/EnumWithValues.md) + +## Classes + +- [AbstractClass](classes/AbstractClass.md) +- [BaseClass](classes/BaseClass.md) +- [BasicClass](classes/BasicClass.md) +- [CallbacksOptions](classes/CallbacksOptions.md) +- [ChildClassA](classes/ChildClassA.md) +- [ChildClassB](classes/ChildClassB.md) +- [ClassWithAccessorKeywords](classes/ClassWithAccessorKeywords.md) +- [ClassWithAccessors](classes/ClassWithAccessors.md) +- [ClassWithComplexProps](classes/ClassWithComplexProps.md) +- [ClassWithConstructorOverloads](classes/ClassWithConstructorOverloads.md) +- [ClassWithFlags](classes/ClassWithFlags.md) +- [ClassWithModifiers](classes/ClassWithModifiers.md) +- [ClassWithoutPropCategories](classes/ClassWithoutPropCategories.md) +- [ClassWithPropCategories](classes/ClassWithPropCategories.md) +- [ClassWithSimpleProps](classes/ClassWithSimpleProps.md) +- [ClassWithSymbols](classes/ClassWithSymbols.md) +- [ClassWithTypeParameters](classes/ClassWithTypeParameters.md) +- [DerivedClassA](classes/DerivedClassA.md) +- [DerivedClassB](classes/DerivedClassB.md) +- [DisposableClass](classes/DisposableClass.md) +- [GrandChildClassA](classes/GrandChildClassA.md) +- [GrandChildClassB](classes/GrandChildClassB.md) + +## Interfaces + +- [BasicInterface](interfaces/BasicInterface.md) +- [CustomEventInterface](interfaces/CustomEventInterface.md) +- [ExtendedInterface](interfaces/ExtendedInterface.md) +- [IndexableInterface](interfaces/IndexableInterface.md) +- [InterfaceWithComments](interfaces/InterfaceWithComments.md) +- [InterfaceWithEventProperties](interfaces/InterfaceWithEventProperties.md) +- [InterfaceWithFlags](interfaces/InterfaceWithFlags.md) +- [InterfaceWithTypeParameters](interfaces/InterfaceWithTypeParameters.md) +- [MultipleIndexableInterface](interfaces/MultipleIndexableInterface.md) + +## Type Aliases + +- [\_\_TypeDeclarationWithSpecialCharacters\_](type-aliases/TypeDeclarationWithSpecialCharacters.md) +- [ArrayOfStuff](type-aliases/ArrayOfStuff.md) +- [ArrayType](type-aliases/ArrayType.md) +- [ConditionalType](type-aliases/ConditionalType.md) +- [ExternalReferenceType](type-aliases/ExternalReferenceType.md) +- [FunctionType](type-aliases/FunctionType.md) +- [IndexAccessType](type-aliases/IndexAccessType.md) +- [IntersectionType](type-aliases/IntersectionType.md) +- [LiteralType](type-aliases/LiteralType.md) +- [PartialMappedType](type-aliases/PartialMappedType.md) +- [PrimitiveType](type-aliases/PrimitiveType.md) +- [PromiseTypeWithObject](type-aliases/PromiseTypeWithObject.md) +- [PromiseTypeWithSymbol](type-aliases/PromiseTypeWithSymbol.md) +- [QueryType](type-aliases/QueryType.md) +- [ReadonlyMappedType](type-aliases/ReadonlyMappedType.md) +- [StringLiteralType](type-aliases/StringLiteralType.md) +- [Stuff](type-aliases/Stuff.md) +- [TupleType](type-aliases/TupleType.md) +- [TypeWithExternalSymbolLinkMapping](type-aliases/TypeWithExternalSymbolLinkMapping.md) +- [TypeWithReturns](type-aliases/TypeWithReturns.md) +- [TypeWithTypeParams](type-aliases/TypeWithTypeParams.md) +- [UnionType](type-aliases/UnionType.md) +- [UnionTypeWithTemplateStrings](type-aliases/UnionTypeWithTemplateStrings.md) +- [UsefulUnionType](type-aliases/UsefulUnionType.md) + +## Variables + +- [objectLiteralVariable](variables/objectLiteralVariable.md) +- [objectWithSymbol](variables/objectWithSymbol.md) +- [someQuery](variables/someQuery.md) +- [stringVariable](variables/stringVariable.md) +- [templateVariableString](variables/templateVariableString.md) +- [typeOperatorVariable](variables/typeOperatorVariable.md) + +## Functions + +- [basicFunction](functions/basicFunction.md) +- [basicFunctionWithReturns](functions/basicFunctionWithReturns.md) +- [curriedFunction](functions/curriedFunction.md) +- [functionReturningAFunction](functions/functionReturningAFunction.md) +- [functionReturningAnObject](functions/functionReturningAnObject.md) +- [functionReturningAPromise](functions/functionReturningAPromise.md) +- [functionReturningAString](functions/functionReturningAString.md) +- [functionReturningAUnionType](functions/functionReturningAUnionType.md) +- [functionWithArrayOfOptionalStuff](functions/functionWithArrayOfOptionalStuff.md) +- [functionWithArrayOfStuff](functions/functionWithArrayOfStuff.md) +- [functionWithComplexParams](functions/functionWithComplexParams.md) +- [functionWithDefaultParameters](functions/functionWithDefaultParameters.md) +- [functionWithMultipleSignatures](functions/functionWithMultipleSignatures.md) +- [functionWithNamedParams](functions/functionWithNamedParams.md) +- [functionWithNestedParameters](functions/functionWithNestedParameters.md) +- [functionWithOptionalParameters](functions/functionWithOptionalParameters.md) +- [functionWithRestParams](functions/functionWithRestParams.md) +- [functionWithTypeParameters](functions/functionWithTypeParameters.md) +- [functionWithUnionParams](functions/functionWithUnionParams.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/BasicInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/BasicInterface.md new file mode 100644 index 000000000..ec78f8a12 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/BasicInterface.md @@ -0,0 +1,30 @@ +# Interface: BasicInterface + +Comments for BasicInterface + +## Extended by + +- [`ExtendedInterface`](ExtendedInterface.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| ~~`deprecatedProp`~~ | `string` | **Deprecated** This prop is deprecated **See** Comments for some tag | +| `functionProp` | (`s`: `string`) => `boolean` | Comments for functionProper | +| `optionalProp?` | `string` | Comments for optional prop | +| `prop` | `string` | Comments for prop | +| `propReturningObjectDeclaration` | \{ `a`: `boolean`; `b`: `string`; \} | Comments for propReturningObjectDeclaration | +| `propReturningObjectDeclaration.a` | `boolean` | - | +| `propReturningObjectDeclaration.b` | `string` | - | +| `propReturningObjectDeclarations` | \{ `a`: `boolean`; `b`: `string`; \} & \{ `c`: `boolean`; `d`: `string`; \} | Comments for propReturningObjectDeclarations | +| `propReturningSignatureDeclaration?` | () => `string` \| `number` \| `boolean` | Comments for propReturningSignatureDeclaration | +| `propReturningSignatureDeclarations` | () => `any` & (`paramsA`: `true` \| `any`[], `paramsB`?: `any`) => `any` & (`paramsC`: `any`) => `any` | Comments for propReturningSignatureDeclarations | +| `propWithFunction` | (`options`: \{ `a`: `boolean`; `b`: `string`; \}) => `boolean` | Comments for propWithFunction | +| `propWithProps` | \{ `callbacks`: `Partial`\<[`CallbacksOptions`](../classes/CallbacksOptions.md)\<[`DisposableClass`](../classes/DisposableClass.md), [`ClassWithModifiers`](../classes/ClassWithModifiers.md)\>\>; `nestedPropA`: `string`; `nestedPropB`: `boolean`; `nestedPropC`: \{ `nestedPropCA`: `string`; \}; `nestedPropD`: () => `boolean`; \} | Comments for propWithProps | +| `propWithProps.callbacks?` | `Partial`\<[`CallbacksOptions`](../classes/CallbacksOptions.md)\<[`DisposableClass`](../classes/DisposableClass.md), [`ClassWithModifiers`](../classes/ClassWithModifiers.md)\>\> | Comments for callbacks | +| `propWithProps.nestedPropA` | `string` | Comments for nestedPropA | +| `propWithProps.nestedPropB` | `boolean` | Comments for nestedPropB | +| `propWithProps.nestedPropC` | \{ `nestedPropCA`: `string`; \} | Comments for nestedPropC | +| `propWithProps.nestedPropC.nestedPropCA` | `string` | Comments for nestedPropCA | +| `propWithProps.nestedPropD` | () => `boolean` | Comments for nestedPropD | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/CustomEventInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/CustomEventInterface.md new file mode 100644 index 000000000..14e112071 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/CustomEventInterface.md @@ -0,0 +1,14 @@ +# Interface: CustomEventInterface\ + +## Type Parameters + +| Type Parameter | +| :------ | +| `T` | + +## Properties + +| Property | Type | +| :------ | :------ | +| `detail` | `string` | +| `target` | `T` | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/ExtendedInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/ExtendedInterface.md new file mode 100644 index 000000000..b85233f46 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/ExtendedInterface.md @@ -0,0 +1,31 @@ +# Interface: ExtendedInterface + +Comments for ExtendedInterface + +## Extends + +- [`BasicInterface`](BasicInterface.md) + +## Properties + +| Property | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | +| ~~`deprecatedProp`~~ | `string` | **Deprecated** This prop is deprecated **See** Comments for some tag | [`BasicInterface`](BasicInterface.md).`deprecatedProp` | +| `extendedProp` | `string` | - | - | +| `functionProp` | (`s`: `string`) => `boolean` | Comments for functionProper | [`BasicInterface`](BasicInterface.md).`functionProp` | +| `optionalProp?` | `string` | Comments for optional prop | [`BasicInterface`](BasicInterface.md).`optionalProp` | +| `prop` | `string` | Comments for prop | [`BasicInterface`](BasicInterface.md).`prop` | +| `propReturningObjectDeclaration` | \{ `a`: `boolean`; `b`: `string`; \} | Comments for propReturningObjectDeclaration | [`BasicInterface`](BasicInterface.md).`propReturningObjectDeclaration` | +| `propReturningObjectDeclaration.a` | `boolean` | - | - | +| `propReturningObjectDeclaration.b` | `string` | - | - | +| `propReturningObjectDeclarations` | \{ `a`: `boolean`; `b`: `string`; \} & \{ `c`: `boolean`; `d`: `string`; \} | Comments for propReturningObjectDeclarations | [`BasicInterface`](BasicInterface.md).`propReturningObjectDeclarations` | +| `propReturningSignatureDeclaration?` | () => `string` \| `number` \| `boolean` | Comments for propReturningSignatureDeclaration | [`BasicInterface`](BasicInterface.md).`propReturningSignatureDeclaration` | +| `propReturningSignatureDeclarations` | () => `any` & (`paramsA`: `true` \| `any`[], `paramsB`?: `any`) => `any` & (`paramsC`: `any`) => `any` | Comments for propReturningSignatureDeclarations | [`BasicInterface`](BasicInterface.md).`propReturningSignatureDeclarations` | +| `propWithFunction` | (`options`: \{ `a`: `boolean`; `b`: `string`; \}) => `boolean` | Comments for propWithFunction | [`BasicInterface`](BasicInterface.md).`propWithFunction` | +| `propWithProps` | \{ `callbacks`: `Partial`\<[`CallbacksOptions`](../classes/CallbacksOptions.md)\<[`DisposableClass`](../classes/DisposableClass.md), [`ClassWithModifiers`](../classes/ClassWithModifiers.md)\>\>; `nestedPropA`: `string`; `nestedPropB`: `boolean`; `nestedPropC`: \{ `nestedPropCA`: `string`; \}; `nestedPropD`: () => `boolean`; \} | Comments for propWithProps | [`BasicInterface`](BasicInterface.md).`propWithProps` | +| `propWithProps.callbacks?` | `Partial`\<[`CallbacksOptions`](../classes/CallbacksOptions.md)\<[`DisposableClass`](../classes/DisposableClass.md), [`ClassWithModifiers`](../classes/ClassWithModifiers.md)\>\> | Comments for callbacks | - | +| `propWithProps.nestedPropA` | `string` | Comments for nestedPropA | - | +| `propWithProps.nestedPropB` | `boolean` | Comments for nestedPropB | - | +| `propWithProps.nestedPropC` | \{ `nestedPropCA`: `string`; \} | Comments for nestedPropC | - | +| `propWithProps.nestedPropC.nestedPropCA` | `string` | Comments for nestedPropCA | - | +| `propWithProps.nestedPropD` | () => `boolean` | Comments for nestedPropD | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/IndexableInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/IndexableInterface.md new file mode 100644 index 000000000..f77b931b4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/IndexableInterface.md @@ -0,0 +1,13 @@ +# Interface: IndexableInterface + +Comments for IndexableInterface + +## Indexable + + \[`s`: `string`\]: `string` + +## Properties + +| Property | Type | +| :------ | :------ | +| `prop` | `string` | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/InterfaceWithComments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/InterfaceWithComments.md new file mode 100644 index 000000000..9a12c9c2a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/InterfaceWithComments.md @@ -0,0 +1,21 @@ +# Interface: InterfaceWithComments\ + +Comments for interface +over two lines + +And some more comments + +## Type Parameters + +| Type Parameter | Description | +| :------ | :------ | +| `A` | This is a parameter. | +| `B` | Comments for a parameter. This sentence is on a soft new line. | +| `C` | This is a parameter. Documentation with a double line | +| `D` |

These are comments with paras

These are comments with paras

Other comments Comments with

paras

These are comments with paras

| + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| ~~`propertyWithComments`~~ | `string` | Some text. - list item - list item **Deprecated** This is a deprecated property **See** https://example.com | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/InterfaceWithEventProperties.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/InterfaceWithEventProperties.md new file mode 100644 index 000000000..0c6231ab7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/InterfaceWithEventProperties.md @@ -0,0 +1,14 @@ +# Interface: InterfaceWithEventProperties + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `someProp?` | `boolean` | Description for prop someProp | + +## Events + +| Event | Type | Description | +| :------ | :------ | :------ | +| `anotherEvent` | `MouseEvent` | - | +| ~~`someEvent?`~~ | (`eventParam`: [`CustomEventInterface`](CustomEventInterface.md)\<`MouseEvent`\>) => `void` | Description for event someEvent **Deprecated** Deprectaed comments | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/InterfaceWithFlags.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/InterfaceWithFlags.md new file mode 100644 index 000000000..8606e3605 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/InterfaceWithFlags.md @@ -0,0 +1,10 @@ +# Interface: InterfaceWithFlags + +Comments for InterfaceWithFlags + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `expermintalProp?` | `string` | **`Experimental`** | +| `internalProp` | `string` | **`Internal`** Comments for internalProp | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/InterfaceWithTypeParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/InterfaceWithTypeParameters.md new file mode 100644 index 000000000..4b7dda8cc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/InterfaceWithTypeParameters.md @@ -0,0 +1,15 @@ +# Interface: InterfaceWithTypeParameters\ + +Comments for InterfaceWithTypeParameters + +## Type Parameters + +| Type Parameter | +| :------ | +| `A` | + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `prop` | `A` | Comments for prop | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/MultipleIndexableInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/MultipleIndexableInterface.md new file mode 100644 index 000000000..46750f398 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/interfaces/MultipleIndexableInterface.md @@ -0,0 +1,13 @@ +# Interface: MultipleIndexableInterface + +## Indexable + + \[`key`: `string`\]: `string` + + \[`index`: `number`\]: `string` + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `prop` | `string` | Prop | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ArrayOfStuff.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ArrayOfStuff.md new file mode 100644 index 000000000..17a8fad2c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ArrayOfStuff.md @@ -0,0 +1,8 @@ +# Type Alias: ArrayOfStuff + +```ts +type ArrayOfStuff: { + age: number; + name: string; + }[]; +``` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ArrayType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ArrayType.md new file mode 100644 index 000000000..f478dfd47 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ArrayType.md @@ -0,0 +1,7 @@ +# Type Alias: ArrayType + +```ts +type ArrayType: string[]; +``` + +Comments for ArrayType diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ConditionalType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ConditionalType.md new file mode 100644 index 000000000..76ca8c726 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ConditionalType.md @@ -0,0 +1,13 @@ +# Type Alias: ConditionalType\ + +```ts +type ConditionalType: T extends string ? "string" : T extends number ? "number" : T extends boolean ? "boolean" : T extends undefined ? "undefined" : "object"; +``` + +Comments for ConditionalType + +## Type Parameters + +| Type Parameter | +| :------ | +| `T` | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ExternalReferenceType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ExternalReferenceType.md new file mode 100644 index 000000000..36e6d512d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ExternalReferenceType.md @@ -0,0 +1,7 @@ +# Type Alias: ExternalReferenceType + +```ts +type ExternalReferenceType: ClassWithTypeParameters<"x", "y">; +``` + +Comments for ExternalReferenceType diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/FunctionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/FunctionType.md new file mode 100644 index 000000000..a8c40ac0c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/FunctionType.md @@ -0,0 +1,18 @@ +# Type Alias: FunctionType() + +```ts +type FunctionType: (name: string, value: unknown) => void; +``` + +Comments for FunctionType + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | +| `value` | `unknown` | + +## Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/IndexAccessType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/IndexAccessType.md new file mode 100644 index 000000000..28c65f5bf --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/IndexAccessType.md @@ -0,0 +1,7 @@ +# Type Alias: IndexAccessType + +```ts +type IndexAccessType: ArrayOfStuff[number]; +``` + +Comments for IndexAccessType diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/IntersectionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/IntersectionType.md new file mode 100644 index 000000000..2443d120f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/IntersectionType.md @@ -0,0 +1,17 @@ +# Type Alias: IntersectionType + +```ts +type IntersectionType: TupleType & ArrayType & { + bar: number; +}; +``` + +Comments for IntersectionType + +## Type declaration + +### bar + +```ts +bar: number; +``` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/LiteralType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/LiteralType.md new file mode 100644 index 000000000..38ae86e42 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/LiteralType.md @@ -0,0 +1,129 @@ +# Type Alias: LiteralType + +```ts +type LiteralType: { + someFunctionWithArrow: () => string; + x: string; + y: { + x: string; + y: boolean | string; + z: (x: string) => string; + }; + z: (x: string) => string; + get set accessorA: Promise; + get set accessorB: string; + someFunction: Promise; +}; +``` + +Comments for LiteralType + +## Type declaration + +### someFunctionWithArrow() + +```ts +() => string +``` + +Comments for someFunctionWithArrow + +### x? + +```ts +optional x: string; +``` + +comment for x + +### y + +```ts +{ + x: string; + y: boolean | string; + z: (x: string) => string; +} +``` + +comment for y + +### z() + +```ts +(x: string) => string +``` + +### accessorA + +#### Get Signature + +```ts +get accessorA(): Promise +``` + +Comments for accessorA getter + +##### Returns + +[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\> + +#### Set Signature + +```ts +set accessorA(x: Promise): void +``` + +Comments for accessorA setter + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `x` | [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\> | + +##### Returns + +`void` + +### accessorB + +#### Get Signature + +```ts +get accessorB(): string +``` + +##### Returns + +`string` + +#### Set Signature + +```ts +set accessorB(x: string): void +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `x` | `string` | + +##### Returns + +`void` + +### someFunction() + +Comments for someFunction + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `param` | `string` | | + +#### Returns + +[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/PartialMappedType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/PartialMappedType.md new file mode 100644 index 000000000..f57a209c4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/PartialMappedType.md @@ -0,0 +1,13 @@ +# Type Alias: PartialMappedType\ + +```ts +type PartialMappedType: { [P in keyof T]?: T[P] }; +``` + +Comments for PartialMappedType + +## Type Parameters + +| Type Parameter | +| :------ | +| `T` | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/PrimitiveType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/PrimitiveType.md new file mode 100644 index 000000000..d6e3d08c4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/PrimitiveType.md @@ -0,0 +1,7 @@ +# Type Alias: PrimitiveType + +```ts +type PrimitiveType: boolean; +``` + +Comments for PrimitiveType diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/PromiseTypeWithObject.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/PromiseTypeWithObject.md new file mode 100644 index 000000000..5cf240cd6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/PromiseTypeWithObject.md @@ -0,0 +1,19 @@ +# Type Alias: PromiseTypeWithObject + +```ts +type PromiseTypeWithObject: Promise<{ + x: 1; +}>; +``` + +Comments for promise type returning object + +## Type declaration + +### x + +```ts +x: 1; +``` + +comments for x diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/PromiseTypeWithSymbol.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/PromiseTypeWithSymbol.md new file mode 100644 index 000000000..3bc8996bb --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/PromiseTypeWithSymbol.md @@ -0,0 +1,7 @@ +# Type Alias: PromiseTypeWithSymbol + +```ts +type PromiseTypeWithSymbol: Promise; +``` + +Comments for promise type returning symbol diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/QueryType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/QueryType.md new file mode 100644 index 000000000..ca3589058 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/QueryType.md @@ -0,0 +1,7 @@ +# Type Alias: QueryType + +```ts +type QueryType: typeof someQuery; +``` + +Comments for query type diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ReadonlyMappedType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ReadonlyMappedType.md new file mode 100644 index 000000000..616a71bdf --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/ReadonlyMappedType.md @@ -0,0 +1,13 @@ +# Type Alias: ReadonlyMappedType\ + +```ts +type ReadonlyMappedType: { readonly [P in keyof T]: T[P] }; +``` + +Comments for ReadonlyMapedType + +## Type Parameters + +| Type Parameter | +| :------ | +| `T` | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/StringLiteralType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/StringLiteralType.md new file mode 100644 index 000000000..10ed6a911 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/StringLiteralType.md @@ -0,0 +1,13 @@ +# Type Alias: StringLiteralType + +```ts +type StringLiteralType: + | " " + | "string" + | "string|with|pipes" + | "string`with`backticks" + | "" + | "*"; +``` + +Comments for StringLiteralType diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/Stuff.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/Stuff.md new file mode 100644 index 000000000..bcd1caf3f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/Stuff.md @@ -0,0 +1,22 @@ +# Type Alias: Stuff + +```ts +type Stuff: { + a: string; + b: string; +}; +``` + +## Type declaration + +### a + +```ts +a: string; +``` + +### b + +```ts +b: string; +``` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TupleType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TupleType.md new file mode 100644 index 000000000..fbe13b952 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TupleType.md @@ -0,0 +1,7 @@ +# Type Alias: TupleType + +```ts +type TupleType: [string, number]; +``` + +Comments for TupleType diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TypeDeclarationWithSpecialCharacters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TypeDeclarationWithSpecialCharacters.md new file mode 100644 index 000000000..13294cf73 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TypeDeclarationWithSpecialCharacters.md @@ -0,0 +1,157 @@ +# Type Alias: \_\_TypeDeclarationWithSpecialCharacters\_\ + +```ts +type __TypeDeclarationWithSpecialCharacters_: { + _: "_"; + _foo_: "_foo_"; + _prop_with_underscore_: "_prop_with_underscore_"; + _x: (_param: T) => U; + ?: T | U; + {prop-with-brackets}: "{prop-with-brackets}"; + *: "*"; + **foo**: "**foo**"; + *foo*: "*foo*"; + \: "\"; + \a: "\a"; + \n: "\n"; + `: "`"; + `prop`with`backticks`: "`prop`with`backticks`"; + <: "<"; + : ""; + >: ">"; + |: "|"; + |prop|with|pipes|: "|prop|with|pipes|"; + ~: "~"; +}; +``` + +Comments for object with special characters + +## Type Parameters + +| Type Parameter | +| :------ | +| `T` | +| `U` | + +## Type declaration + +### \_ + +```ts +_: "_"; +``` + +### \_foo\_ + +```ts +_foo_: "_foo_"; +``` + +### \_prop\_with\_underscore\_ + +```ts +_prop_with_underscore_: "_prop_with_underscore_"; +``` + +### \_x() + +```ts +(_param: T) => U +``` + +### ? + +```ts +?: T | U; +``` + +### \{prop-with-brackets\} + +```ts +{prop-with-brackets}: "{prop-with-brackets}"; +``` + +### \* + +```ts +*: "*"; +``` + +### \*\*foo\*\* + +```ts +**foo**: "**foo**"; +``` + +### \*foo\* + +```ts +*foo*: "*foo*"; +``` + +### \ + +```ts +\: "\"; +``` + +### \a + +```ts +\a: "\a"; +``` + +### \n + +```ts +\n: "\n"; +``` + +### \` + +```ts +`: "`"; +``` + +### \`prop\`with\`backticks\` + +```ts +`prop`with`backticks`: "`prop`with`backticks`"; +``` + +### \< + +```ts +<: "<"; +``` + +### \ + +```ts +: ""; +``` + +### \> + +```ts +>: ">"; +``` + +### \| + +```ts +|: "|"; +``` + +### \|prop\|with\|pipes\| + +```ts +|prop|with|pipes|: "|prop|with|pipes|"; +``` + +### ~ + +```ts +~: "~"; +``` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TypeWithExternalSymbolLinkMapping.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TypeWithExternalSymbolLinkMapping.md new file mode 100644 index 000000000..1dbe5c15f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TypeWithExternalSymbolLinkMapping.md @@ -0,0 +1,7 @@ +# Type Alias: TypeWithExternalSymbolLinkMapping + +```ts +type TypeWithExternalSymbolLinkMapping: Application; +``` + +Comments for TypeWithExternalSymbolLinkMapping diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TypeWithReturns.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TypeWithReturns.md new file mode 100644 index 000000000..710c1c828 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TypeWithReturns.md @@ -0,0 +1,11 @@ +# Type Alias: TypeWithReturns + +```ts +type TypeWithReturns: string; +``` + +Comments for TypeWithReturns + +## Returns + +- return comments. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TypeWithTypeParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TypeWithTypeParams.md new file mode 100644 index 000000000..908a13f65 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/TypeWithTypeParams.md @@ -0,0 +1,14 @@ +# Type Alias: TypeWithTypeParams\ + +```ts +type TypeWithTypeParams: [T, R]; +``` + +Comments for TypeWithTypeParams + +## Type Parameters + +| Type Parameter | +| :------ | +| `T` | +| `R` | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/UnionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/UnionType.md new file mode 100644 index 000000000..f65fe111e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/UnionType.md @@ -0,0 +1,9 @@ +# Type Alias: UnionType + +```ts +type UnionType: string | boolean | { + z: string; +}; +``` + +Comments for UnionType diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/UnionTypeWithTemplateStrings.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/UnionTypeWithTemplateStrings.md new file mode 100644 index 000000000..7bd8d10bd --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/UnionTypeWithTemplateStrings.md @@ -0,0 +1,7 @@ +# Type Alias: UnionTypeWithTemplateStrings + +```ts +type UnionTypeWithTemplateStrings: `v${number}` | `v${number}.${number}` | `v${number}.${number}.${number}`; +``` + +Union with template strings diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/UsefulUnionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/UsefulUnionType.md new file mode 100644 index 000000000..83f21f2d1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/type-aliases/UsefulUnionType.md @@ -0,0 +1,27 @@ +# Type Alias: UsefulUnionType + +```ts +type UsefulUnionType: string | boolean | { + z: string; +}; +``` + +Comments for useful UnionType + +## Type declaration + +`string` + +`boolean` + +\{ + `z`: `string`; + \} + +### z + +```ts +z: string; +``` + +Comments for z diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/objectLiteralVariable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/objectLiteralVariable.md new file mode 100644 index 000000000..91feaeb83 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/objectLiteralVariable.md @@ -0,0 +1,68 @@ +# Variable: objectLiteralVariable + +```ts +const objectLiteralVariable: { + valueA: number; + valueB: boolean; + valueX: { + valueA: number[]; + valueY: (z: string) => { + a: string; + b: string; + c: { + a: number; + b: number; + }; + }; + valueZ: string; + }; + valueY: (unionParam: "a" | "b", _undercoreParam_: string) => string; +}; +``` + +Comments for objectLiteralVariable + +## See + +xyz.com + +## Type declaration + +### valueA + +```ts +valueA: number = 100; +``` + +Comments for valueA + +### valueB + +```ts +valueB: boolean = true; +``` + +### valueX + +```ts +{ + valueA: number[]; + valueY: (z: string) => { + a: string; + b: string; + c: { + a: number; + b: number; + }; + }; + valueZ: string; +} +``` + +Comments for valueX + +### valueY() + +```ts +(unionParam: "a" | "b", _undercoreParam_: string) => string +``` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/objectWithSymbol.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/objectWithSymbol.md new file mode 100644 index 000000000..002067864 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/objectWithSymbol.md @@ -0,0 +1,19 @@ +# Variable: objectWithSymbol + +```ts +const objectWithSymbol: { + [sym]: string; +}; +``` + +Comments variable with symbol + +## Type declaration + +### \[sym\] + +```ts +[sym]: string = 'value'; +``` + +Comments for symbol diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/someQuery.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/someQuery.md new file mode 100644 index 000000000..99f49ac06 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/someQuery.md @@ -0,0 +1,5 @@ +# Variable: someQuery + +```ts +const someQuery: 1 = 1; +``` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/stringVariable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/stringVariable.md new file mode 100644 index 000000000..6d56496c3 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/stringVariable.md @@ -0,0 +1,7 @@ +# Variable: stringVariable + +```ts +const stringVariable: "stringConstWithDefaultValue" = 'stringConstWithDefaultValue'; +``` + +A simple string variable diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/templateVariableString.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/templateVariableString.md new file mode 100644 index 000000000..f76f26a1e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/templateVariableString.md @@ -0,0 +1,7 @@ +# Variable: templateVariableString + +```ts +const templateVariableString: "\nThis is a template string\n/* with a comment */\nAnd a \n"; +``` + +A template variable string diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/typeOperatorVariable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/typeOperatorVariable.md new file mode 100644 index 000000000..39c6277ef --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/objectsAndParams/members/opts-2/variables/typeOperatorVariable.md @@ -0,0 +1,7 @@ +# Variable: typeOperatorVariable + +```ts +const typeOperatorVariable: unique symbol; +``` + +Comments for typeOperatorVariable diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/package/members/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/package/members/opts-1/README.md new file mode 100644 index 000000000..064181ad9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/package/members/opts-1/README.md @@ -0,0 +1,7 @@ +**@scope/package-1 v1.0.0** + +*** + +# PACKAGE 1 README + +Readme content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/package/members/opts-1/interfaces/PackageInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/package/members/opts-1/interfaces/PackageInterface.md new file mode 100644 index 000000000..023fa494b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/package/members/opts-1/interfaces/PackageInterface.md @@ -0,0 +1,13 @@ +[**@scope/package-1 v1.0.0**](../README.md) + +*** + +[@scope/package-1](../packages.md) / PackageInterface + +# Interface: PackageInterface + +## Properties + +### prop + +> **prop**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/package/members/opts-1/packages.md b/packages/typedoc-plugin-markdown/test/fixtures/out/package/members/opts-1/packages.md new file mode 100644 index 000000000..195b27d28 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/package/members/opts-1/packages.md @@ -0,0 +1,13 @@ +[**@scope/package-1 v1.0.0**](README.md) + +*** + +# @scope/package-1 v1.0.0 + +Comments for package-1 + +Some more comments for package-1 + +## Interfaces + +- [PackageInterface](interfaces/PackageInterface.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/package/members/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/package/members/opts-1/sidebar.json new file mode 100644 index 000000000..58e587466 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/package/members/opts-1/sidebar.json @@ -0,0 +1,12 @@ +[ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface", + "kind": 256, + "path": "interfaces/PackageInterface.md" + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/package/modules/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/package/modules/opts-1/README.md new file mode 100644 index 000000000..064181ad9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/package/modules/opts-1/README.md @@ -0,0 +1,7 @@ +**@scope/package-1 v1.0.0** + +*** + +# PACKAGE 1 README + +Readme content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/package/modules/opts-1/packages.md b/packages/typedoc-plugin-markdown/test/fixtures/out/package/modules/opts-1/packages.md new file mode 100644 index 000000000..0ef656267 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/package/modules/opts-1/packages.md @@ -0,0 +1,13 @@ +[**@scope/package-1 v1.0.0**](README.md) + +*** + +# @scope/package-1 v1.0.0 + +Comments for package-1 + +Some more comments for package-1 + +## Packages + +- [PackageInterface](packages.md#packageinterface) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/package/modules/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/package/modules/opts-1/sidebar.json new file mode 100644 index 000000000..0637a088a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/package/modules/opts-1/sidebar.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-1/globals.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-1/globals.md new file mode 100644 index 000000000..e5fede934 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-1/globals.md @@ -0,0 +1,15 @@ +[**@scope/package-1 v1.0.0**](index.md) + +*** + +[packages-example](../../packages.md) / @scope/package-1 + +# @scope/package-1 + +Comments for package-1 + +Some more comments for package-1 + +## Interfaces + +- [PackageInterface](interfaces/PackageInterface.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-1/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-1/index.md new file mode 100644 index 000000000..1f3b69eab --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-1/index.md @@ -0,0 +1,9 @@ +**@scope/package-1 v1.0.0** + +*** + +[packages-example](../../packages.md) / @scope/package-1 + +# PACKAGE 1 README + +Readme content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-1/interfaces/PackageInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-1/interfaces/PackageInterface.md new file mode 100644 index 000000000..7a495dbbc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-1/interfaces/PackageInterface.md @@ -0,0 +1,13 @@ +[**@scope/package-1 v1.0.0**](../index.md) + +*** + +[packages-example](../../../packages.md) / [@scope/package-1](../index.md) / PackageInterface + +# Interface: PackageInterface + +## Properties + +### prop + +> **prop**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/documents/Package-Document-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/documents/Package-Document-1.md new file mode 100644 index 000000000..1ccdf6d96 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/documents/Package-Document-1.md @@ -0,0 +1,9 @@ +[**@scope/package-3**](../index.md) + +*** + +[packages-example](../../../packages.md) / [@scope/package-3](../index.md) / Package Document 1 + +## Package Document 1 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/index.md new file mode 100644 index 000000000..70e220a3f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/index.md @@ -0,0 +1,17 @@ +**@scope/package-3** + +*** + +[packages-example](../../packages.md) / @scope/package-3 + +# @scope/package-3 + +## Documents + +- [Package Document 1](documents/Package-Document-1.md) + +## Modules + +- [index](index/index.md) +- [module-1](module-1/index.md) +- [module-2](module-2/index.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/index/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/index/index.md new file mode 100644 index 000000000..0fad01507 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/index/index.md @@ -0,0 +1,13 @@ +[**@scope/package-3**](../index.md) + +*** + +[packages-example](../../../packages.md) / [@scope/package-3](../index.md) / index + +# index + +## Index + +### Interfaces + +- [PackageInterfaceForIndexModule](interfaces/PackageInterfaceForIndexModule.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/index/interfaces/PackageInterfaceForIndexModule.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/index/interfaces/PackageInterfaceForIndexModule.md new file mode 100644 index 000000000..4c8febaa1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/index/interfaces/PackageInterfaceForIndexModule.md @@ -0,0 +1,7 @@ +[**@scope/package-3**](../../index.md) + +*** + +[packages-example](../../../../packages.md) / [@scope/package-3](../../index.md) / [index](../index.md) / PackageInterfaceForIndexModule + +# Interface: PackageInterfaceForIndexModule diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/module-1/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/module-1/index.md new file mode 100644 index 000000000..51db14202 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/module-1/index.md @@ -0,0 +1,13 @@ +[**@scope/package-3**](../index.md) + +*** + +[packages-example](../../../packages.md) / [@scope/package-3](../index.md) / module-1 + +# module-1 + +## Index + +### Interfaces + +- [PackageInterface1](interfaces/PackageInterface1.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/module-1/interfaces/PackageInterface1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/module-1/interfaces/PackageInterface1.md new file mode 100644 index 000000000..8b4ebf41e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/module-1/interfaces/PackageInterface1.md @@ -0,0 +1,7 @@ +[**@scope/package-3**](../../index.md) + +*** + +[packages-example](../../../../packages.md) / [@scope/package-3](../../index.md) / [module-1](../index.md) / PackageInterface1 + +# Interface: PackageInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/module-2/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/module-2/index.md new file mode 100644 index 000000000..999ee85b9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/module-2/index.md @@ -0,0 +1,13 @@ +[**@scope/package-3**](../index.md) + +*** + +[packages-example](../../../packages.md) / [@scope/package-3](../index.md) / module-2 + +# module-2 + +## Index + +### Interfaces + +- [PackageInterface2](interfaces/PackageInterface2.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/module-2/interfaces/PackageInterface2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/module-2/interfaces/PackageInterface2.md new file mode 100644 index 000000000..603c3f686 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/@scope/package-3/module-2/interfaces/PackageInterface2.md @@ -0,0 +1,7 @@ +[**@scope/package-3**](../../index.md) + +*** + +[packages-example](../../../../packages.md) / [@scope/package-3](../../index.md) / [module-2](../index.md) / PackageInterface2 + +# Interface: PackageInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/index.md new file mode 100644 index 000000000..1f19d2287 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/index.md @@ -0,0 +1,13 @@ +**packages-example** + +*** + +# MY README + +> Some block quote + +Some text. + +## Readme heading + +Some text. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-1b/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-1b/index.md new file mode 100644 index 000000000..28a7377d2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-1b/index.md @@ -0,0 +1,13 @@ +**package-1b** + +*** + +[packages-example](../packages.md) / package-1b + +# package-1b + +Comments for package-1b + +## Interfaces + +- [PackageInterface](interfaces/PackageInterface.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-1b/interfaces/PackageInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-1b/interfaces/PackageInterface.md new file mode 100644 index 000000000..c0017426e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-1b/interfaces/PackageInterface.md @@ -0,0 +1,13 @@ +[**package-1b**](../index.md) + +*** + +[packages-example](../../packages.md) / [package-1b](../index.md) / PackageInterface + +# Interface: PackageInterface + +## Properties + +### prop + +> **prop**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/index.md new file mode 100644 index 000000000..6b79e3b2d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/index.md @@ -0,0 +1,9 @@ +**package-2 v1.0.0** + +*** + +[packages-example](../packages.md) / package-2 + +# PACKAGE 2 README + +Readme content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/module-1/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/module-1/index.md new file mode 100644 index 000000000..c06b788c3 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/module-1/index.md @@ -0,0 +1,13 @@ +[**package-2 v1.0.0**](../index.md) + +*** + +[packages-example](../../packages.md) / [package-2](../index.md) / module-1 + +# module-1 + +## Index + +### Interfaces + +- [PackageInterface1](interfaces/PackageInterface1.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/module-1/interfaces/PackageInterface1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/module-1/interfaces/PackageInterface1.md new file mode 100644 index 000000000..7bbea8b77 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/module-1/interfaces/PackageInterface1.md @@ -0,0 +1,7 @@ +[**package-2 v1.0.0**](../../index.md) + +*** + +[packages-example](../../../packages.md) / [package-2](../../index.md) / [module-1](../index.md) / PackageInterface1 + +# Interface: PackageInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/module-2/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/module-2/index.md new file mode 100644 index 000000000..113e6ebc5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/module-2/index.md @@ -0,0 +1,13 @@ +[**package-2 v1.0.0**](../index.md) + +*** + +[packages-example](../../packages.md) / [package-2](../index.md) / module-2 + +# module-2 + +## Index + +### Interfaces + +- [PackageInterface2](interfaces/PackageInterface2.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/module-2/interfaces/PackageInterface2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/module-2/interfaces/PackageInterface2.md new file mode 100644 index 000000000..802abdd7b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/module-2/interfaces/PackageInterface2.md @@ -0,0 +1,7 @@ +[**package-2 v1.0.0**](../../index.md) + +*** + +[packages-example](../../../packages.md) / [package-2](../../index.md) / [module-2](../index.md) / PackageInterface2 + +# Interface: PackageInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/modules.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/modules.md new file mode 100644 index 000000000..432727173 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-2/modules.md @@ -0,0 +1,12 @@ +[**package-2 v1.0.0**](index.md) + +*** + +[packages-example](../packages.md) / package-2 + +# package-2 + +## Modules + +- [module-1](module-1/index.md) +- [module-2](module-2/index.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-4/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-4/index.md new file mode 100644 index 000000000..fba1f83f7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-4/index.md @@ -0,0 +1,11 @@ +**package-4** + +*** + +[packages-example](../packages.md) / package-4 + +# package-4 + +## Interfaces + +- [PackageInterface](interfaces/PackageInterface.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-4/interfaces/PackageInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-4/interfaces/PackageInterface.md new file mode 100644 index 000000000..4d2c4ffdf --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-4/interfaces/PackageInterface.md @@ -0,0 +1,7 @@ +[**package-4**](../index.md) + +*** + +[packages-example](../../packages.md) / [package-4](../index.md) / PackageInterface + +# Interface: PackageInterface diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-5/module1/interfaces/PackageInterface1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-5/module1/interfaces/PackageInterface1.md new file mode 100644 index 000000000..4171e4262 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-5/module1/interfaces/PackageInterface1.md @@ -0,0 +1,7 @@ +**package-5** + +*** + +[packages-example](../../../packages.md) / [package-5](../../package-5.md) / [module1](../../package-5.md) / PackageInterface1 + +# Interface: PackageInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-5/module2/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-5/module2/index.md new file mode 100644 index 000000000..2242e43e0 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-5/module2/index.md @@ -0,0 +1,13 @@ +**package-5** + +*** + +[packages-example](../../packages.md) / [package-5](../package-5.md) / module2 + +# module2 + +## Index + +### Interfaces + +- [PackageInterface2](interfaces/PackageInterface2.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-5/module2/interfaces/PackageInterface2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-5/module2/interfaces/PackageInterface2.md new file mode 100644 index 000000000..3ff2ea09e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-5/module2/interfaces/PackageInterface2.md @@ -0,0 +1,7 @@ +**package-5** + +*** + +[packages-example](../../../packages.md) / [package-5](../../package-5.md) / [module2](../index.md) / PackageInterface2 + +# Interface: PackageInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-5/package-5.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-5/package-5.md new file mode 100644 index 000000000..3bbc17f8b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-5/package-5.md @@ -0,0 +1,13 @@ +**package-5** + +*** + +[packages-example](../packages.md) / [package-5](package-5.md) / module1 + +# module1 + +## Index + +### Interfaces + +- [PackageInterface1](module1/interfaces/PackageInterface1.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-6.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-6.md new file mode 100644 index 000000000..de6d41a1f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-6.md @@ -0,0 +1,13 @@ +**package-6** + +*** + +[packages-example](packages.md) / [package-6](package-6.md) / module1 + +# module1 + +## Index + +### Interfaces + +- [PackageInterface1](package-6/module1/interfaces/PackageInterface1.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-6/module1/interfaces/PackageInterface1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-6/module1/interfaces/PackageInterface1.md new file mode 100644 index 000000000..c21812236 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-6/module1/interfaces/PackageInterface1.md @@ -0,0 +1,7 @@ +**package-6** + +*** + +[packages-example](../../../packages.md) / [package-6](../../../package-6.md) / [module1](../../../package-6.md) / PackageInterface1 + +# Interface: PackageInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-6/module2/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-6/module2/index.md new file mode 100644 index 000000000..2fab40815 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-6/module2/index.md @@ -0,0 +1,13 @@ +**package-6** + +*** + +[packages-example](../../packages.md) / [package-6](../../package-6.md) / module2 + +# module2 + +## Index + +### Interfaces + +- [PackageInterface2](interfaces/PackageInterface2.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-6/module2/interfaces/PackageInterface2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-6/module2/interfaces/PackageInterface2.md new file mode 100644 index 000000000..e953c528d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-6/module2/interfaces/PackageInterface2.md @@ -0,0 +1,7 @@ +**package-6** + +*** + +[packages-example](../../../packages.md) / [package-6](../../../package-6.md) / [module2](../index.md) / PackageInterface2 + +# Interface: PackageInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/index.md new file mode 100644 index 000000000..7b4c0d203 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/index.md @@ -0,0 +1,14 @@ +**package-7** + +*** + +[packages-example](../packages.md) / package-7 + +# package-7 + +## Modules + +- [module-1](module-1/index.md) +- [module-1/submodules/submodule-3-with-modules/nested-submodule-1](module-1/submodules/submodule-3-with-modules/nested-submodule-1/index.md) +- [module-1/submodules/submodule-3-with-modules/nested-submodule-2](module-1/submodules/submodule-3-with-modules/nested-submodule-2/index.md) +- [module-2](module-2/index.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/classes/ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/classes/ClassA.md new file mode 100644 index 000000000..6c27a7150 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/classes/ClassA.md @@ -0,0 +1,17 @@ +[**package-7**](../../index.md) + +*** + +[packages-example](../../../packages.md) / [package-7](../../index.md) / [module-1](../index.md) / ClassA + +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/classes/ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/classes/ClassB.md new file mode 100644 index 000000000..9c6768793 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/classes/ClassB.md @@ -0,0 +1,17 @@ +[**package-7**](../../index.md) + +*** + +[packages-example](../../../packages.md) / [package-7](../../index.md) / [module-1](../index.md) / ClassB + +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/index.md new file mode 100644 index 000000000..b6f76e4ab --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/index.md @@ -0,0 +1,14 @@ +[**package-7**](../index.md) + +*** + +[packages-example](../../packages.md) / [package-7](../index.md) / module-1 + +# module-1 + +## Index + +### Classes + +- [ClassA](classes/ClassA.md) +- [ClassB](classes/ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassA.md new file mode 100644 index 000000000..3fce84043 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassA.md @@ -0,0 +1,17 @@ +[**package-7**](../../../../../index.md) + +*** + +[packages-example](../../../../../../packages.md) / [package-7](../../../../../index.md) / [module-1/submodules/submodule-3-with-modules/nested-submodule-1](../index.md) / ClassA + +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassB.md new file mode 100644 index 000000000..fe8fed31d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassB.md @@ -0,0 +1,17 @@ +[**package-7**](../../../../../index.md) + +*** + +[packages-example](../../../../../../packages.md) / [package-7](../../../../../index.md) / [module-1/submodules/submodule-3-with-modules/nested-submodule-1](../index.md) / ClassB + +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/index.md new file mode 100644 index 000000000..8a0965052 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/index.md @@ -0,0 +1,14 @@ +[**package-7**](../../../../index.md) + +*** + +[packages-example](../../../../../packages.md) / [package-7](../../../../index.md) / module-1/submodules/submodule-3-with-modules/nested-submodule-1 + +# module-1/submodules/submodule-3-with-modules/nested-submodule-1 + +## Index + +### Classes + +- [ClassA](classes/ClassA.md) +- [ClassB](classes/ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassA.md new file mode 100644 index 000000000..b0bac19e7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassA.md @@ -0,0 +1,17 @@ +[**package-7**](../../../../../index.md) + +*** + +[packages-example](../../../../../../packages.md) / [package-7](../../../../../index.md) / [module-1/submodules/submodule-3-with-modules/nested-submodule-2](../index.md) / ClassA + +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassB.md new file mode 100644 index 000000000..07bc4806a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassB.md @@ -0,0 +1,17 @@ +[**package-7**](../../../../../index.md) + +*** + +[packages-example](../../../../../../packages.md) / [package-7](../../../../../index.md) / [module-1/submodules/submodule-3-with-modules/nested-submodule-2](../index.md) / ClassB + +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/index.md new file mode 100644 index 000000000..84f336a14 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/index.md @@ -0,0 +1,14 @@ +[**package-7**](../../../../index.md) + +*** + +[packages-example](../../../../../packages.md) / [package-7](../../../../index.md) / module-1/submodules/submodule-3-with-modules/nested-submodule-2 + +# module-1/submodules/submodule-3-with-modules/nested-submodule-2 + +## Index + +### Classes + +- [ClassA](classes/ClassA.md) +- [ClassB](classes/ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-2/classes/ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-2/classes/ClassA.md new file mode 100644 index 000000000..4809b37a6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-2/classes/ClassA.md @@ -0,0 +1,17 @@ +[**package-7**](../../index.md) + +*** + +[packages-example](../../../packages.md) / [package-7](../../index.md) / [module-2](../index.md) / ClassA + +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-2/classes/ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-2/classes/ClassB.md new file mode 100644 index 000000000..debeb1358 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-2/classes/ClassB.md @@ -0,0 +1,17 @@ +[**package-7**](../../index.md) + +*** + +[packages-example](../../../packages.md) / [package-7](../../index.md) / [module-2](../index.md) / ClassB + +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-2/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-2/index.md new file mode 100644 index 000000000..46843bb6c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/package-7/module-2/index.md @@ -0,0 +1,14 @@ +[**package-7**](../index.md) + +*** + +[packages-example](../../packages.md) / [package-7](../index.md) / module-2 + +# module-2 + +## Index + +### Classes + +- [ClassA](classes/ClassA.md) +- [ClassB](classes/ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/packages.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/packages.md new file mode 100644 index 000000000..cc1fd74ab --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/packages.md @@ -0,0 +1,16 @@ +[**packages-example**](index.md) + +*** + +# packages-example + +## Packages + +- [@scope/package-1 - v1.0.0](@scope/package-1/index.md) +- [@scope/package-3](@scope/package-3/index.md) +- [package-1b](package-1b/index.md) +- [package-2 - v1.0.0](package-2/index.md) +- [package-4](package-4/index.md) +- [package-5](package-5/package-5.md) +- [package-6](package-6.md) +- [package-7](package-7/index.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/sidebar.json new file mode 100644 index 000000000..6e5fc832c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-1/sidebar.json @@ -0,0 +1,305 @@ +[ + { + "title": "@scope/package-1", + "kind": 2, + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface", + "kind": 256, + "path": "@scope/package-1/interfaces/PackageInterface.md" + } + ] + } + ], + "path": "@scope/package-1/index.md" + }, + { + "title": "@scope/package-3", + "kind": 2, + "children": [ + { + "title": "index", + "kind": 2, + "path": "@scope/package-3/index/index.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterfaceForIndexModule", + "kind": 256, + "path": "@scope/package-3/index/interfaces/PackageInterfaceForIndexModule.md" + } + ] + } + ] + }, + { + "title": "module-1", + "kind": 2, + "path": "@scope/package-3/module-1/index.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface1", + "kind": 256, + "path": "@scope/package-3/module-1/interfaces/PackageInterface1.md" + } + ] + } + ] + }, + { + "title": "module-2", + "kind": 2, + "path": "@scope/package-3/module-2/index.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface2", + "kind": 256, + "path": "@scope/package-3/module-2/interfaces/PackageInterface2.md" + } + ] + } + ] + } + ], + "path": "@scope/package-3/index.md" + }, + { + "title": "package-1b", + "kind": 2, + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface", + "kind": 256, + "path": "package-1b/interfaces/PackageInterface.md" + } + ] + } + ], + "path": "package-1b/index.md" + }, + { + "title": "package-2", + "kind": 2, + "children": [ + { + "title": "module-1", + "kind": 2, + "path": "package-2/module-1/index.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface1", + "kind": 256, + "path": "package-2/module-1/interfaces/PackageInterface1.md" + } + ] + } + ] + }, + { + "title": "module-2", + "kind": 2, + "path": "package-2/module-2/index.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface2", + "kind": 256, + "path": "package-2/module-2/interfaces/PackageInterface2.md" + } + ] + } + ] + } + ], + "path": "package-2/index.md" + }, + { + "title": "package-4", + "kind": 2, + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface", + "kind": 256, + "path": "package-4/interfaces/PackageInterface.md" + } + ] + } + ], + "path": "package-4/index.md" + }, + { + "title": "package-5", + "kind": 2, + "children": [ + { + "title": "module2", + "kind": 2, + "path": "package-5/module2/index.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface2", + "kind": 256, + "path": "package-5/module2/interfaces/PackageInterface2.md" + } + ] + } + ] + } + ], + "path": "package-5/package-5.md" + }, + { + "title": "package-6", + "kind": 2, + "children": [ + { + "title": "module2", + "kind": 2, + "path": "package-6/module2/index.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface2", + "kind": 256, + "path": "package-6/module2/interfaces/PackageInterface2.md" + } + ] + } + ] + } + ], + "path": "package-6.md" + }, + { + "title": "package-7", + "kind": 2, + "children": [ + { + "title": "module-1", + "kind": 2, + "path": "package-7/module-1/index.md", + "children": [ + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "package-7/module-1/classes/ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "package-7/module-1/classes/ClassB.md" + } + ] + }, + { + "title": "submodules", + "children": [ + { + "title": "submodule-3-with-modules", + "children": [ + { + "title": "nested-submodule-1", + "kind": 2, + "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/index.md", + "children": [ + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassB.md" + } + ] + } + ] + }, + { + "title": "nested-submodule-2", + "kind": 2, + "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/index.md", + "children": [ + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassB.md" + } + ] + } + ] + } + ] + } + ] + } + ] + }, + { + "title": "module-2", + "kind": 2, + "path": "package-7/module-2/index.md", + "children": [ + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "package-7/module-2/classes/ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "package-7/module-2/classes/ClassB.md" + } + ] + } + ] + } + ], + "path": "package-7/index.md" + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/README.md new file mode 100644 index 000000000..3e5b25f50 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/README.md @@ -0,0 +1,26 @@ +**packages-example v0.0** + +*** + +# MY README + +> Some block quote + +Some text. + +## Readme heading + +Some text. + +## Packages + +| Name | Version | Description | +| :------ | :------ | :------ | +| [@scope/package-1](package-1/README.md) | 1.0.0 | Description for package-1 | +| [@scope/package-3](package-3/README.md) | - | Description for package 3 | +| [package-1b](package-1b/README.md) | - | - | +| [package-2](package-2/README.md) | 1.0.0 | - | +| [package-4](package-4/README.md) | - | - | +| [package-5](package-5/package-5.md) | - | - | +| [package-6](package-6.md) | - | - | +| [package-7](package-7/README.md) | - | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-1/README.md new file mode 100644 index 000000000..20bd1397f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-1/README.md @@ -0,0 +1,19 @@ +**@scope/package-1 v1.0.0** + +*** + +[packages-example](../README.md) / @scope/package-1 + +# PACKAGE 1 README + +Readme content + +Comments for package-1 + +Some more comments for package-1 + +## Interfaces + +| Interface | Description | +| :------ | :------ | +| [PackageInterface](interfaces/PackageInterface.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-1/interfaces/PackageInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-1/interfaces/PackageInterface.md new file mode 100644 index 000000000..eb2b5d3c8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-1/interfaces/PackageInterface.md @@ -0,0 +1,13 @@ +[**@scope/package-1 v1.0.0**](../README.md) + +*** + +[packages-example](../../README.md) / [@scope/package-1](../README.md) / PackageInterface + +# Interface: PackageInterface + +## Properties + +### prop + +> **prop**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-1b/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-1b/README.md new file mode 100644 index 000000000..deb974b3d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-1b/README.md @@ -0,0 +1,15 @@ +**package-1b** + +*** + +[packages-example](../README.md) / package-1b + +# package-1b + +Comments for package-1b + +## Interfaces + +| Interface | Description | +| :------ | :------ | +| [PackageInterface](interfaces/PackageInterface.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-1b/interfaces/PackageInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-1b/interfaces/PackageInterface.md new file mode 100644 index 000000000..e54fff94a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-1b/interfaces/PackageInterface.md @@ -0,0 +1,13 @@ +[**package-1b**](../README.md) + +*** + +[packages-example](../../README.md) / [package-1b](../README.md) / PackageInterface + +# Interface: PackageInterface + +## Properties + +### prop + +> **prop**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/README.md new file mode 100644 index 000000000..3a7a32fe9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/README.md @@ -0,0 +1,16 @@ +**package-2 v1.0.0** + +*** + +[packages-example](../README.md) / package-2 + +# PACKAGE 2 README + +Readme content + +## Modules + +| Module | Description | +| :------ | :------ | +| [module-1](module-1/README.md) | - | +| [module-2](module-2/README.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/module-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/module-1/README.md new file mode 100644 index 000000000..1c5690a10 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/module-1/README.md @@ -0,0 +1,15 @@ +[**package-2 v1.0.0**](../README.md) + +*** + +[packages-example](../../README.md) / [package-2](../README.md) / module-1 + +# module-1 + +## Index + +### Interfaces + +| Interface | Description | +| :------ | :------ | +| [PackageInterface1](interfaces/PackageInterface1.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/module-1/interfaces/PackageInterface1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/module-1/interfaces/PackageInterface1.md new file mode 100644 index 000000000..80339d20f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/module-1/interfaces/PackageInterface1.md @@ -0,0 +1,7 @@ +[**package-2 v1.0.0**](../../README.md) + +*** + +[packages-example](../../../README.md) / [package-2](../../README.md) / [module-1](../README.md) / PackageInterface1 + +# Interface: PackageInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/module-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/module-2/README.md new file mode 100644 index 000000000..ffe972334 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/module-2/README.md @@ -0,0 +1,15 @@ +[**package-2 v1.0.0**](../README.md) + +*** + +[packages-example](../../README.md) / [package-2](../README.md) / module-2 + +# module-2 + +## Index + +### Interfaces + +| Interface | Description | +| :------ | :------ | +| [PackageInterface2](interfaces/PackageInterface2.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/module-2/interfaces/PackageInterface2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/module-2/interfaces/PackageInterface2.md new file mode 100644 index 000000000..2b3bf29e8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-2/module-2/interfaces/PackageInterface2.md @@ -0,0 +1,7 @@ +[**package-2 v1.0.0**](../../README.md) + +*** + +[packages-example](../../../README.md) / [package-2](../../README.md) / [module-2](../README.md) / PackageInterface2 + +# Interface: PackageInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/README.md new file mode 100644 index 000000000..c2200be94 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/README.md @@ -0,0 +1,21 @@ +**@scope/package-3** + +*** + +[packages-example](../README.md) / @scope/package-3 + +# @scope/package-3 + +## Documents + +| Document | Description | +| :------ | :------ | +| [Package Document 1](documents/Package-Document-1.md) | A description of the document | + +## Modules + +| Module | Description | +| :------ | :------ | +| [index](index/README.md) | - | +| [module-1](module-1/README.md) | - | +| [module-2](module-2/README.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/documents/Package-Document-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/documents/Package-Document-1.md new file mode 100644 index 000000000..0442b3628 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/documents/Package-Document-1.md @@ -0,0 +1,9 @@ +[**@scope/package-3**](../README.md) + +*** + +[packages-example](../../README.md) / [@scope/package-3](../README.md) / Package Document 1 + +## Package Document 1 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/index/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/index/README.md new file mode 100644 index 000000000..df8297dce --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/index/README.md @@ -0,0 +1,15 @@ +[**@scope/package-3**](../README.md) + +*** + +[packages-example](../../README.md) / [@scope/package-3](../README.md) / index + +# index + +## Index + +### Interfaces + +| Interface | Description | +| :------ | :------ | +| [PackageInterfaceForIndexModule](interfaces/PackageInterfaceForIndexModule.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/index/interfaces/PackageInterfaceForIndexModule.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/index/interfaces/PackageInterfaceForIndexModule.md new file mode 100644 index 000000000..ab78f72af --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/index/interfaces/PackageInterfaceForIndexModule.md @@ -0,0 +1,7 @@ +[**@scope/package-3**](../../README.md) + +*** + +[packages-example](../../../README.md) / [@scope/package-3](../../README.md) / [index](../README.md) / PackageInterfaceForIndexModule + +# Interface: PackageInterfaceForIndexModule diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/module-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/module-1/README.md new file mode 100644 index 000000000..df50ca258 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/module-1/README.md @@ -0,0 +1,15 @@ +[**@scope/package-3**](../README.md) + +*** + +[packages-example](../../README.md) / [@scope/package-3](../README.md) / module-1 + +# module-1 + +## Index + +### Interfaces + +| Interface | Description | +| :------ | :------ | +| [PackageInterface1](interfaces/PackageInterface1.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/module-1/interfaces/PackageInterface1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/module-1/interfaces/PackageInterface1.md new file mode 100644 index 000000000..a59b0e362 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/module-1/interfaces/PackageInterface1.md @@ -0,0 +1,7 @@ +[**@scope/package-3**](../../README.md) + +*** + +[packages-example](../../../README.md) / [@scope/package-3](../../README.md) / [module-1](../README.md) / PackageInterface1 + +# Interface: PackageInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/module-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/module-2/README.md new file mode 100644 index 000000000..c8a758a63 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/module-2/README.md @@ -0,0 +1,15 @@ +[**@scope/package-3**](../README.md) + +*** + +[packages-example](../../README.md) / [@scope/package-3](../README.md) / module-2 + +# module-2 + +## Index + +### Interfaces + +| Interface | Description | +| :------ | :------ | +| [PackageInterface2](interfaces/PackageInterface2.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/module-2/interfaces/PackageInterface2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/module-2/interfaces/PackageInterface2.md new file mode 100644 index 000000000..f9526e126 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-3/module-2/interfaces/PackageInterface2.md @@ -0,0 +1,7 @@ +[**@scope/package-3**](../../README.md) + +*** + +[packages-example](../../../README.md) / [@scope/package-3](../../README.md) / [module-2](../README.md) / PackageInterface2 + +# Interface: PackageInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-4/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-4/README.md new file mode 100644 index 000000000..7b62b9fc9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-4/README.md @@ -0,0 +1,13 @@ +**package-4** + +*** + +[packages-example](../README.md) / package-4 + +# package-4 + +## Interfaces + +| Interface | Description | +| :------ | :------ | +| [PackageInterface](interfaces/PackageInterface.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-4/interfaces/PackageInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-4/interfaces/PackageInterface.md new file mode 100644 index 000000000..ff7593142 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-4/interfaces/PackageInterface.md @@ -0,0 +1,7 @@ +[**package-4**](../README.md) + +*** + +[packages-example](../../README.md) / [package-4](../README.md) / PackageInterface + +# Interface: PackageInterface diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-5/module1/interfaces/PackageInterface1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-5/module1/interfaces/PackageInterface1.md new file mode 100644 index 000000000..a51618267 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-5/module1/interfaces/PackageInterface1.md @@ -0,0 +1,7 @@ +**package-5** + +*** + +[packages-example](../../../README.md) / [package-5](../../package-5.md) / [module1](../../package-5.md) / PackageInterface1 + +# Interface: PackageInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-5/module2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-5/module2/README.md new file mode 100644 index 000000000..a364a25b5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-5/module2/README.md @@ -0,0 +1,15 @@ +**package-5** + +*** + +[packages-example](../../README.md) / [package-5](../package-5.md) / module2 + +# module2 + +## Index + +### Interfaces + +| Interface | Description | +| :------ | :------ | +| [PackageInterface2](interfaces/PackageInterface2.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-5/module2/interfaces/PackageInterface2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-5/module2/interfaces/PackageInterface2.md new file mode 100644 index 000000000..46ef928d8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-5/module2/interfaces/PackageInterface2.md @@ -0,0 +1,7 @@ +**package-5** + +*** + +[packages-example](../../../README.md) / [package-5](../../package-5.md) / [module2](../README.md) / PackageInterface2 + +# Interface: PackageInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-5/package-5.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-5/package-5.md new file mode 100644 index 000000000..84f2ee93f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-5/package-5.md @@ -0,0 +1,15 @@ +**package-5** + +*** + +[packages-example](../README.md) / [package-5](package-5.md) / module1 + +# module1 + +## Index + +### Interfaces + +| Interface | Description | +| :------ | :------ | +| [PackageInterface1](module1/interfaces/PackageInterface1.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-6.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-6.md new file mode 100644 index 000000000..7042092d2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-6.md @@ -0,0 +1,15 @@ +**package-6** + +*** + +[packages-example](README.md) / [package-6](package-6.md) / module1 + +# module1 + +## Index + +### Interfaces + +| Interface | Description | +| :------ | :------ | +| [PackageInterface1](package-6/module1/interfaces/PackageInterface1.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-6/module1/interfaces/PackageInterface1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-6/module1/interfaces/PackageInterface1.md new file mode 100644 index 000000000..8bceb489e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-6/module1/interfaces/PackageInterface1.md @@ -0,0 +1,7 @@ +**package-6** + +*** + +[packages-example](../../../README.md) / [package-6](../../../package-6.md) / [module1](../../../package-6.md) / PackageInterface1 + +# Interface: PackageInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-6/module2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-6/module2/README.md new file mode 100644 index 000000000..3c7d6c342 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-6/module2/README.md @@ -0,0 +1,15 @@ +**package-6** + +*** + +[packages-example](../../README.md) / [package-6](../../package-6.md) / module2 + +# module2 + +## Index + +### Interfaces + +| Interface | Description | +| :------ | :------ | +| [PackageInterface2](interfaces/PackageInterface2.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-6/module2/interfaces/PackageInterface2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-6/module2/interfaces/PackageInterface2.md new file mode 100644 index 000000000..44e2ab734 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-6/module2/interfaces/PackageInterface2.md @@ -0,0 +1,7 @@ +**package-6** + +*** + +[packages-example](../../../README.md) / [package-6](../../../package-6.md) / [module2](../README.md) / PackageInterface2 + +# Interface: PackageInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/README.md new file mode 100644 index 000000000..8273fcbe9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/README.md @@ -0,0 +1,16 @@ +**package-7** + +*** + +[packages-example](../README.md) / package-7 + +# package-7 + +## Modules + +| Module | Description | +| :------ | :------ | +| [module-1](module-1/README.md) | - | +| [module-1/submodules/submodule-3-with-modules/nested-submodule-1](module-1/submodules/submodule-3-with-modules/nested-submodule-1/README.md) | - | +| [module-1/submodules/submodule-3-with-modules/nested-submodule-2](module-1/submodules/submodule-3-with-modules/nested-submodule-2/README.md) | - | +| [module-2](module-2/README.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/README.md new file mode 100644 index 000000000..1c9c36926 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/README.md @@ -0,0 +1,16 @@ +[**package-7**](../README.md) + +*** + +[packages-example](../../README.md) / [package-7](../README.md) / module-1 + +# module-1 + +## Index + +### Classes + +| Class | Description | +| :------ | :------ | +| [ClassA](classes/ClassA.md) | - | +| [ClassB](classes/ClassB.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/classes/ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/classes/ClassA.md new file mode 100644 index 000000000..ee4ace6a3 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/classes/ClassA.md @@ -0,0 +1,17 @@ +[**package-7**](../../README.md) + +*** + +[packages-example](../../../README.md) / [package-7](../../README.md) / [module-1](../README.md) / ClassA + +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/classes/ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/classes/ClassB.md new file mode 100644 index 000000000..43c92dfb2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/classes/ClassB.md @@ -0,0 +1,17 @@ +[**package-7**](../../README.md) + +*** + +[packages-example](../../../README.md) / [package-7](../../README.md) / [module-1](../README.md) / ClassB + +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/README.md new file mode 100644 index 000000000..3c341a705 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/README.md @@ -0,0 +1,16 @@ +[**package-7**](../../../../README.md) + +*** + +[packages-example](../../../../../README.md) / [package-7](../../../../README.md) / module-1/submodules/submodule-3-with-modules/nested-submodule-1 + +# module-1/submodules/submodule-3-with-modules/nested-submodule-1 + +## Index + +### Classes + +| Class | Description | +| :------ | :------ | +| [ClassA](classes/ClassA.md) | - | +| [ClassB](classes/ClassB.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassA.md new file mode 100644 index 000000000..09b08e429 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassA.md @@ -0,0 +1,17 @@ +[**package-7**](../../../../../README.md) + +*** + +[packages-example](../../../../../../README.md) / [package-7](../../../../../README.md) / [module-1/submodules/submodule-3-with-modules/nested-submodule-1](../README.md) / ClassA + +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassB.md new file mode 100644 index 000000000..cc208694f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassB.md @@ -0,0 +1,17 @@ +[**package-7**](../../../../../README.md) + +*** + +[packages-example](../../../../../../README.md) / [package-7](../../../../../README.md) / [module-1/submodules/submodule-3-with-modules/nested-submodule-1](../README.md) / ClassB + +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/README.md new file mode 100644 index 000000000..0e70ae0fd --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/README.md @@ -0,0 +1,16 @@ +[**package-7**](../../../../README.md) + +*** + +[packages-example](../../../../../README.md) / [package-7](../../../../README.md) / module-1/submodules/submodule-3-with-modules/nested-submodule-2 + +# module-1/submodules/submodule-3-with-modules/nested-submodule-2 + +## Index + +### Classes + +| Class | Description | +| :------ | :------ | +| [ClassA](classes/ClassA.md) | - | +| [ClassB](classes/ClassB.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassA.md new file mode 100644 index 000000000..2c7f50d45 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassA.md @@ -0,0 +1,17 @@ +[**package-7**](../../../../../README.md) + +*** + +[packages-example](../../../../../../README.md) / [package-7](../../../../../README.md) / [module-1/submodules/submodule-3-with-modules/nested-submodule-2](../README.md) / ClassA + +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassB.md new file mode 100644 index 000000000..59beade4f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassB.md @@ -0,0 +1,17 @@ +[**package-7**](../../../../../README.md) + +*** + +[packages-example](../../../../../../README.md) / [package-7](../../../../../README.md) / [module-1/submodules/submodule-3-with-modules/nested-submodule-2](../README.md) / ClassB + +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-2/README.md new file mode 100644 index 000000000..7a2b23d3b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-2/README.md @@ -0,0 +1,16 @@ +[**package-7**](../README.md) + +*** + +[packages-example](../../README.md) / [package-7](../README.md) / module-2 + +# module-2 + +## Index + +### Classes + +| Class | Description | +| :------ | :------ | +| [ClassA](classes/ClassA.md) | - | +| [ClassB](classes/ClassB.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-2/classes/ClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-2/classes/ClassA.md new file mode 100644 index 000000000..d4e5406fc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-2/classes/ClassA.md @@ -0,0 +1,17 @@ +[**package-7**](../../README.md) + +*** + +[packages-example](../../../README.md) / [package-7](../../README.md) / [module-2](../README.md) / ClassA + +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-2/classes/ClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-2/classes/ClassB.md new file mode 100644 index 000000000..5581dc0f4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/package-7/module-2/classes/ClassB.md @@ -0,0 +1,17 @@ +[**package-7**](../../README.md) + +*** + +[packages-example](../../../README.md) / [package-7](../../README.md) / [module-2](../README.md) / ClassB + +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/sidebar.json new file mode 100644 index 000000000..08de248a5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/members/opts-2/sidebar.json @@ -0,0 +1,305 @@ +[ + { + "title": "@scope/package-1", + "kind": 2, + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface", + "kind": 256, + "path": "package-1/interfaces/PackageInterface.md" + } + ] + } + ], + "path": "package-1/README.md" + }, + { + "title": "@scope/package-3", + "kind": 2, + "children": [ + { + "title": "index", + "kind": 2, + "path": "package-3/index/README.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterfaceForIndexModule", + "kind": 256, + "path": "package-3/index/interfaces/PackageInterfaceForIndexModule.md" + } + ] + } + ] + }, + { + "title": "module-1", + "kind": 2, + "path": "package-3/module-1/README.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface1", + "kind": 256, + "path": "package-3/module-1/interfaces/PackageInterface1.md" + } + ] + } + ] + }, + { + "title": "module-2", + "kind": 2, + "path": "package-3/module-2/README.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface2", + "kind": 256, + "path": "package-3/module-2/interfaces/PackageInterface2.md" + } + ] + } + ] + } + ], + "path": "package-3/README.md" + }, + { + "title": "package-1b", + "kind": 2, + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface", + "kind": 256, + "path": "package-1b/interfaces/PackageInterface.md" + } + ] + } + ], + "path": "package-1b/README.md" + }, + { + "title": "package-2", + "kind": 2, + "children": [ + { + "title": "module-1", + "kind": 2, + "path": "package-2/module-1/README.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface1", + "kind": 256, + "path": "package-2/module-1/interfaces/PackageInterface1.md" + } + ] + } + ] + }, + { + "title": "module-2", + "kind": 2, + "path": "package-2/module-2/README.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface2", + "kind": 256, + "path": "package-2/module-2/interfaces/PackageInterface2.md" + } + ] + } + ] + } + ], + "path": "package-2/README.md" + }, + { + "title": "package-4", + "kind": 2, + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface", + "kind": 256, + "path": "package-4/interfaces/PackageInterface.md" + } + ] + } + ], + "path": "package-4/README.md" + }, + { + "title": "package-5", + "kind": 2, + "children": [ + { + "title": "module2", + "kind": 2, + "path": "package-5/module2/README.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface2", + "kind": 256, + "path": "package-5/module2/interfaces/PackageInterface2.md" + } + ] + } + ] + } + ], + "path": "package-5/package-5.md" + }, + { + "title": "package-6", + "kind": 2, + "children": [ + { + "title": "module2", + "kind": 2, + "path": "package-6/module2/README.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface2", + "kind": 256, + "path": "package-6/module2/interfaces/PackageInterface2.md" + } + ] + } + ] + } + ], + "path": "package-6.md" + }, + { + "title": "package-7", + "kind": 2, + "children": [ + { + "title": "module-1", + "kind": 2, + "path": "package-7/module-1/README.md", + "children": [ + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "package-7/module-1/classes/ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "package-7/module-1/classes/ClassB.md" + } + ] + }, + { + "title": "submodules", + "children": [ + { + "title": "submodule-3-with-modules", + "children": [ + { + "title": "nested-submodule-1", + "kind": 2, + "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/README.md", + "children": [ + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1/classes/ClassB.md" + } + ] + } + ] + }, + { + "title": "nested-submodule-2", + "kind": 2, + "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/README.md", + "children": [ + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2/classes/ClassB.md" + } + ] + } + ] + } + ] + } + ] + } + ] + }, + { + "title": "module-2", + "kind": 2, + "path": "package-7/module-2/README.md", + "children": [ + { + "title": "Classes", + "children": [ + { + "title": "ClassA", + "kind": 128, + "path": "package-7/module-2/classes/ClassA.md" + }, + { + "title": "ClassB", + "kind": 128, + "path": "package-7/module-2/classes/ClassB.md" + } + ] + } + ] + } + ], + "path": "package-7/README.md" + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-1/globals.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-1/globals.md new file mode 100644 index 000000000..70fca04fa --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-1/globals.md @@ -0,0 +1,21 @@ +[**@scope/package-1 v1.0.0**](index.md) + +*** + +[packages-example](../../packages.md) / @scope/package-1 + +# @scope/package-1 + +Comments for package-1 + +Some more comments for package-1 + +## Interfaces + +### PackageInterface + +#### Properties + +##### prop + +> **prop**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-1/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-1/index.md new file mode 100644 index 000000000..1f3b69eab --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-1/index.md @@ -0,0 +1,9 @@ +**@scope/package-1 v1.0.0** + +*** + +[packages-example](../../packages.md) / @scope/package-1 + +# PACKAGE 1 README + +Readme content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/documents/Package-Document-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/documents/Package-Document-1.md new file mode 100644 index 000000000..1ccdf6d96 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/documents/Package-Document-1.md @@ -0,0 +1,9 @@ +[**@scope/package-3**](../index.md) + +*** + +[packages-example](../../../packages.md) / [@scope/package-3](../index.md) / Package Document 1 + +## Package Document 1 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/index.md new file mode 100644 index 000000000..137ccb3fa --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/index.md @@ -0,0 +1,17 @@ +**@scope/package-3** + +*** + +[packages-example](../../packages.md) / @scope/package-3 + +# @scope/package-3 + +## Documents + +- [Package Document 1](documents/Package-Document-1.md) + +## Modules + +- [index](module_index.md) +- [module-1](module-1.md) +- [module-2](module-2.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/interfaces/PackageInterface1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/interfaces/PackageInterface1.md new file mode 100644 index 000000000..89c474a7b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/interfaces/PackageInterface1.md @@ -0,0 +1,7 @@ +[**@scope/package-3**](../index.md) + +*** + +[packages-example](../../../packages.md) / [@scope/package-3](../index.md) / [module-1](../module-1.md) / PackageInterface1 + +# Interface: PackageInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/interfaces/PackageInterface2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/interfaces/PackageInterface2.md new file mode 100644 index 000000000..77f4ad2b3 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/interfaces/PackageInterface2.md @@ -0,0 +1,7 @@ +[**@scope/package-3**](../index.md) + +*** + +[packages-example](../../../packages.md) / [@scope/package-3](../index.md) / [module-2](../module-2.md) / PackageInterface2 + +# Interface: PackageInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/interfaces/PackageInterfaceForIndexModule.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/interfaces/PackageInterfaceForIndexModule.md new file mode 100644 index 000000000..9ebadc6d9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/interfaces/PackageInterfaceForIndexModule.md @@ -0,0 +1,7 @@ +[**@scope/package-3**](../index.md) + +*** + +[packages-example](../../../packages.md) / [@scope/package-3](../index.md) / [index](../module_index.md) / PackageInterfaceForIndexModule + +# Interface: PackageInterfaceForIndexModule diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/module-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/module-1.md new file mode 100644 index 000000000..c3c48dcd5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/module-1.md @@ -0,0 +1,13 @@ +[**@scope/package-3**](index.md) + +*** + +[packages-example](../../packages.md) / [@scope/package-3](index.md) / module-1 + +# module-1 + +## Index + +### Interfaces + +- [PackageInterface1](interfaces/PackageInterface1.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/module-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/module-2.md new file mode 100644 index 000000000..e862bc535 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/module-2.md @@ -0,0 +1,13 @@ +[**@scope/package-3**](index.md) + +*** + +[packages-example](../../packages.md) / [@scope/package-3](index.md) / module-2 + +# module-2 + +## Index + +### Interfaces + +- [PackageInterface2](interfaces/PackageInterface2.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/module_index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/module_index.md new file mode 100644 index 000000000..abaeddec4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/@scope/package-3/module_index.md @@ -0,0 +1,13 @@ +[**@scope/package-3**](index.md) + +*** + +[packages-example](../../packages.md) / [@scope/package-3](index.md) / index + +# index + +## Index + +### Interfaces + +- [PackageInterfaceForIndexModule](interfaces/PackageInterfaceForIndexModule.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/index.md new file mode 100644 index 000000000..1f19d2287 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/index.md @@ -0,0 +1,13 @@ +**packages-example** + +*** + +# MY README + +> Some block quote + +Some text. + +## Readme heading + +Some text. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-1b/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-1b/index.md new file mode 100644 index 000000000..7d8763d3d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-1b/index.md @@ -0,0 +1,19 @@ +**package-1b** + +*** + +[packages-example](../packages.md) / package-1b + +# package-1b + +Comments for package-1b + +## Interfaces + +### PackageInterface + +#### Properties + +##### prop + +> **prop**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-2/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-2/index.md new file mode 100644 index 000000000..6b79e3b2d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-2/index.md @@ -0,0 +1,9 @@ +**package-2 v1.0.0** + +*** + +[packages-example](../packages.md) / package-2 + +# PACKAGE 2 README + +Readme content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-2/module-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-2/module-1.md new file mode 100644 index 000000000..175d77404 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-2/module-1.md @@ -0,0 +1,11 @@ +[**package-2 v1.0.0**](index.md) + +*** + +[packages-example](../packages.md) / [package-2](index.md) / module-1 + +# module-1 + +## Interfaces + +### PackageInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-2/module-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-2/module-2.md new file mode 100644 index 000000000..553eab820 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-2/module-2.md @@ -0,0 +1,11 @@ +[**package-2 v1.0.0**](index.md) + +*** + +[packages-example](../packages.md) / [package-2](index.md) / module-2 + +# module-2 + +## Interfaces + +### PackageInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-2/modules.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-2/modules.md new file mode 100644 index 000000000..c71f035b9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-2/modules.md @@ -0,0 +1,12 @@ +[**package-2 v1.0.0**](index.md) + +*** + +[packages-example](../packages.md) / package-2 + +# package-2 + +## Modules + +- [module-1](module-1.md) +- [module-2](module-2.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-4/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-4/index.md new file mode 100644 index 000000000..fba1f83f7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-4/index.md @@ -0,0 +1,11 @@ +**package-4** + +*** + +[packages-example](../packages.md) / package-4 + +# package-4 + +## Interfaces + +- [PackageInterface](interfaces/PackageInterface.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-4/interfaces/PackageInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-4/interfaces/PackageInterface.md new file mode 100644 index 000000000..4d2c4ffdf --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-4/interfaces/PackageInterface.md @@ -0,0 +1,7 @@ +[**package-4**](../index.md) + +*** + +[packages-example](../../packages.md) / [package-4](../index.md) / PackageInterface + +# Interface: PackageInterface diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-5/module2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-5/module2.md new file mode 100644 index 000000000..c022936a0 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-5/module2.md @@ -0,0 +1,11 @@ +**package-5** + +*** + +[packages-example](../packages.md) / [package-5](package-5.md) / module2 + +# module2 + +## Interfaces + +### PackageInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-5/package-5.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-5/package-5.md new file mode 100644 index 000000000..82df6ddc5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-5/package-5.md @@ -0,0 +1,11 @@ +**package-5** + +*** + +[packages-example](../packages.md) / [package-5](package-5.md) / module1 + +# module1 + +## Interfaces + +### PackageInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-6.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-6.md new file mode 100644 index 000000000..f4c1ea4f0 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-6.md @@ -0,0 +1,11 @@ +**package-6** + +*** + +[packages-example](packages.md) / [package-6](package-6.md) / module1 + +# module1 + +## Interfaces + +### PackageInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-6/module2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-6/module2.md new file mode 100644 index 000000000..673120ae2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-6/module2.md @@ -0,0 +1,11 @@ +**package-6** + +*** + +[packages-example](../packages.md) / [package-6](../package-6.md) / module2 + +# module2 + +## Interfaces + +### PackageInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/index.md new file mode 100644 index 000000000..fd843869a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/index.md @@ -0,0 +1,14 @@ +**package-7** + +*** + +[packages-example](../packages.md) / package-7 + +# package-7 + +## Modules + +- [module-1](module-1.md) +- [module-1/submodules/submodule-3-with-modules/nested-submodule-1](module-1/submodules/submodule-3-with-modules/nested-submodule-1.md) +- [module-1/submodules/submodule-3-with-modules/nested-submodule-2](module-1/submodules/submodule-3-with-modules/nested-submodule-2.md) +- [module-2](module-2.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/module-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/module-1.md new file mode 100644 index 000000000..ee0110509 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/module-1.md @@ -0,0 +1,35 @@ +[**package-7**](index.md) + +*** + +[packages-example](../packages.md) / [package-7](index.md) / module-1 + +# module-1 + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](module-1.md#classa) + +###### Returns + +[`ClassA`](module-1.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](module-1.md#classb) + +###### Returns + +[`ClassB`](module-1.md#classb) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1.md new file mode 100644 index 000000000..36d2a013d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1.md @@ -0,0 +1,35 @@ +[**package-7**](../../../index.md) + +*** + +[packages-example](../../../../packages.md) / [package-7](../../../index.md) / module-1/submodules/submodule-3-with-modules/nested-submodule-1 + +# module-1/submodules/submodule-3-with-modules/nested-submodule-1 + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](nested-submodule-1.md#classa) + +###### Returns + +[`ClassA`](nested-submodule-1.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](nested-submodule-1.md#classb) + +###### Returns + +[`ClassB`](nested-submodule-1.md#classb) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2.md new file mode 100644 index 000000000..04fb9e2a9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2.md @@ -0,0 +1,35 @@ +[**package-7**](../../../index.md) + +*** + +[packages-example](../../../../packages.md) / [package-7](../../../index.md) / module-1/submodules/submodule-3-with-modules/nested-submodule-2 + +# module-1/submodules/submodule-3-with-modules/nested-submodule-2 + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](nested-submodule-2.md#classa) + +###### Returns + +[`ClassA`](nested-submodule-2.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](nested-submodule-2.md#classb) + +###### Returns + +[`ClassB`](nested-submodule-2.md#classb) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/module-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/module-2.md new file mode 100644 index 000000000..7a58b345c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/package-7/module-2.md @@ -0,0 +1,35 @@ +[**package-7**](index.md) + +*** + +[packages-example](../packages.md) / [package-7](index.md) / module-2 + +# module-2 + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](module-2.md#classa) + +###### Returns + +[`ClassA`](module-2.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](module-2.md#classb) + +###### Returns + +[`ClassB`](module-2.md#classb) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/packages.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/packages.md new file mode 100644 index 000000000..cc1fd74ab --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/packages.md @@ -0,0 +1,16 @@ +[**packages-example**](index.md) + +*** + +# packages-example + +## Packages + +- [@scope/package-1 - v1.0.0](@scope/package-1/index.md) +- [@scope/package-3](@scope/package-3/index.md) +- [package-1b](package-1b/index.md) +- [package-2 - v1.0.0](package-2/index.md) +- [package-4](package-4/index.md) +- [package-5](package-5/package-5.md) +- [package-6](package-6.md) +- [package-7](package-7/index.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/sidebar.json new file mode 100644 index 000000000..67a52e12d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-1/sidebar.json @@ -0,0 +1,174 @@ +[ + { + "title": "@scope/package-1", + "kind": 2, + "children": [ + { + "title": "Globals", + "path": "@scope/package-1/globals.md", + "kind": 2 + } + ], + "path": "@scope/package-1/index.md" + }, + { + "title": "@scope/package-3", + "kind": 2, + "children": [ + { + "title": "index", + "kind": 2, + "path": "@scope/package-3/module_index.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterfaceForIndexModule", + "kind": 256, + "path": "@scope/package-3/interfaces/PackageInterfaceForIndexModule.md" + } + ] + } + ] + }, + { + "title": "module-1", + "kind": 2, + "path": "@scope/package-3/module-1.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface1", + "kind": 256, + "path": "@scope/package-3/interfaces/PackageInterface1.md" + } + ] + } + ] + }, + { + "title": "module-2", + "kind": 2, + "path": "@scope/package-3/module-2.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface2", + "kind": 256, + "path": "@scope/package-3/interfaces/PackageInterface2.md" + } + ] + } + ] + } + ], + "path": "@scope/package-3/index.md" + }, + { + "title": "package-1b", + "kind": 2, + "path": "package-1b/index.md" + }, + { + "title": "package-2", + "kind": 2, + "children": [ + { + "title": "module-1", + "kind": 2, + "path": "package-2/module-1.md" + }, + { + "title": "module-2", + "kind": 2, + "path": "package-2/module-2.md" + } + ], + "path": "package-2/index.md" + }, + { + "title": "package-4", + "kind": 2, + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface", + "kind": 256, + "path": "package-4/interfaces/PackageInterface.md" + } + ] + } + ], + "path": "package-4/index.md" + }, + { + "title": "package-5", + "kind": 2, + "children": [ + { + "title": "module2", + "kind": 2, + "path": "package-5/module2.md" + } + ], + "path": "package-5/package-5.md" + }, + { + "title": "package-6", + "kind": 2, + "children": [ + { + "title": "module2", + "kind": 2, + "path": "package-6/module2.md" + } + ], + "path": "package-6.md" + }, + { + "title": "package-7", + "kind": 2, + "children": [ + { + "title": "module-1", + "kind": 2, + "path": "package-7/module-1.md", + "children": [ + { + "title": "submodules", + "children": [ + { + "title": "submodule-3-with-modules", + "children": [ + { + "title": "nested-submodule-1", + "kind": 2, + "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1.md" + }, + { + "title": "nested-submodule-2", + "kind": 2, + "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2.md" + } + ] + } + ] + } + ] + }, + { + "title": "module-2", + "kind": 2, + "path": "package-7/module-2.md" + } + ], + "path": "package-7/index.md" + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/README.md new file mode 100644 index 000000000..3e5b25f50 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/README.md @@ -0,0 +1,26 @@ +**packages-example v0.0** + +*** + +# MY README + +> Some block quote + +Some text. + +## Readme heading + +Some text. + +## Packages + +| Name | Version | Description | +| :------ | :------ | :------ | +| [@scope/package-1](package-1/README.md) | 1.0.0 | Description for package-1 | +| [@scope/package-3](package-3/README.md) | - | Description for package 3 | +| [package-1b](package-1b/README.md) | - | - | +| [package-2](package-2/README.md) | 1.0.0 | - | +| [package-4](package-4/README.md) | - | - | +| [package-5](package-5/package-5.md) | - | - | +| [package-6](package-6.md) | - | - | +| [package-7](package-7/README.md) | - | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-1/README.md new file mode 100644 index 000000000..fea3b0a59 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-1/README.md @@ -0,0 +1,23 @@ +**@scope/package-1 v1.0.0** + +*** + +[packages-example](../README.md) / @scope/package-1 + +# PACKAGE 1 README + +Readme content + +Comments for package-1 + +Some more comments for package-1 + +## Interfaces + +### PackageInterface + +#### Properties + +##### prop + +> **prop**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-1b/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-1b/README.md new file mode 100644 index 000000000..2e7e731ae --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-1b/README.md @@ -0,0 +1,19 @@ +**package-1b** + +*** + +[packages-example](../README.md) / package-1b + +# package-1b + +Comments for package-1b + +## Interfaces + +### PackageInterface + +#### Properties + +##### prop + +> **prop**: `string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-2/README.md new file mode 100644 index 000000000..8c7725f4c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-2/README.md @@ -0,0 +1,16 @@ +**package-2 v1.0.0** + +*** + +[packages-example](../README.md) / package-2 + +# PACKAGE 2 README + +Readme content + +## Modules + +| Module | Description | +| :------ | :------ | +| [module-1](module-1.md) | - | +| [module-2](module-2.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-2/module-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-2/module-1.md new file mode 100644 index 000000000..e9c9f6206 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-2/module-1.md @@ -0,0 +1,11 @@ +[**package-2 v1.0.0**](README.md) + +*** + +[packages-example](../README.md) / [package-2](README.md) / module-1 + +# module-1 + +## Interfaces + +### PackageInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-2/module-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-2/module-2.md new file mode 100644 index 000000000..2bce61de7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-2/module-2.md @@ -0,0 +1,11 @@ +[**package-2 v1.0.0**](README.md) + +*** + +[packages-example](../README.md) / [package-2](README.md) / module-2 + +# module-2 + +## Interfaces + +### PackageInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/README.md new file mode 100644 index 000000000..abc35acf1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/README.md @@ -0,0 +1,21 @@ +**@scope/package-3** + +*** + +[packages-example](../README.md) / @scope/package-3 + +# @scope/package-3 + +## Documents + +| Document | Description | +| :------ | :------ | +| [Package Document 1](documents/Package-Document-1.md) | A description of the document | + +## Modules + +| Module | Description | +| :------ | :------ | +| [index](index.md) | - | +| [module-1](module-1.md) | - | +| [module-2](module-2.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/documents/Package-Document-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/documents/Package-Document-1.md new file mode 100644 index 000000000..0442b3628 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/documents/Package-Document-1.md @@ -0,0 +1,9 @@ +[**@scope/package-3**](../README.md) + +*** + +[packages-example](../../README.md) / [@scope/package-3](../README.md) / Package Document 1 + +## Package Document 1 + +Document content diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/index.md new file mode 100644 index 000000000..6a719c1fa --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/index.md @@ -0,0 +1,15 @@ +[**@scope/package-3**](README.md) + +*** + +[packages-example](../README.md) / [@scope/package-3](README.md) / index + +# index + +## Index + +### Interfaces + +| Interface | Description | +| :------ | :------ | +| [PackageInterfaceForIndexModule](interfaces/PackageInterfaceForIndexModule.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/interfaces/PackageInterface1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/interfaces/PackageInterface1.md new file mode 100644 index 000000000..0518482d9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/interfaces/PackageInterface1.md @@ -0,0 +1,7 @@ +[**@scope/package-3**](../README.md) + +*** + +[packages-example](../../README.md) / [@scope/package-3](../README.md) / [module-1](../module-1.md) / PackageInterface1 + +# Interface: PackageInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/interfaces/PackageInterface2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/interfaces/PackageInterface2.md new file mode 100644 index 000000000..11b58035a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/interfaces/PackageInterface2.md @@ -0,0 +1,7 @@ +[**@scope/package-3**](../README.md) + +*** + +[packages-example](../../README.md) / [@scope/package-3](../README.md) / [module-2](../module-2.md) / PackageInterface2 + +# Interface: PackageInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/interfaces/PackageInterfaceForIndexModule.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/interfaces/PackageInterfaceForIndexModule.md new file mode 100644 index 000000000..d8269453c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/interfaces/PackageInterfaceForIndexModule.md @@ -0,0 +1,7 @@ +[**@scope/package-3**](../README.md) + +*** + +[packages-example](../../README.md) / [@scope/package-3](../README.md) / [index](../index.md) / PackageInterfaceForIndexModule + +# Interface: PackageInterfaceForIndexModule diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/module-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/module-1.md new file mode 100644 index 000000000..8c46c79d2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/module-1.md @@ -0,0 +1,15 @@ +[**@scope/package-3**](README.md) + +*** + +[packages-example](../README.md) / [@scope/package-3](README.md) / module-1 + +# module-1 + +## Index + +### Interfaces + +| Interface | Description | +| :------ | :------ | +| [PackageInterface1](interfaces/PackageInterface1.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/module-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/module-2.md new file mode 100644 index 000000000..59c6a2967 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-3/module-2.md @@ -0,0 +1,15 @@ +[**@scope/package-3**](README.md) + +*** + +[packages-example](../README.md) / [@scope/package-3](README.md) / module-2 + +# module-2 + +## Index + +### Interfaces + +| Interface | Description | +| :------ | :------ | +| [PackageInterface2](interfaces/PackageInterface2.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-4/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-4/README.md new file mode 100644 index 000000000..7b62b9fc9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-4/README.md @@ -0,0 +1,13 @@ +**package-4** + +*** + +[packages-example](../README.md) / package-4 + +# package-4 + +## Interfaces + +| Interface | Description | +| :------ | :------ | +| [PackageInterface](interfaces/PackageInterface.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-4/interfaces/PackageInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-4/interfaces/PackageInterface.md new file mode 100644 index 000000000..ff7593142 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-4/interfaces/PackageInterface.md @@ -0,0 +1,7 @@ +[**package-4**](../README.md) + +*** + +[packages-example](../../README.md) / [package-4](../README.md) / PackageInterface + +# Interface: PackageInterface diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-5/module2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-5/module2.md new file mode 100644 index 000000000..cb6bb0a3a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-5/module2.md @@ -0,0 +1,11 @@ +**package-5** + +*** + +[packages-example](../README.md) / [package-5](package-5.md) / module2 + +# module2 + +## Interfaces + +### PackageInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-5/package-5.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-5/package-5.md new file mode 100644 index 000000000..212de8d63 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-5/package-5.md @@ -0,0 +1,11 @@ +**package-5** + +*** + +[packages-example](../README.md) / [package-5](package-5.md) / module1 + +# module1 + +## Interfaces + +### PackageInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-6.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-6.md new file mode 100644 index 000000000..b6bb2f874 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-6.md @@ -0,0 +1,11 @@ +**package-6** + +*** + +[packages-example](README.md) / [package-6](package-6.md) / module1 + +# module1 + +## Interfaces + +### PackageInterface1 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-6/module2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-6/module2.md new file mode 100644 index 000000000..0088c9bbb --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-6/module2.md @@ -0,0 +1,11 @@ +**package-6** + +*** + +[packages-example](../README.md) / [package-6](../package-6.md) / module2 + +# module2 + +## Interfaces + +### PackageInterface2 diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/README.md new file mode 100644 index 000000000..1bfad7a3f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/README.md @@ -0,0 +1,16 @@ +**package-7** + +*** + +[packages-example](../README.md) / package-7 + +# package-7 + +## Modules + +| Module | Description | +| :------ | :------ | +| [module-1](module-1.md) | - | +| [module-1/submodules/submodule-3-with-modules/nested-submodule-1](module-1/submodules/submodule-3-with-modules/nested-submodule-1.md) | - | +| [module-1/submodules/submodule-3-with-modules/nested-submodule-2](module-1/submodules/submodule-3-with-modules/nested-submodule-2.md) | - | +| [module-2](module-2.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/module-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/module-1.md new file mode 100644 index 000000000..d3a40d569 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/module-1.md @@ -0,0 +1,35 @@ +[**package-7**](README.md) + +*** + +[packages-example](../README.md) / [package-7](README.md) / module-1 + +# module-1 + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](module-1.md#classa) + +###### Returns + +[`ClassA`](module-1.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](module-1.md#classb) + +###### Returns + +[`ClassB`](module-1.md#classb) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1.md new file mode 100644 index 000000000..a9c3773d0 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1.md @@ -0,0 +1,35 @@ +[**package-7**](../../../README.md) + +*** + +[packages-example](../../../../README.md) / [package-7](../../../README.md) / module-1/submodules/submodule-3-with-modules/nested-submodule-1 + +# module-1/submodules/submodule-3-with-modules/nested-submodule-1 + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](nested-submodule-1.md#classa) + +###### Returns + +[`ClassA`](nested-submodule-1.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](nested-submodule-1.md#classb) + +###### Returns + +[`ClassB`](nested-submodule-1.md#classb) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2.md new file mode 100644 index 000000000..c9c8d3ca6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2.md @@ -0,0 +1,35 @@ +[**package-7**](../../../README.md) + +*** + +[packages-example](../../../../README.md) / [package-7](../../../README.md) / module-1/submodules/submodule-3-with-modules/nested-submodule-2 + +# module-1/submodules/submodule-3-with-modules/nested-submodule-2 + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](nested-submodule-2.md#classa) + +###### Returns + +[`ClassA`](nested-submodule-2.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](nested-submodule-2.md#classb) + +###### Returns + +[`ClassB`](nested-submodule-2.md#classb) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/module-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/module-2.md new file mode 100644 index 000000000..151f033b7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/package-7/module-2.md @@ -0,0 +1,35 @@ +[**package-7**](README.md) + +*** + +[packages-example](../README.md) / [package-7](README.md) / module-2 + +# module-2 + +## Classes + +### ClassA + +#### Constructors + +##### new ClassA() + +> **new ClassA**(): [`ClassA`](module-2.md#classa) + +###### Returns + +[`ClassA`](module-2.md#classa) + +*** + +### ClassB + +#### Constructors + +##### new ClassB() + +> **new ClassB**(): [`ClassB`](module-2.md#classb) + +###### Returns + +[`ClassB`](module-2.md#classb) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/sidebar.json new file mode 100644 index 000000000..526c29658 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/packages/modules/opts-2/sidebar.json @@ -0,0 +1,167 @@ +[ + { + "title": "@scope/package-1", + "kind": 2, + "path": "package-1/README.md" + }, + { + "title": "@scope/package-3", + "kind": 2, + "children": [ + { + "title": "index", + "kind": 2, + "path": "package-3/index.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterfaceForIndexModule", + "kind": 256, + "path": "package-3/interfaces/PackageInterfaceForIndexModule.md" + } + ] + } + ] + }, + { + "title": "module-1", + "kind": 2, + "path": "package-3/module-1.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface1", + "kind": 256, + "path": "package-3/interfaces/PackageInterface1.md" + } + ] + } + ] + }, + { + "title": "module-2", + "kind": 2, + "path": "package-3/module-2.md", + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface2", + "kind": 256, + "path": "package-3/interfaces/PackageInterface2.md" + } + ] + } + ] + } + ], + "path": "package-3/README.md" + }, + { + "title": "package-1b", + "kind": 2, + "path": "package-1b/README.md" + }, + { + "title": "package-2", + "kind": 2, + "children": [ + { + "title": "module-1", + "kind": 2, + "path": "package-2/module-1.md" + }, + { + "title": "module-2", + "kind": 2, + "path": "package-2/module-2.md" + } + ], + "path": "package-2/README.md" + }, + { + "title": "package-4", + "kind": 2, + "children": [ + { + "title": "Interfaces", + "children": [ + { + "title": "PackageInterface", + "kind": 256, + "path": "package-4/interfaces/PackageInterface.md" + } + ] + } + ], + "path": "package-4/README.md" + }, + { + "title": "package-5", + "kind": 2, + "children": [ + { + "title": "module2", + "kind": 2, + "path": "package-5/module2.md" + } + ], + "path": "package-5/package-5.md" + }, + { + "title": "package-6", + "kind": 2, + "children": [ + { + "title": "module2", + "kind": 2, + "path": "package-6/module2.md" + } + ], + "path": "package-6.md" + }, + { + "title": "package-7", + "kind": 2, + "children": [ + { + "title": "module-1", + "kind": 2, + "path": "package-7/module-1.md", + "children": [ + { + "title": "submodules", + "children": [ + { + "title": "submodule-3-with-modules", + "children": [ + { + "title": "nested-submodule-1", + "kind": 2, + "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-1.md" + }, + { + "title": "nested-submodule-2", + "kind": 2, + "path": "package-7/module-1/submodules/submodule-3-with-modules/nested-submodule-2.md" + } + ] + } + ] + } + ] + }, + { + "title": "module-2", + "kind": 2, + "path": "package-7/module-2.md" + } + ], + "path": "package-7/README.md" + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/readme/members/opts-1/functions/someFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/readme/members/opts-1/functions/someFunction.md new file mode 100644 index 000000000..e95f5895a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/readme/members/opts-1/functions/someFunction.md @@ -0,0 +1,13 @@ +[**typedoc-stubs v0.0**](../index.md) + +*** + +[typedoc-stubs](../index.md) / someFunction + +# Function: someFunction() + +> **someFunction**(): `void` + +## Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/readme/members/opts-1/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/readme/members/opts-1/index.md new file mode 100644 index 000000000..8da0b246f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/readme/members/opts-1/index.md @@ -0,0 +1,19 @@ +**typedoc-stubs v0.0** + +*** + +# MY README + +> Some block quote + +Some text. + +## Readme heading + +Some text. + +Module comments for documentation. + +## Functions + +- [someFunction](functions/someFunction.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/readme/members/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/readme/members/opts-1/sidebar.json new file mode 100644 index 000000000..4980abdda --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/readme/members/opts-1/sidebar.json @@ -0,0 +1,12 @@ +[ + { + "title": "Functions", + "children": [ + { + "title": "someFunction", + "kind": 64, + "path": "functions/someFunction.md" + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/readme/modules/opts-1/index.md b/packages/typedoc-plugin-markdown/test/fixtures/out/readme/modules/opts-1/index.md new file mode 100644 index 000000000..84d004152 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/readme/modules/opts-1/index.md @@ -0,0 +1,25 @@ +**typedoc-stubs v0.0** + +*** + +# MY README + +> Some block quote + +Some text. + +## Readme heading + +Some text. + +Module comments for documentation. + +## Functions + +### someFunction() + +> **someFunction**(): `void` + +#### Returns + +`void` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/readme/modules/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/readme/modules/opts-1/sidebar.json new file mode 100644 index 000000000..0637a088a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/readme/modules/opts-1/sidebar.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/README.md new file mode 100644 index 000000000..8bc10a451 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/README.md @@ -0,0 +1,9 @@ +# MY README + +> Some block quote + +Some text. + +## Readme heading + +Some text. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/AbstractClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/AbstractClass.md new file mode 100644 index 000000000..50d4403c0 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/AbstractClass.md @@ -0,0 +1,44 @@ +# Class: `abstract` AbstractClass + +## Extended by + +- [`DerivedClassA`](DerivedClassA.md) +- [`DerivedClassB`](DerivedClassB.md) + +## Constructors + +### new AbstractClass() + +> **new AbstractClass**(): [`AbstractClass`](AbstractClass.md) + +#### Returns + +[`AbstractClass`](AbstractClass.md) + +## Properties + +### abstractProp + +> `abstract` **abstractProp**: `string` + +Comments for abstractProp + +#### Source + +[classes.ts:1](http://source-url) + +## Methods + +### abstractMethod() + +> `abstract` **abstractMethod**(): `string` + +Comments for abstractMethod + +#### Returns + +`string` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/BaseClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/BaseClass.md new file mode 100644 index 000000000..83886bccf --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/BaseClass.md @@ -0,0 +1,16 @@ +# Class: BaseClass + +## Extended by + +- [`ChildClassA`](ChildClassA.md) +- [`ChildClassB`](ChildClassB.md) + +## Constructors + +### new BaseClass() + +> **new BaseClass**(): [`BaseClass`](BaseClass.md) + +#### Returns + +[`BaseClass`](BaseClass.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/BasicClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/BasicClass.md new file mode 100644 index 000000000..aa0b6ff2a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/BasicClass.md @@ -0,0 +1,41 @@ +# Class: BasicClass + +Comments for BasicClass + +## Constructors + +### new BasicClass() + +> **new BasicClass**(): [`BasicClass`](BasicClass.md) + +#### Returns + +[`BasicClass`](BasicClass.md) + +## Properties + +### prop + +> **prop**: `string` + +Comments for prop + +#### Source + +[classes.ts:1](http://source-url) + +## Methods + +### method() + +> **method**(): `string` + +Comments for method + +#### Returns + +`string` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/CallbacksOptions.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/CallbacksOptions.md new file mode 100644 index 000000000..7d06c159b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/CallbacksOptions.md @@ -0,0 +1,21 @@ +# Class: CallbacksOptions\ + +## Type Parameters + +### P + +Default type [`DisposableClass`](DisposableClass.md) + +### A + +Default type [`ClassWithModifiers`](ClassWithModifiers.md) + +## Constructors + +### new CallbacksOptions() + +> **new CallbacksOptions**\<`P`, `A`\>(): [`CallbacksOptions`](CallbacksOptions.md)\<`P`, `A`\> + +#### Returns + +[`CallbacksOptions`](CallbacksOptions.md)\<`P`, `A`\> diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ChildClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ChildClassA.md new file mode 100644 index 000000000..dd0691b76 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ChildClassA.md @@ -0,0 +1,24 @@ +# Class: ChildClassA + +## Extends + +- [`BaseClass`](BaseClass.md) + +## Extended by + +- [`GrandChildClassA`](GrandChildClassA.md) +- [`GrandChildClassB`](GrandChildClassB.md) + +## Constructors + +### new ChildClassA() + +> **new ChildClassA**(): [`ChildClassA`](ChildClassA.md) + +#### Returns + +[`ChildClassA`](ChildClassA.md) + +#### Inherited from + +[`BaseClass`](BaseClass.md).[`constructor`](BaseClass.md#constructors) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ChildClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ChildClassB.md new file mode 100644 index 000000000..df562ed1f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ChildClassB.md @@ -0,0 +1,19 @@ +# Class: ChildClassB + +## Extends + +- [`BaseClass`](BaseClass.md) + +## Constructors + +### new ChildClassB() + +> **new ChildClassB**(): [`ChildClassB`](ChildClassB.md) + +#### Returns + +[`ChildClassB`](ChildClassB.md) + +#### Inherited from + +[`BaseClass`](BaseClass.md).[`constructor`](BaseClass.md#constructors) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithAccessorKeywords.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithAccessorKeywords.md new file mode 100644 index 000000000..4de06ab28 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithAccessorKeywords.md @@ -0,0 +1,51 @@ +# Class: ClassWithAccessorKeywords + +## Constructors + +### new ClassWithAccessorKeywords() + +> **new ClassWithAccessorKeywords**(): [`ClassWithAccessorKeywords`](ClassWithAccessorKeywords.md) + +#### Returns + +[`ClassWithAccessorKeywords`](ClassWithAccessorKeywords.md) + +## Accessors + +### accessor1 + +Accessor comments + +#### Example + +```ts +const x = 1; +``` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### accessor2 + +Accessor comments + +#### Remarks + +Remark comments + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### accessor3 + +Accessor comments + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithAccessors.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithAccessors.md new file mode 100644 index 000000000..5cbabbcfe --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithAccessors.md @@ -0,0 +1,97 @@ +# Class: ClassWithAccessors + +Comments for ClassWithAccessors + +## Constructors + +### new ClassWithAccessors() + +> **new ClassWithAccessors**(): [`ClassWithAccessors`](ClassWithAccessors.md) + +#### Returns + +[`ClassWithAccessors`](ClassWithAccessors.md) + +## Properties + +### privateProp + +> `private` **privateProp**: `string` + +#### Source + +[classes.ts:1](http://source-url) + +## Accessors + +### accessor + +#### Get Signature + +> **get** **accessor**(): `string` + +Comments for getter + +##### Returns + +`string` + +#### Set Signature + +> **set** **accessor**(`value`): `void` + +Comments for setter + +##### Parameters + +###### value + +`string` + +Param comments + +##### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### noGetter + +#### Set Signature + +> **set** **noGetter**(`x`): `void` + +##### Parameters + +###### x + +`string` + +##### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### noSetter + +#### Get Signature + +> **get** **noSetter**(): `string` + +##### Returns + +`string` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithComplexProps.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithComplexProps.md new file mode 100644 index 000000000..db73b8681 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithComplexProps.md @@ -0,0 +1,45 @@ +# Class: ClassWithComplexProps + +Comments for ClassWithComplexProps + +## Constructors + +### new ClassWithComplexProps() + +> **new ClassWithComplexProps**(): [`ClassWithComplexProps`](ClassWithComplexProps.md) + +#### Returns + +[`ClassWithComplexProps`](ClassWithComplexProps.md) + +## Properties + +### objecLiteralProp + +> **objecLiteralProp**: `object` + +#### someFunction() + +> **someFunction**: (`a`) => `string` + +Comments for someFunction + +##### Parameters + +###### a + +`string` + +##### Returns + +`string` + +#### someProp + +> **someProp**: `string` = `'someProp'` + +Comments for someProp + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithConstructorOverloads.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithConstructorOverloads.md new file mode 100644 index 000000000..b76fb3d26 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithConstructorOverloads.md @@ -0,0 +1,67 @@ +# Class: ClassWithConstructorOverloads + +Comments for ClassWithConstructorOverloads + +## Constructors + +### new ClassWithConstructorOverloads() + +> **new ClassWithConstructorOverloads**(`x`, `y`): [`ClassWithConstructorOverloads`](ClassWithConstructorOverloads.md) + +#### Parameters + +##### x + +`number` + +Comments for x number + +##### y + +`string` + +#### Returns + +[`ClassWithConstructorOverloads`](ClassWithConstructorOverloads.md) + +#### Source + +[classes.ts:1](http://source-url) + +### new ClassWithConstructorOverloads() + +> **new ClassWithConstructorOverloads**(`x`): [`ClassWithConstructorOverloads`](ClassWithConstructorOverloads.md) + +#### Parameters + +##### x + +`string` + +Comments for x string + +#### Returns + +[`ClassWithConstructorOverloads`](ClassWithConstructorOverloads.md) + +#### Source + +[classes.ts:1](http://source-url) + +### new ClassWithConstructorOverloads() + +> **new ClassWithConstructorOverloads**(`s`): [`ClassWithConstructorOverloads`](ClassWithConstructorOverloads.md) + +#### Parameters + +##### s + +`string` + +#### Returns + +[`ClassWithConstructorOverloads`](ClassWithConstructorOverloads.md) + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithFlags.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithFlags.md new file mode 100644 index 000000000..0c8b4e872 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithFlags.md @@ -0,0 +1,69 @@ +# Class: ClassWithFlags + +Comment for ClassWithFlags + +## Constructors + +### new ClassWithFlags() + +> **new ClassWithFlags**(): [`ClassWithFlags`](ClassWithFlags.md) + +#### Returns + +[`ClassWithFlags`](ClassWithFlags.md) + +## Properties + +### expermintalProp + +> **expermintalProp**: `string` + +**`Experimental`** + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### internalProp + +> `private` **internalProp**: `string` + +**`Internal`** + +#### Source + +[classes.ts:1](http://source-url) + +## Methods + +### expermintalMethod() + +> **expermintalMethod**(): `void` + +**`Experimental`** + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### internalMethod() + +> `protected` **internalMethod**(): `void` + +**`Internal`** + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithModifiers.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithModifiers.md new file mode 100644 index 000000000..c5d846597 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithModifiers.md @@ -0,0 +1,121 @@ +# Class: `abstract` ClassWithModifiers + +Comments for ClassWithModifiers + +## Constructors + +### new ClassWithModifiers() + +> **new ClassWithModifiers**(): [`ClassWithModifiers`](ClassWithModifiers.md) + +#### Returns + +[`ClassWithModifiers`](ClassWithModifiers.md) + +## Properties + +### privateProp + +> `private` **privateProp**: `string` + +Comments for privateProp + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### protectedProp + +> `protected` **protectedProp**: `string` + +Comments for protectedProp + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### publicPropWithDefault + +> **publicPropWithDefault**: `string` = `'propWithDefault'` + +Comments for propWithDefault + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### readonlyProp + +> `readonly` **readonlyProp**: `string` + +Comments for abstractProperty + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### staticProp + +> `static` **staticProp**: `string` + +Comments for staticProp + +#### Source + +[classes.ts:1](http://source-url) + +## Methods + +### privateMethod() + +> `private` **privateMethod**(): `void` + +Comment for privateMethod + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### publicMethod() + +> **publicMethod**(): `void` + +Comment for publicMethod + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### staticMethod() + +> `static` **staticMethod**(): `void` + +Comment for staticMethod + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithPropCategories.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithPropCategories.md new file mode 100644 index 000000000..4acd19d10 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithPropCategories.md @@ -0,0 +1,75 @@ +# Class: ClassWithPropCategories + +## Constructors + +### new ClassWithPropCategories() + +> **new ClassWithPropCategories**(`opts`): [`ClassWithPropCategories`](ClassWithPropCategories.md) + +#### Parameters + +##### opts + +###### opts.a + +`string` + +###### opts.b + +`string` + +#### Returns + +[`ClassWithPropCategories`](ClassWithPropCategories.md) + +#### Source + +[classes.ts:1](http://source-url) + +## CatA + +### prop1 + +> **prop1**: `string` + +#### Source + +[classes.ts:1](http://source-url) + +## CatB + +### prop2 + +> **prop2**: `string` + +#### Source + +[classes.ts:1](http://source-url) + +## Other + +### method1() + +> **method1**(): `void` + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### method2() + +> **method2**(): `void` + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithSimpleProps.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithSimpleProps.md new file mode 100644 index 000000000..4d4489024 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithSimpleProps.md @@ -0,0 +1,74 @@ +# Class: ClassWithSimpleProps + +Comments for ClassWithSimpleProps + +## Constructors + +### new ClassWithSimpleProps() + +> **new ClassWithSimpleProps**(): [`ClassWithSimpleProps`](ClassWithSimpleProps.md) + +#### Returns + +[`ClassWithSimpleProps`](ClassWithSimpleProps.md) + +## Properties + +### propA + +> **propA**: `string` = `'propAValue'` + +Comments for propA + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### propB + +> **propB**: `string` = `'propBValue'` + +Comments for propB + +#### Default Value + +```ts +'propBDefaultValue' +``` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### propC + +> **propC**: `string` + +Comments for propB +on two lines + +#### Default Value + +```ts +'propCDefaultValue' +``` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### propD + +> **propD**: `string` + +Comments for propE + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithSymbols.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithSymbols.md new file mode 100644 index 000000000..205f768e2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithSymbols.md @@ -0,0 +1,39 @@ +# Class: ClassWithSymbols + +## Constructors + +### new ClassWithSymbols() + +> **new ClassWithSymbols**(): [`ClassWithSymbols`](ClassWithSymbols.md) + +#### Returns + +[`ClassWithSymbols`](ClassWithSymbols.md) + +## Properties + +### \[symbolConst\]()? + +> `static` `optional` **\[symbolConst\]**: () => `void` + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) + +## Methods + +### \[dispose\]() + +> **\[dispose\]**(): `void` + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithTypeParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithTypeParameters.md new file mode 100644 index 000000000..8bdb78021 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithTypeParameters.md @@ -0,0 +1,31 @@ +# Class: ClassWithTypeParameters\ + +Comments for ClassWithTypeParameters + +## Type Parameters + +### A + +\- + +### B + +*extends*: `string` + +Comments for param B + +### C + +Default type `boolean` + +Comments for param C + +## Constructors + +### new ClassWithTypeParameters() + +> **new ClassWithTypeParameters**\<`A`, `B`, `C`\>(): [`ClassWithTypeParameters`](ClassWithTypeParameters.md)\<`A`, `B`, `C`\> + +#### Returns + +[`ClassWithTypeParameters`](ClassWithTypeParameters.md)\<`A`, `B`, `C`\> diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithoutPropCategories.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithoutPropCategories.md new file mode 100644 index 000000000..ec817085d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/ClassWithoutPropCategories.md @@ -0,0 +1,75 @@ +# Class: ClassWithoutPropCategories + +## Constructors + +### new ClassWithoutPropCategories() + +> **new ClassWithoutPropCategories**(`opts`): [`ClassWithoutPropCategories`](ClassWithoutPropCategories.md) + +#### Parameters + +##### opts + +###### opts.a + +`string` + +###### opts.b + +`string` + +#### Returns + +[`ClassWithoutPropCategories`](ClassWithoutPropCategories.md) + +#### Source + +[classes.ts:1](http://source-url) + +## Properties + +### prop1 + +> **prop1**: `string` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### prop2 + +> **prop2**: `string` + +#### Source + +[classes.ts:1](http://source-url) + +## Methods + +### method1() + +> **method1**(): `void` + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### method2() + +> **method2**(): `void` + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/DerivedClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/DerivedClassA.md new file mode 100644 index 000000000..2b093f8b7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/DerivedClassA.md @@ -0,0 +1,81 @@ +# Class: DerivedClassA + +Comments for DerivedClassA + +## Extends + +- [`AbstractClass`](AbstractClass.md) + +## Constructors + +### new DerivedClassA() + +> **new DerivedClassA**(): [`DerivedClassA`](DerivedClassA.md) + +#### Returns + +[`DerivedClassA`](DerivedClassA.md) + +#### Inherited from + +[`AbstractClass`](AbstractClass.md).[`constructor`](AbstractClass.md#constructors) + +## Properties + +### abstractProp + +> **abstractProp**: `string` = `'abstractProp'` + +Comments for abstractProp + +#### Overrides + +[`AbstractClass`](AbstractClass.md).[`abstractProp`](AbstractClass.md#abstractprop) + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### derivedProp + +> **derivedProp**: `string` + +#### Source + +[classes.ts:1](http://source-url) + +## Methods + +### abstractMethod() + +> **abstractMethod**(): `string` + +Comments for abstractMethod + +#### Returns + +`string` + +#### Overrides + +[`AbstractClass`](AbstractClass.md).[`abstractMethod`](AbstractClass.md#abstractmethod) + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### derivedMethod() + +> **derivedMethod**(): `string` + +#### Returns + +`string` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/DerivedClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/DerivedClassB.md new file mode 100644 index 000000000..3f9625832 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/DerivedClassB.md @@ -0,0 +1,57 @@ +# Class: DerivedClassB + +Comments for DerivedClassB + +## Extends + +- [`AbstractClass`](AbstractClass.md) + +## Constructors + +### new DerivedClassB() + +> **new DerivedClassB**(): [`DerivedClassB`](DerivedClassB.md) + +#### Returns + +[`DerivedClassB`](DerivedClassB.md) + +#### Inherited from + +[`AbstractClass`](AbstractClass.md).[`constructor`](AbstractClass.md#constructors) + +## Properties + +### abstractProp + +> **abstractProp**: `string` = `'abstractProp'` + +Comments for abstractProp + +#### Overrides + +[`AbstractClass`](AbstractClass.md).[`abstractProp`](AbstractClass.md#abstractprop) + +#### Source + +[classes.ts:1](http://source-url) + +## Methods + +### abstractMethod() + +> **abstractMethod**(): `string` + +Comments for abstractMethod + +#### Returns + +`string` + +#### Overrides + +[`AbstractClass`](AbstractClass.md).[`abstractMethod`](AbstractClass.md#abstractmethod) + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/DisposableClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/DisposableClass.md new file mode 100644 index 000000000..af6343911 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/DisposableClass.md @@ -0,0 +1,33 @@ +# Class: DisposableClass + +## Implements + +- `Disposable` + +## Constructors + +### new DisposableClass() + +> **new DisposableClass**(): [`DisposableClass`](DisposableClass.md) + +#### Returns + +[`DisposableClass`](DisposableClass.md) + +## Methods + +### \[dispose\]() + +> **\[dispose\]**(): `void` + +#### Returns + +`void` + +#### Implementation of + +`Disposable.[dispose]` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/GrandChildClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/GrandChildClassA.md new file mode 100644 index 000000000..396946600 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/GrandChildClassA.md @@ -0,0 +1,19 @@ +# Class: GrandChildClassA + +## Extends + +- [`ChildClassA`](ChildClassA.md) + +## Constructors + +### new GrandChildClassA() + +> **new GrandChildClassA**(): [`GrandChildClassA`](GrandChildClassA.md) + +#### Returns + +[`GrandChildClassA`](GrandChildClassA.md) + +#### Inherited from + +[`ChildClassA`](ChildClassA.md).[`constructor`](ChildClassA.md#constructors) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/GrandChildClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/GrandChildClassB.md new file mode 100644 index 000000000..0090154b1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/classes/GrandChildClassB.md @@ -0,0 +1,19 @@ +# Class: GrandChildClassB + +## Extends + +- [`ChildClassA`](ChildClassA.md) + +## Constructors + +### new GrandChildClassB() + +> **new GrandChildClassB**(): [`GrandChildClassB`](GrandChildClassB.md) + +#### Returns + +[`GrandChildClassB`](GrandChildClassB.md) + +#### Inherited from + +[`ChildClassA`](ChildClassA.md).[`constructor`](ChildClassA.md#constructors) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/enumerations/BasicEnum.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/enumerations/BasicEnum.md new file mode 100644 index 000000000..3610c3a48 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/enumerations/BasicEnum.md @@ -0,0 +1,27 @@ +# Enumeration: BasicEnum + +Comments for enum + +## Enumeration Members + +### MemberA + +> **MemberA**: `0` + +Comments for MemberA + +#### Source + +[enums.ts:1](http://source-url) + +*** + +### MemberB + +> **MemberB**: `1` + +Comments for MemberB + +#### Source + +[enums.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/enumerations/EnumWithValues.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/enumerations/EnumWithValues.md new file mode 100644 index 000000000..b90ae5343 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/enumerations/EnumWithValues.md @@ -0,0 +1,23 @@ +# Enumeration: EnumWithValues + +Comments for enum + +## Enumeration Members + +### MemberA + +> **MemberA**: `"UP"` + +#### Source + +[enums.ts:1](http://source-url) + +*** + +### MemberB + +> **MemberB**: `"DOWN"` + +#### Source + +[enums.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/basicFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/basicFunction.md new file mode 100644 index 000000000..66dbd74ee --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/basicFunction.md @@ -0,0 +1,25 @@ +# Function: basicFunction() + +> **basicFunction**(`someParam`): `number` + +This is a function that is assigned to a variable. + +## See + +http://abc.com + +## Parameters + +### someParam + +`number` + +This is some numeric parameter. + +## Returns + +`number` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/basicFunctionWithReturns.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/basicFunctionWithReturns.md new file mode 100644 index 000000000..a411ecfc7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/basicFunctionWithReturns.md @@ -0,0 +1,15 @@ +# Function: basicFunctionWithReturns() + +> **basicFunctionWithReturns**(): `number` + +This is a function that is assigned to a variable. + +## Returns + +`number` + +This is a return value + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/curriedFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/curriedFunction.md new file mode 100644 index 000000000..2e8025381 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/curriedFunction.md @@ -0,0 +1,69 @@ +# Function: curriedFunction() + +Comments for main curriedFunction + +## Call Signature + +> **curriedFunction**(`searchElement`): \<`Value`\>(`iterable`) => `boolean` + +Comments for current function 1 + +### Parameters + +#### searchElement + +`unknown` + +### Returns + +`Function` + +#### Type Parameters + +##### Value + +\- + +#### Parameters + +##### iterable + +`Iterable`\<`Value`, `any`, `any`\> + +Comments for iterable arg + +#### Returns + +`boolean` + +### Source + +[functions.ts:1](http://source-url) + +## Call Signature + +> **curriedFunction**\<`Value`\>(`searchElement`, `iterable`): `string` + +### Type Parameters + +#### Value + +\- + +### Parameters + +#### searchElement + +`unknown` + +#### iterable + +`Iterable`\<`Value`, `any`, `any`\> + +### Returns + +`string` + +### Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAFunction.md new file mode 100644 index 000000000..ac56f8c11 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAFunction.md @@ -0,0 +1,29 @@ +# Function: functionReturningAFunction() + +> **functionReturningAFunction**(): \<`T`\>(`x`) => `boolean` + +Comments for function + +## Returns + +`Function` + +### Type Parameters + +#### T + +\- + +### Parameters + +#### x + +`string` + +### Returns + +`boolean` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAPromise.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAPromise.md new file mode 100644 index 000000000..0854f0fcd --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAPromise.md @@ -0,0 +1,19 @@ +# Function: functionReturningAPromise() + +> **functionReturningAPromise**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`object`\> + +Comments for function + +## Returns + +[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`object`\> + +Return comments + +### prop + +> **prop**: `string` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAString.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAString.md new file mode 100644 index 000000000..52d0423c1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAString.md @@ -0,0 +1,15 @@ +# Function: functionReturningAString() + +> **functionReturningAString**(): `string` + +Comments for function + +## Returns + +`string` + +Return comments + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAUnionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAUnionType.md new file mode 100644 index 000000000..7e1220a40 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAUnionType.md @@ -0,0 +1,15 @@ +# Function: functionReturningAUnionType() + +> **functionReturningAUnionType**(): `string` \| `boolean` \| `"string1"` \| `"string2"` + +Comments for function + +## Returns + +`string` \| `boolean` \| `"string1"` \| `"string2"` + +Return comments + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAnObject.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAnObject.md new file mode 100644 index 000000000..85914d7e6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionReturningAnObject.md @@ -0,0 +1,23 @@ +# Function: functionReturningAnObject() + +> **functionReturningAnObject**(): `object` + +Comments for function + +## Returns + +`object` + +Return comments + +### x + +> **x**: `number` = `1` + +### y + +> **y**: `number` = `2` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithArrayOfOptionalStuff.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithArrayOfOptionalStuff.md new file mode 100644 index 000000000..990a7eee6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithArrayOfOptionalStuff.md @@ -0,0 +1,19 @@ +# Function: functionWithArrayOfOptionalStuff() + +> **functionWithArrayOfOptionalStuff**(`a`): `void` + +Comments for array of stuff? + +## Parameters + +### a + +[[`Stuff`](../type-aliases/Stuff.md)?] + +## Returns + +`void` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithArrayOfStuff.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithArrayOfStuff.md new file mode 100644 index 000000000..5cf8be1f3 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithArrayOfStuff.md @@ -0,0 +1,19 @@ +# Function: functionWithArrayOfStuff() + +> **functionWithArrayOfStuff**(`a`): `void` + +Comments for array of stuff + +## Parameters + +### a + +[[`Stuff`](../type-aliases/Stuff.md)] + +## Returns + +`void` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithComplexParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithComplexParams.md new file mode 100644 index 000000000..cbe12fed8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithComplexParams.md @@ -0,0 +1,25 @@ +# Function: functionWithComplexParams() + +> **functionWithComplexParams**(`paramA`, `paramB`): `boolean` + +Function with function parmas + +## Parameters + +### paramA + +(`a`) => `true` + +### paramB + +#### paramB.x + +`1` + +## Returns + +`boolean` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithDefaultParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithDefaultParameters.md new file mode 100644 index 000000000..9c380e309 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithDefaultParameters.md @@ -0,0 +1,49 @@ +# Function: functionWithDefaultParameters() + +> **functionWithDefaultParameters**(`valueA`, `valueB`, `valueC`, `valueD`, `valueE`, `valueF`): `string` + +This is a function with a parameter that has a default value. + +## Parameters + +### valueA + +`string` = `'defaultValue'` + +A parameter with a default string value. + +### valueB + +`number` = `100` + +A parameter with a default numeric value. + +### valueC + +`number` = `Number.NaN` + +A parameter with a default NaN value. + +### valueD + +`boolean` = `true` + +A parameter with a default boolean value. + +### valueE + +`boolean` = `true` + +A parameter with a default null value. + +### valueF + +`string` = `''` + +## Returns + +`string` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithMultipleSignatures.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithMultipleSignatures.md new file mode 100644 index 000000000..34bf44d2c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithMultipleSignatures.md @@ -0,0 +1,51 @@ +# Function: functionWithMultipleSignatures() + +Main function comment. + +## Call Signature + +> **functionWithMultipleSignatures**(`value`): `string` + +This is the first signature of a function with multiple signatures. + +### Parameters + +#### value + +`string` + +The name value. + +### Returns + +`string` + +### Source + +[functions.ts:1](http://source-url) + +## Call Signature + +> **functionWithMultipleSignatures**(`value`): `string` + +This is the second signature of a function with multiple signatures. + +### Parameters + +#### value + +An object containing the name value. + +##### value.name + +`string` + +A value of the object. + +### Returns + +`string` + +### Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithNamedParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithNamedParams.md new file mode 100644 index 000000000..5766d8477 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithNamedParams.md @@ -0,0 +1,31 @@ +# Function: functionWithNamedParams() + +> **functionWithNamedParams**(`__namedParameters`, `anotherParam`): `void` + +## Parameters + +### \_\_namedParameters + +various options + +#### __namedParameters.bar + +`number` = `43` + +#### __namedParameters.foo + +`number` = `42` + +### anotherParam + +`string` + +Another param comment + +## Returns + +`void` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithNestedParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithNestedParameters.md new file mode 100644 index 000000000..3e5ac412d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithNestedParameters.md @@ -0,0 +1,61 @@ +# Function: functionWithNestedParameters() + +> **functionWithNestedParameters**(`params`, `context`, `somethingElse`?): `boolean` + +Some nested params. + +## Parameters + +### params + +The parameters passed to the method. + +#### params.name + +`string` + +The name of the new group. + +#### params.nestedObj + +`object` + +A nested object. + +#### params.nestedObj.name + +`string` + +#### params.nestedObj.obj + +`object` + +#### params.nestedObj.obj.name + +() => `void` + +#### params.nestedObj.value + +`number` + +#### params.parent + +`number` + +### context + +`any` + +The context of the method call. + +### somethingElse? + +`string` + +## Returns + +`boolean` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithOptionalParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithOptionalParameters.md new file mode 100644 index 000000000..c6de67940 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithOptionalParameters.md @@ -0,0 +1,35 @@ +# Function: functionWithOptionalParameters() + +> **functionWithOptionalParameters**(`firstParamWithDefault`, `requiredParam`, `optionalParam`?, `paramWithDefault`?): `void` + +This is a function with a parameters. + +## Parameters + +### firstParamWithDefault + +`boolean` = `true` + +### requiredParam + +`string` + +A normal parameter. + +### optionalParam? + +`string` + +An optional parameter. + +### paramWithDefault? + +`number` = `0` + +## Returns + +`void` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithRestParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithRestParams.md new file mode 100644 index 000000000..4d75b2472 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithRestParams.md @@ -0,0 +1,23 @@ +# Function: functionWithRestParams() + +> **functionWithRestParams**(`param`, ...`restParams`): `boolean` + +Function with reset parmas + +## Parameters + +### param + +`string` + +### restParams + +...`string`[] + +## Returns + +`boolean` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithTypeParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithTypeParameters.md new file mode 100644 index 000000000..b3d6f5866 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithTypeParameters.md @@ -0,0 +1,23 @@ +# Function: functionWithTypeParameters() + +> **functionWithTypeParameters**\<`T`, `Item`\>(): `boolean` + +Function with type parameters + +## Type Parameters + +### T + +Comments for T + +### Item + +Default type `string` \| `boolean` + +## Returns + +`boolean` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithUnionParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithUnionParams.md new file mode 100644 index 000000000..aeba773a7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/functions/functionWithUnionParams.md @@ -0,0 +1,55 @@ +# Function: functionWithUnionParams() + +> **functionWithUnionParams**(`primitiveUnions`, `objectUnions`, `mixedUnions`, `noUnions`): `undefined` + +## Parameters + +### primitiveUnions + +`string` | `number` + +### objectUnions + +Comments for objectUnions + +#### objectUnions.a + +`string` + +Comments for a + +#### objectUnions.b + +`1` + +### mixedUnions + +`string` + +\{`a`: `string`;`b`: `string`; \} + +#### mixedUnions.a + +`string` = `''` + +a comments + +#### mixedUnions.b + +`string` = `''` + +b comments + +### noUnions + +`string` + +Comments for noUnions + +## Returns + +`undefined` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/globals.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/globals.md new file mode 100644 index 000000000..be02bee29 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/globals.md @@ -0,0 +1,103 @@ +# typedoc-stubs + +Module comments + +## Enumerations + +- [BasicEnum](enumerations/BasicEnum.md) +- [EnumWithValues](enumerations/EnumWithValues.md) + +## Classes + +- [AbstractClass](classes/AbstractClass.md) +- [BaseClass](classes/BaseClass.md) +- [BasicClass](classes/BasicClass.md) +- [CallbacksOptions](classes/CallbacksOptions.md) +- [ChildClassA](classes/ChildClassA.md) +- [ChildClassB](classes/ChildClassB.md) +- [ClassWithAccessorKeywords](classes/ClassWithAccessorKeywords.md) +- [ClassWithAccessors](classes/ClassWithAccessors.md) +- [ClassWithComplexProps](classes/ClassWithComplexProps.md) +- [ClassWithConstructorOverloads](classes/ClassWithConstructorOverloads.md) +- [ClassWithFlags](classes/ClassWithFlags.md) +- [ClassWithModifiers](classes/ClassWithModifiers.md) +- [ClassWithoutPropCategories](classes/ClassWithoutPropCategories.md) +- [ClassWithPropCategories](classes/ClassWithPropCategories.md) +- [ClassWithSimpleProps](classes/ClassWithSimpleProps.md) +- [ClassWithSymbols](classes/ClassWithSymbols.md) +- [ClassWithTypeParameters](classes/ClassWithTypeParameters.md) +- [DerivedClassA](classes/DerivedClassA.md) +- [DerivedClassB](classes/DerivedClassB.md) +- [DisposableClass](classes/DisposableClass.md) +- [GrandChildClassA](classes/GrandChildClassA.md) +- [GrandChildClassB](classes/GrandChildClassB.md) + +## Interfaces + +- [BasicInterface](interfaces/BasicInterface.md) +- [CustomEventInterface](interfaces/CustomEventInterface.md) +- [ExtendedInterface](interfaces/ExtendedInterface.md) +- [IndexableInterface](interfaces/IndexableInterface.md) +- [InterfaceWithComments](interfaces/InterfaceWithComments.md) +- [InterfaceWithEventProperties](interfaces/InterfaceWithEventProperties.md) +- [InterfaceWithFlags](interfaces/InterfaceWithFlags.md) +- [InterfaceWithTypeParameters](interfaces/InterfaceWithTypeParameters.md) +- [MultipleIndexableInterface](interfaces/MultipleIndexableInterface.md) + +## Type Aliases + +- [\_\_TypeDeclarationWithSpecialCharacters\_](type-aliases/TypeDeclarationWithSpecialCharacters.md) +- [ArrayOfStuff](type-aliases/ArrayOfStuff.md) +- [ArrayType](type-aliases/ArrayType.md) +- [ConditionalType](type-aliases/ConditionalType.md) +- [ExternalReferenceType](type-aliases/ExternalReferenceType.md) +- [FunctionType](type-aliases/FunctionType.md) +- [IndexAccessType](type-aliases/IndexAccessType.md) +- [IntersectionType](type-aliases/IntersectionType.md) +- [LiteralType](type-aliases/LiteralType.md) +- [PartialMappedType](type-aliases/PartialMappedType.md) +- [PrimitiveType](type-aliases/PrimitiveType.md) +- [PromiseTypeWithObject](type-aliases/PromiseTypeWithObject.md) +- [PromiseTypeWithSymbol](type-aliases/PromiseTypeWithSymbol.md) +- [QueryType](type-aliases/QueryType.md) +- [ReadonlyMappedType](type-aliases/ReadonlyMappedType.md) +- [StringLiteralType](type-aliases/StringLiteralType.md) +- [Stuff](type-aliases/Stuff.md) +- [TupleType](type-aliases/TupleType.md) +- [TypeWithExternalSymbolLinkMapping](type-aliases/TypeWithExternalSymbolLinkMapping.md) +- [TypeWithReturns](type-aliases/TypeWithReturns.md) +- [TypeWithTypeParams](type-aliases/TypeWithTypeParams.md) +- [UnionType](type-aliases/UnionType.md) +- [UnionTypeWithTemplateStrings](type-aliases/UnionTypeWithTemplateStrings.md) +- [UsefulUnionType](type-aliases/UsefulUnionType.md) + +## Variables + +- [objectLiteralVariable](variables/objectLiteralVariable.md) +- [objectWithSymbol](variables/objectWithSymbol.md) +- [someQuery](variables/someQuery.md) +- [stringVariable](variables/stringVariable.md) +- [templateVariableString](variables/templateVariableString.md) +- [typeOperatorVariable](variables/typeOperatorVariable.md) + +## Functions + +- [basicFunction](functions/basicFunction.md) +- [basicFunctionWithReturns](functions/basicFunctionWithReturns.md) +- [curriedFunction](functions/curriedFunction.md) +- [functionReturningAFunction](functions/functionReturningAFunction.md) +- [functionReturningAnObject](functions/functionReturningAnObject.md) +- [functionReturningAPromise](functions/functionReturningAPromise.md) +- [functionReturningAString](functions/functionReturningAString.md) +- [functionReturningAUnionType](functions/functionReturningAUnionType.md) +- [functionWithArrayOfOptionalStuff](functions/functionWithArrayOfOptionalStuff.md) +- [functionWithArrayOfStuff](functions/functionWithArrayOfStuff.md) +- [functionWithComplexParams](functions/functionWithComplexParams.md) +- [functionWithDefaultParameters](functions/functionWithDefaultParameters.md) +- [functionWithMultipleSignatures](functions/functionWithMultipleSignatures.md) +- [functionWithNamedParams](functions/functionWithNamedParams.md) +- [functionWithNestedParameters](functions/functionWithNestedParameters.md) +- [functionWithOptionalParameters](functions/functionWithOptionalParameters.md) +- [functionWithRestParams](functions/functionWithRestParams.md) +- [functionWithTypeParameters](functions/functionWithTypeParameters.md) +- [functionWithUnionParams](functions/functionWithUnionParams.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/BasicInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/BasicInterface.md new file mode 100644 index 000000000..7e00f788c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/BasicInterface.md @@ -0,0 +1,233 @@ +# Interface: BasicInterface + +Comments for BasicInterface + +## Extended by + +- [`ExtendedInterface`](ExtendedInterface.md) + +## Properties + +### ~~deprecatedProp~~ + +> **deprecatedProp**: `string` + +#### Deprecated + +This prop is deprecated + +#### See + +Comments for some tag + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### functionProp() + +> **functionProp**: (`s`) => `boolean` + +Comments for functionProper + +#### Parameters + +##### s + +`string` + +Comment for param s + +#### Returns + +`boolean` + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### optionalProp? + +> `optional` **optionalProp**: `string` + +Comments for optional prop + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### prop + +> **prop**: `string` + +Comments for prop + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### propReturningObjectDeclaration + +> **propReturningObjectDeclaration**: `object` + +Comments for propReturningObjectDeclaration + +#### a + +> **a**: `boolean` + +#### b + +> **b**: `string` + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### propReturningObjectDeclarations + +> **propReturningObjectDeclarations**: `object` & `object` + +Comments for propReturningObjectDeclarations + +#### Type declaration + +##### a + +> **a**: `boolean` + +##### b + +> **b**: `string` + +#### Type declaration + +##### c + +> **c**: `boolean` + +##### d + +> **d**: `string` + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### propReturningSignatureDeclaration()? + +> `optional` **propReturningSignatureDeclaration**: () => `string` \| `number` \| `boolean` + +Comments for propReturningSignatureDeclaration + +#### Returns + +`string` \| `number` \| `boolean` + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### propReturningSignatureDeclarations + +> **propReturningSignatureDeclarations**: () => `any` & (`paramsA`, `paramsB`?) => `any` & (`paramsC`) => `any` + +Comments for propReturningSignatureDeclarations + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### propWithFunction() + +> **propWithFunction**: (`options`) => `boolean` + +Comments for propWithFunction + +#### Parameters + +##### options + +###### options.a + +`boolean` + +###### options.b + +`string` + +#### Returns + +`boolean` + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### propWithProps + +> **propWithProps**: `object` + +Comments for propWithProps + +#### callbacks? + +> `optional` **callbacks**: `Partial`\<[`CallbacksOptions`](../classes/CallbacksOptions.md)\<[`DisposableClass`](../classes/DisposableClass.md), [`ClassWithModifiers`](../classes/ClassWithModifiers.md)\>\> + +Comments for callbacks + +#### nestedPropA + +> **nestedPropA**: `string` + +Comments for nestedPropA + +#### nestedPropB + +> **nestedPropB**: `boolean` + +Comments for nestedPropB + +#### nestedPropC + +> **nestedPropC**: `object` + +Comments for nestedPropC + +##### nestedPropC.nestedPropCA + +> **nestedPropCA**: `string` + +Comments for nestedPropCA + +#### nestedPropD() + +> **nestedPropD**: () => `boolean` + +Comments for nestedPropD + +##### Returns + +`boolean` + +#### Source + +[interfaces.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/CustomEventInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/CustomEventInterface.md new file mode 100644 index 000000000..0948a8aad --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/CustomEventInterface.md @@ -0,0 +1,27 @@ +# Interface: CustomEventInterface\ + +## Type Parameters + +### T + +\- + +## Properties + +### detail + +> **detail**: `string` + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### target + +> **target**: `T` + +#### Source + +[interfaces.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/ExtendedInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/ExtendedInterface.md new file mode 100644 index 000000000..9c689a279 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/ExtendedInterface.md @@ -0,0 +1,283 @@ +# Interface: ExtendedInterface + +Comments for ExtendedInterface + +## Extends + +- [`BasicInterface`](BasicInterface.md) + +## Properties + +### ~~deprecatedProp~~ + +> **deprecatedProp**: `string` + +#### Deprecated + +This prop is deprecated + +#### See + +Comments for some tag + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`deprecatedProp`](BasicInterface.md#deprecatedprop) + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### extendedProp + +> **extendedProp**: `string` + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### functionProp() + +> **functionProp**: (`s`) => `boolean` + +Comments for functionProper + +#### Parameters + +##### s + +`string` + +Comment for param s + +#### Returns + +`boolean` + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`functionProp`](BasicInterface.md#functionprop) + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### optionalProp? + +> `optional` **optionalProp**: `string` + +Comments for optional prop + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`optionalProp`](BasicInterface.md#optionalprop) + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### prop + +> **prop**: `string` + +Comments for prop + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`prop`](BasicInterface.md#prop) + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### propReturningObjectDeclaration + +> **propReturningObjectDeclaration**: `object` + +Comments for propReturningObjectDeclaration + +#### a + +> **a**: `boolean` + +#### b + +> **b**: `string` + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`propReturningObjectDeclaration`](BasicInterface.md#propreturningobjectdeclaration) + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### propReturningObjectDeclarations + +> **propReturningObjectDeclarations**: `object` & `object` + +Comments for propReturningObjectDeclarations + +#### Type declaration + +##### a + +> **a**: `boolean` + +##### b + +> **b**: `string` + +#### Type declaration + +##### c + +> **c**: `boolean` + +##### d + +> **d**: `string` + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`propReturningObjectDeclarations`](BasicInterface.md#propreturningobjectdeclarations) + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### propReturningSignatureDeclaration()? + +> `optional` **propReturningSignatureDeclaration**: () => `string` \| `number` \| `boolean` + +Comments for propReturningSignatureDeclaration + +#### Returns + +`string` \| `number` \| `boolean` + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`propReturningSignatureDeclaration`](BasicInterface.md#propreturningsignaturedeclaration) + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### propReturningSignatureDeclarations + +> **propReturningSignatureDeclarations**: () => `any` & (`paramsA`, `paramsB`?) => `any` & (`paramsC`) => `any` + +Comments for propReturningSignatureDeclarations + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`propReturningSignatureDeclarations`](BasicInterface.md#propreturningsignaturedeclarations) + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### propWithFunction() + +> **propWithFunction**: (`options`) => `boolean` + +Comments for propWithFunction + +#### Parameters + +##### options + +###### options.a + +`boolean` + +###### options.b + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`propWithFunction`](BasicInterface.md#propwithfunction) + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### propWithProps + +> **propWithProps**: `object` + +Comments for propWithProps + +#### callbacks? + +> `optional` **callbacks**: `Partial`\<[`CallbacksOptions`](../classes/CallbacksOptions.md)\<[`DisposableClass`](../classes/DisposableClass.md), [`ClassWithModifiers`](../classes/ClassWithModifiers.md)\>\> + +Comments for callbacks + +#### nestedPropA + +> **nestedPropA**: `string` + +Comments for nestedPropA + +#### nestedPropB + +> **nestedPropB**: `boolean` + +Comments for nestedPropB + +#### nestedPropC + +> **nestedPropC**: `object` + +Comments for nestedPropC + +##### nestedPropC.nestedPropCA + +> **nestedPropCA**: `string` + +Comments for nestedPropCA + +#### nestedPropD() + +> **nestedPropD**: () => `boolean` + +Comments for nestedPropD + +##### Returns + +`boolean` + +#### Inherited from + +[`BasicInterface`](BasicInterface.md).[`propWithProps`](BasicInterface.md#propwithprops) + +#### Source + +[interfaces.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/IndexableInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/IndexableInterface.md new file mode 100644 index 000000000..88ca0867d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/IndexableInterface.md @@ -0,0 +1,17 @@ +# Interface: IndexableInterface + +Comments for IndexableInterface + +## Indexable + + \[`s`: `string`\]: `string` + +## Properties + +### prop + +> **prop**: `string` + +#### Source + +[interfaces.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/InterfaceWithComments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/InterfaceWithComments.md new file mode 100644 index 000000000..3b0121441 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/InterfaceWithComments.md @@ -0,0 +1,55 @@ +# Interface: InterfaceWithComments\ + +Comments for interface +over two lines + +And some more comments + +## Type Parameters + +### A + +This is a parameter. + +### B + +Comments for a parameter. +This sentence is on a soft new line. + +### C + +This is a parameter. + + Documentation with a double line + +### D + +

These are comments with paras

+

These are comments with paras

+Other comments +Comments with

paras

+ +

These are comments with paras

+ +## Properties + +### ~~propertyWithComments~~ + +> **propertyWithComments**: `string` + +Some text. + +- list item +- list item + +#### Deprecated + +This is a deprecated property + +#### See + +https://example.com + +#### Source + +[interfaces.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/InterfaceWithEventProperties.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/InterfaceWithEventProperties.md new file mode 100644 index 000000000..eebb1adae --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/InterfaceWithEventProperties.md @@ -0,0 +1,51 @@ +# Interface: InterfaceWithEventProperties + +## Properties + +### someProp? + +> `optional` **someProp**: `boolean` + +Description for prop someProp + +#### Source + +[interfaces.ts:1](http://source-url) + +## Events + +### anotherEvent + +> **anotherEvent**: `MouseEvent` + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### ~~someEvent()?~~ + +> `optional` **someEvent**: (`eventParam`) => `void` + +Description for event someEvent + +#### Deprecated + +Deprectaed comments + +#### Parameters + +##### eventParam + +[`CustomEventInterface`](CustomEventInterface.md)\<`MouseEvent`\> + +Comments for param eventParam + +#### Returns + +`void` + +#### Source + +[interfaces.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/InterfaceWithFlags.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/InterfaceWithFlags.md new file mode 100644 index 000000000..33a656ad1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/InterfaceWithFlags.md @@ -0,0 +1,29 @@ +# Interface: InterfaceWithFlags + +Comments for InterfaceWithFlags + +## Properties + +### expermintalProp? + +> `optional` **expermintalProp**: `string` + +**`Experimental`** + +#### Source + +[interfaces.ts:1](http://source-url) + +*** + +### internalProp + +> **internalProp**: `string` + +**`Internal`** + +Comments for internalProp + +#### Source + +[interfaces.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/InterfaceWithTypeParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/InterfaceWithTypeParameters.md new file mode 100644 index 000000000..fe288696a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/InterfaceWithTypeParameters.md @@ -0,0 +1,21 @@ +# Interface: InterfaceWithTypeParameters\ + +Comments for InterfaceWithTypeParameters + +## Type Parameters + +### A + +\- + +## Properties + +### prop + +> **prop**: `A` + +Comments for prop + +#### Source + +[interfaces.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/MultipleIndexableInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/MultipleIndexableInterface.md new file mode 100644 index 000000000..59aa8d0da --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/interfaces/MultipleIndexableInterface.md @@ -0,0 +1,19 @@ +# Interface: MultipleIndexableInterface + +## Indexable + + \[`key`: `string`\]: `string` + + \[`index`: `number`\]: `string` + +## Properties + +### prop + +> **prop**: `string` + +Prop + +#### Source + +[interfaces.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/sidebar.json new file mode 100644 index 000000000..de5681eaf --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/sidebar.json @@ -0,0 +1,442 @@ +[ + { + "title": "Enumerations", + "children": [ + { + "title": "BasicEnum", + "kind": 8, + "path": "enumerations/BasicEnum.md" + }, + { + "title": "EnumWithValues", + "kind": 8, + "path": "enumerations/EnumWithValues.md" + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "AbstractClass", + "kind": 128, + "path": "classes/AbstractClass.md" + }, + { + "title": "BaseClass", + "kind": 128, + "path": "classes/BaseClass.md" + }, + { + "title": "BasicClass", + "kind": 128, + "path": "classes/BasicClass.md" + }, + { + "title": "CallbacksOptions", + "kind": 128, + "path": "classes/CallbacksOptions.md" + }, + { + "title": "ChildClassA", + "kind": 128, + "path": "classes/ChildClassA.md" + }, + { + "title": "ChildClassB", + "kind": 128, + "path": "classes/ChildClassB.md" + }, + { + "title": "ClassWithAccessorKeywords", + "kind": 128, + "path": "classes/ClassWithAccessorKeywords.md" + }, + { + "title": "ClassWithAccessors", + "kind": 128, + "path": "classes/ClassWithAccessors.md" + }, + { + "title": "ClassWithComplexProps", + "kind": 128, + "path": "classes/ClassWithComplexProps.md" + }, + { + "title": "ClassWithConstructorOverloads", + "kind": 128, + "path": "classes/ClassWithConstructorOverloads.md" + }, + { + "title": "ClassWithFlags", + "kind": 128, + "path": "classes/ClassWithFlags.md" + }, + { + "title": "ClassWithModifiers", + "kind": 128, + "path": "classes/ClassWithModifiers.md" + }, + { + "title": "ClassWithoutPropCategories", + "kind": 128, + "path": "classes/ClassWithoutPropCategories.md" + }, + { + "title": "ClassWithPropCategories", + "kind": 128, + "path": "classes/ClassWithPropCategories.md" + }, + { + "title": "ClassWithSimpleProps", + "kind": 128, + "path": "classes/ClassWithSimpleProps.md" + }, + { + "title": "ClassWithSymbols", + "kind": 128, + "path": "classes/ClassWithSymbols.md" + }, + { + "title": "ClassWithTypeParameters", + "kind": 128, + "path": "classes/ClassWithTypeParameters.md" + }, + { + "title": "DerivedClassA", + "kind": 128, + "path": "classes/DerivedClassA.md" + }, + { + "title": "DerivedClassB", + "kind": 128, + "path": "classes/DerivedClassB.md" + }, + { + "title": "DisposableClass", + "kind": 128, + "path": "classes/DisposableClass.md" + }, + { + "title": "GrandChildClassA", + "kind": 128, + "path": "classes/GrandChildClassA.md" + }, + { + "title": "GrandChildClassB", + "kind": 128, + "path": "classes/GrandChildClassB.md" + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "BasicInterface", + "kind": 256, + "path": "interfaces/BasicInterface.md" + }, + { + "title": "CustomEventInterface", + "kind": 256, + "path": "interfaces/CustomEventInterface.md" + }, + { + "title": "ExtendedInterface", + "kind": 256, + "path": "interfaces/ExtendedInterface.md" + }, + { + "title": "IndexableInterface", + "kind": 256, + "path": "interfaces/IndexableInterface.md" + }, + { + "title": "InterfaceWithComments", + "kind": 256, + "path": "interfaces/InterfaceWithComments.md" + }, + { + "title": "InterfaceWithEventProperties", + "kind": 256, + "path": "interfaces/InterfaceWithEventProperties.md" + }, + { + "title": "InterfaceWithFlags", + "kind": 256, + "path": "interfaces/InterfaceWithFlags.md" + }, + { + "title": "InterfaceWithTypeParameters", + "kind": 256, + "path": "interfaces/InterfaceWithTypeParameters.md" + }, + { + "title": "MultipleIndexableInterface", + "kind": 256, + "path": "interfaces/MultipleIndexableInterface.md" + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "__TypeDeclarationWithSpecialCharacters_", + "kind": 2097152, + "path": "type-aliases/TypeDeclarationWithSpecialCharacters.md" + }, + { + "title": "ArrayOfStuff", + "kind": 2097152, + "path": "type-aliases/ArrayOfStuff.md" + }, + { + "title": "ArrayType", + "kind": 2097152, + "path": "type-aliases/ArrayType.md" + }, + { + "title": "ConditionalType", + "kind": 2097152, + "path": "type-aliases/ConditionalType.md" + }, + { + "title": "ExternalReferenceType", + "kind": 2097152, + "path": "type-aliases/ExternalReferenceType.md" + }, + { + "title": "FunctionType", + "kind": 2097152, + "path": "type-aliases/FunctionType.md" + }, + { + "title": "IndexAccessType", + "kind": 2097152, + "path": "type-aliases/IndexAccessType.md" + }, + { + "title": "IntersectionType", + "kind": 2097152, + "path": "type-aliases/IntersectionType.md" + }, + { + "title": "LiteralType", + "kind": 2097152, + "path": "type-aliases/LiteralType.md" + }, + { + "title": "PartialMappedType", + "kind": 2097152, + "path": "type-aliases/PartialMappedType.md" + }, + { + "title": "PrimitiveType", + "kind": 2097152, + "path": "type-aliases/PrimitiveType.md" + }, + { + "title": "PromiseTypeWithObject", + "kind": 2097152, + "path": "type-aliases/PromiseTypeWithObject.md" + }, + { + "title": "PromiseTypeWithSymbol", + "kind": 2097152, + "path": "type-aliases/PromiseTypeWithSymbol.md" + }, + { + "title": "QueryType", + "kind": 2097152, + "path": "type-aliases/QueryType.md" + }, + { + "title": "ReadonlyMappedType", + "kind": 2097152, + "path": "type-aliases/ReadonlyMappedType.md" + }, + { + "title": "StringLiteralType", + "kind": 2097152, + "path": "type-aliases/StringLiteralType.md" + }, + { + "title": "Stuff", + "kind": 2097152, + "path": "type-aliases/Stuff.md" + }, + { + "title": "TupleType", + "kind": 2097152, + "path": "type-aliases/TupleType.md" + }, + { + "title": "TypeWithExternalSymbolLinkMapping", + "kind": 2097152, + "path": "type-aliases/TypeWithExternalSymbolLinkMapping.md" + }, + { + "title": "TypeWithReturns", + "kind": 2097152, + "path": "type-aliases/TypeWithReturns.md" + }, + { + "title": "TypeWithTypeParams", + "kind": 2097152, + "path": "type-aliases/TypeWithTypeParams.md" + }, + { + "title": "UnionType", + "kind": 2097152, + "path": "type-aliases/UnionType.md" + }, + { + "title": "UnionTypeWithTemplateStrings", + "kind": 2097152, + "path": "type-aliases/UnionTypeWithTemplateStrings.md" + }, + { + "title": "UsefulUnionType", + "kind": 2097152, + "path": "type-aliases/UsefulUnionType.md" + } + ] + }, + { + "title": "Variables", + "children": [ + { + "title": "objectLiteralVariable", + "kind": 32, + "path": "variables/objectLiteralVariable.md" + }, + { + "title": "objectWithSymbol", + "kind": 32, + "path": "variables/objectWithSymbol.md" + }, + { + "title": "someQuery", + "kind": 32, + "path": "variables/someQuery.md" + }, + { + "title": "stringVariable", + "kind": 32, + "path": "variables/stringVariable.md" + }, + { + "title": "templateVariableString", + "kind": 32, + "path": "variables/templateVariableString.md" + }, + { + "title": "typeOperatorVariable", + "kind": 32, + "path": "variables/typeOperatorVariable.md" + } + ] + }, + { + "title": "Functions", + "children": [ + { + "title": "basicFunction", + "kind": 64, + "path": "functions/basicFunction.md" + }, + { + "title": "basicFunctionWithReturns", + "kind": 64, + "path": "functions/basicFunctionWithReturns.md" + }, + { + "title": "curriedFunction", + "kind": 64, + "path": "functions/curriedFunction.md" + }, + { + "title": "functionReturningAFunction", + "kind": 64, + "path": "functions/functionReturningAFunction.md" + }, + { + "title": "functionReturningAnObject", + "kind": 64, + "path": "functions/functionReturningAnObject.md" + }, + { + "title": "functionReturningAPromise", + "kind": 64, + "path": "functions/functionReturningAPromise.md" + }, + { + "title": "functionReturningAString", + "kind": 64, + "path": "functions/functionReturningAString.md" + }, + { + "title": "functionReturningAUnionType", + "kind": 64, + "path": "functions/functionReturningAUnionType.md" + }, + { + "title": "functionWithArrayOfOptionalStuff", + "kind": 64, + "path": "functions/functionWithArrayOfOptionalStuff.md" + }, + { + "title": "functionWithArrayOfStuff", + "kind": 64, + "path": "functions/functionWithArrayOfStuff.md" + }, + { + "title": "functionWithComplexParams", + "kind": 64, + "path": "functions/functionWithComplexParams.md" + }, + { + "title": "functionWithDefaultParameters", + "kind": 64, + "path": "functions/functionWithDefaultParameters.md" + }, + { + "title": "functionWithMultipleSignatures", + "kind": 64, + "path": "functions/functionWithMultipleSignatures.md" + }, + { + "title": "functionWithNamedParams", + "kind": 64, + "path": "functions/functionWithNamedParams.md" + }, + { + "title": "functionWithNestedParameters", + "kind": 64, + "path": "functions/functionWithNestedParameters.md" + }, + { + "title": "functionWithOptionalParameters", + "kind": 64, + "path": "functions/functionWithOptionalParameters.md" + }, + { + "title": "functionWithRestParams", + "kind": 64, + "path": "functions/functionWithRestParams.md" + }, + { + "title": "functionWithTypeParameters", + "kind": 64, + "path": "functions/functionWithTypeParameters.md" + }, + { + "title": "functionWithUnionParams", + "kind": 64, + "path": "functions/functionWithUnionParams.md" + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ArrayOfStuff.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ArrayOfStuff.md new file mode 100644 index 000000000..887df8567 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ArrayOfStuff.md @@ -0,0 +1,7 @@ +# Type Alias: ArrayOfStuff + +> **ArrayOfStuff**: `object`[] + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ArrayType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ArrayType.md new file mode 100644 index 000000000..d64e11140 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ArrayType.md @@ -0,0 +1,9 @@ +# Type Alias: ArrayType + +> **ArrayType**: `string`[] + +Comments for ArrayType + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ConditionalType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ConditionalType.md new file mode 100644 index 000000000..47d935607 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ConditionalType.md @@ -0,0 +1,15 @@ +# Type Alias: ConditionalType\ + +> **ConditionalType**\<`T`\>: `T` *extends* `string` ? `"string"` : `T` *extends* `number` ? `"number"` : `T` *extends* `boolean` ? `"boolean"` : `T` *extends* `undefined` ? `"undefined"` : `"object"` + +Comments for ConditionalType + +## Type Parameters + +### T + +\- + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ExternalReferenceType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ExternalReferenceType.md new file mode 100644 index 000000000..70b75b31b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ExternalReferenceType.md @@ -0,0 +1,9 @@ +# Type Alias: ExternalReferenceType + +> **ExternalReferenceType**: [`ClassWithTypeParameters`](../classes/ClassWithTypeParameters.md)\<`"x"`, `"y"`\> + +Comments for ExternalReferenceType + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/FunctionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/FunctionType.md new file mode 100644 index 000000000..c24cb6cd6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/FunctionType.md @@ -0,0 +1,23 @@ +# Type Alias: FunctionType() + +> **FunctionType**: (`name`, `value`) => `void` + +Comments for FunctionType + +## Parameters + +### name + +`string` + +### value + +`unknown` + +## Returns + +`void` + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/IndexAccessType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/IndexAccessType.md new file mode 100644 index 000000000..2c0584221 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/IndexAccessType.md @@ -0,0 +1,9 @@ +# Type Alias: IndexAccessType + +> **IndexAccessType**: [`ArrayOfStuff`](ArrayOfStuff.md)\[`number`\] + +Comments for IndexAccessType + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/IntersectionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/IntersectionType.md new file mode 100644 index 000000000..bdf330b7f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/IntersectionType.md @@ -0,0 +1,15 @@ +# Type Alias: IntersectionType + +> **IntersectionType**: [`TupleType`](TupleType.md) & [`ArrayType`](ArrayType.md) & `object` + +Comments for IntersectionType + +## Type declaration + +### bar + +> **bar**: `number` + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/LiteralType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/LiteralType.md new file mode 100644 index 000000000..6c2d038f6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/LiteralType.md @@ -0,0 +1,141 @@ +# Type Alias: LiteralType + +> **LiteralType**: `object` + +Comments for LiteralType + +## Type declaration + +### someFunctionWithArrow() + +> **someFunctionWithArrow**: () => `string` + +Comments for someFunctionWithArrow + +#### Returns + +`string` + +### x? + +> `optional` **x**: `string` + +comment for x + +### y + +> **y**: `object` + +comment for y + +#### y.x + +> **x**: `string` + +comment for y.x + +#### y.y? + +> `optional` **y**: `boolean` \| `string` + +comment for y.y + +#### y.z() + +> **z**: (`x`) => `string` + +comment for y.z + +##### Parameters + +###### x + +`string` + +##### Returns + +`string` + +### z() + +> **z**: (`x`) => `string` + +#### Parameters + +##### x + +`string` + +#### Returns + +`string` + +### accessorA + +#### Get Signature + +> **get** **accessorA**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\> + +Comments for accessorA getter + +##### Returns + +[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\> + +#### Set Signature + +> **set** **accessorA**(`x`): `void` + +Comments for accessorA setter + +##### Parameters + +###### x + +[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\> + +##### Returns + +`void` + +### accessorB + +#### Get Signature + +> **get** **accessorB**(): `string` + +##### Returns + +`string` + +#### Set Signature + +> **set** **accessorB**(`x`): `void` + +##### Parameters + +###### x + +`string` + +##### Returns + +`void` + +### someFunction() + +Comments for someFunction + +#### Parameters + +##### param + +`string` + +#### Returns + +[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/PartialMappedType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/PartialMappedType.md new file mode 100644 index 000000000..ecdf815b8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/PartialMappedType.md @@ -0,0 +1,15 @@ +# Type Alias: PartialMappedType\ + +> **PartialMappedType**\<`T`\>: `{ [P in keyof T]?: T[P] }` + +Comments for PartialMappedType + +## Type Parameters + +### T + +\- + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/PrimitiveType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/PrimitiveType.md new file mode 100644 index 000000000..d06fbc780 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/PrimitiveType.md @@ -0,0 +1,9 @@ +# Type Alias: PrimitiveType + +> **PrimitiveType**: `boolean` + +Comments for PrimitiveType + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/PromiseTypeWithObject.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/PromiseTypeWithObject.md new file mode 100644 index 000000000..c862425de --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/PromiseTypeWithObject.md @@ -0,0 +1,17 @@ +# Type Alias: PromiseTypeWithObject + +> **PromiseTypeWithObject**: [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`object`\> + +Comments for promise type returning object + +## Type declaration + +### x + +> **x**: `1` + +comments for x + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/PromiseTypeWithSymbol.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/PromiseTypeWithSymbol.md new file mode 100644 index 000000000..5aa75b762 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/PromiseTypeWithSymbol.md @@ -0,0 +1,9 @@ +# Type Alias: PromiseTypeWithSymbol + +> **PromiseTypeWithSymbol**: [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`IndexAccessType`](IndexAccessType.md)\> + +Comments for promise type returning symbol + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/QueryType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/QueryType.md new file mode 100644 index 000000000..0a382c983 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/QueryType.md @@ -0,0 +1,9 @@ +# Type Alias: QueryType + +> **QueryType**: *typeof* [`someQuery`](../variables/someQuery.md) + +Comments for query type + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ReadonlyMappedType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ReadonlyMappedType.md new file mode 100644 index 000000000..80a3e7154 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/ReadonlyMappedType.md @@ -0,0 +1,15 @@ +# Type Alias: ReadonlyMappedType\ + +> **ReadonlyMappedType**\<`T`\>: `{ readonly [P in keyof T]: T[P] }` + +Comments for ReadonlyMapedType + +## Type Parameters + +### T + +\- + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/StringLiteralType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/StringLiteralType.md new file mode 100644 index 000000000..fa9efc899 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/StringLiteralType.md @@ -0,0 +1,9 @@ +# Type Alias: StringLiteralType + +> **StringLiteralType**: `" "` \| `"string"` \| "string\|with\|pipes" \| "string\`with\`backticks" \| `""` \| `"*"` + +Comments for StringLiteralType + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/Stuff.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/Stuff.md new file mode 100644 index 000000000..375dd1a00 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/Stuff.md @@ -0,0 +1,17 @@ +# Type Alias: Stuff + +> **Stuff**: `object` + +## Type declaration + +### a + +> **a**: `string` + +### b + +> **b**: `string` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TupleType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TupleType.md new file mode 100644 index 000000000..4a195261a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TupleType.md @@ -0,0 +1,9 @@ +# Type Alias: TupleType + +> **TupleType**: [`string`, `number`] + +Comments for TupleType + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TypeDeclarationWithSpecialCharacters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TypeDeclarationWithSpecialCharacters.md new file mode 100644 index 000000000..37ef54bd7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TypeDeclarationWithSpecialCharacters.md @@ -0,0 +1,111 @@ +# Type Alias: \_\_TypeDeclarationWithSpecialCharacters\_\ + +> **\_\_TypeDeclarationWithSpecialCharacters\_**\<`T`, `U`\>: `object` + +Comments for object with special characters + +## Type Parameters + +### T + +\- + +### U + +\- + +## Type declaration + +### \_ + +> **\_**: `"_"` + +### \_foo\_ + +> **\_foo\_**: `"_foo_"` + +### \_prop\_with\_underscore\_ + +> **\_prop\_with\_underscore\_**: `"_prop_with_underscore_"` + +### \_x() + +> **\_x**: (`_param`) => `U` + +#### Parameters + +##### \_param + +`T` + +#### Returns + +`U` + +### ? + +> **?**: `T` \| `U` + +### \{prop-with-brackets\} + +> **\{prop-with-brackets\}**: `"{prop-with-brackets}"` + +### \* + +> **\***: `"*"` + +### \*\*foo\*\* + +> **\*\*foo\*\***: `"**foo**"` + +### \*foo\* + +> **\*foo\***: `"*foo*"` + +### \ + +> \: "\\" + +### \a + +> \a: "\\a" + +### \n + +> \n: "\\n" + +### \` + +> \`: "\`" + +### \`prop\`with\`backticks\` + +> \`prop\`with\`backticks\`: "\`prop\`with\`backticks\`" + +### \< + +> **\<**: `"<"` + +### \ + +> **\**: `""` + +### \> + +> **\>**: `">"` + +### \| + +> **\|**: "\|" + +### \|prop\|with\|pipes\| + +> **\|prop\|with\|pipes\|**: "\|prop\|with\|pipes\|" + +### ~ + +> **~**: `"~"` + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TypeWithExternalSymbolLinkMapping.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TypeWithExternalSymbolLinkMapping.md new file mode 100644 index 000000000..6360f857b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TypeWithExternalSymbolLinkMapping.md @@ -0,0 +1,9 @@ +# Type Alias: TypeWithExternalSymbolLinkMapping + +> **TypeWithExternalSymbolLinkMapping**: [`Application`](https://typedoc.org/api/classes/Application.html) + +Comments for TypeWithExternalSymbolLinkMapping + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TypeWithReturns.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TypeWithReturns.md new file mode 100644 index 000000000..3aab9b799 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TypeWithReturns.md @@ -0,0 +1,13 @@ +# Type Alias: TypeWithReturns + +> **TypeWithReturns**: `string` + +Comments for TypeWithReturns + +## Returns + +- return comments. + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TypeWithTypeParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TypeWithTypeParams.md new file mode 100644 index 000000000..3dcc3996e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/TypeWithTypeParams.md @@ -0,0 +1,19 @@ +# Type Alias: TypeWithTypeParams\ + +> **TypeWithTypeParams**\<`T`, `R`\>: [`T`, `R`] + +Comments for TypeWithTypeParams + +## Type Parameters + +### T + +\- + +### R + +\- + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/UnionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/UnionType.md new file mode 100644 index 000000000..c114f0813 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/UnionType.md @@ -0,0 +1,9 @@ +# Type Alias: UnionType + +> **UnionType**: `string` \| `boolean` \| \{`z`: `string`; \} + +Comments for UnionType + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/UnionTypeWithTemplateStrings.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/UnionTypeWithTemplateStrings.md new file mode 100644 index 000000000..5856de391 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/UnionTypeWithTemplateStrings.md @@ -0,0 +1,9 @@ +# Type Alias: UnionTypeWithTemplateStrings + +> **UnionTypeWithTemplateStrings**: \`v$\{number\}\` \| \`v$\{number\}.$\{number\}\` \| \`v$\{number\}.$\{number\}.$\{number\}\` + +Union with template strings + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/UsefulUnionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/UsefulUnionType.md new file mode 100644 index 000000000..4250a51b5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/type-aliases/UsefulUnionType.md @@ -0,0 +1,23 @@ +# Type Alias: UsefulUnionType + +> **UsefulUnionType**: `string` \| `boolean` \| \{`z`: `string`; \} + +Comments for useful UnionType + +## Type declaration + +`string` + +`boolean` + +\{`z`: `string`; \} + +### z + +> **z**: `string` + +Comments for z + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/objectLiteralVariable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/objectLiteralVariable.md new file mode 100644 index 000000000..32f683da3 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/objectLiteralVariable.md @@ -0,0 +1,93 @@ +# Variable: objectLiteralVariable + +> `const` **objectLiteralVariable**: `object` + +Comments for objectLiteralVariable + +## See + +xyz.com + +## Type declaration + +### valueA + +> **valueA**: `number` = `100` + +Comments for valueA + +### valueB + +> **valueB**: `boolean` = `true` + +### valueX + +> **valueX**: `object` + +Comments for valueX + +#### valueX.valueA + +> **valueA**: `number`[] + +Comment for valueX.valueA + +#### valueX.valueY() + +> **valueY**: (`z`) => `object` + +##### Parameters + +###### z + +`string` + +##### Returns + +`object` + +###### a + +> **a**: `string` = `'test'` + +###### b + +> **b**: `string` = `z` + +###### c + +> **c**: `object` + +###### c.a + +> **a**: `number` = `1` + +###### c.b + +> **b**: `number` = `2` + +#### valueX.valueZ + +> **valueZ**: `string` = `'foo'` + +### valueY() + +> **valueY**: (`unionParam`, `_undercoreParam_`) => `string` + +#### Parameters + +##### unionParam + +`"a"` | `"b"` + +##### \_undercoreParam\_ + +`string` + +#### Returns + +`string` + +## Source + +[variables.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/objectWithSymbol.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/objectWithSymbol.md new file mode 100644 index 000000000..c928d1163 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/objectWithSymbol.md @@ -0,0 +1,17 @@ +# Variable: objectWithSymbol + +> `const` **objectWithSymbol**: `object` + +Comments variable with symbol + +## Type declaration + +### \[sym\] + +> **\[sym\]**: `string` = `'value'` + +Comments for symbol + +## Source + +[variables.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/someQuery.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/someQuery.md new file mode 100644 index 000000000..4d0591ae4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/someQuery.md @@ -0,0 +1,7 @@ +# Variable: someQuery + +> `const` **someQuery**: `1` = `1` + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/stringVariable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/stringVariable.md new file mode 100644 index 000000000..492336991 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/stringVariable.md @@ -0,0 +1,9 @@ +# Variable: stringVariable + +> `const` **stringVariable**: `"stringConstWithDefaultValue"` = `'stringConstWithDefaultValue'` + +A simple string variable + +## Source + +[variables.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/templateVariableString.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/templateVariableString.md new file mode 100644 index 000000000..bd03fcf80 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/templateVariableString.md @@ -0,0 +1,9 @@ +# Variable: templateVariableString + +> `const` **templateVariableString**: "\nThis is a template string\n/\* with a comment \*/\nAnd a \\\n" + +A template variable string + +## Source + +[variables.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/typeOperatorVariable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/typeOperatorVariable.md new file mode 100644 index 000000000..324ced0d2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-1/variables/typeOperatorVariable.md @@ -0,0 +1,9 @@ +# Variable: typeOperatorVariable + +> `const` **typeOperatorVariable**: unique `symbol` + +Comments for typeOperatorVariable + +## Source + +[variables.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/README.md new file mode 100644 index 000000000..dd7bf0582 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/README.md @@ -0,0 +1,115 @@ +# typedoc-stubs + +Module comments + +## Enumerations + +| Enumeration | Description | +| :------ | :------ | +| [BasicEnum](enumerations/BasicEnum.md) | Comments for enum | +| [EnumWithValues](enumerations/EnumWithValues.md) | Comments for enum | + +## Classes + +| Class | Description | +| :------ | :------ | +| [AbstractClass](classes/AbstractClass.md) | - | +| [BaseClass](classes/BaseClass.md) | - | +| [BasicClass](classes/BasicClass.md) | Comments for BasicClass | +| [CallbacksOptions](classes/CallbacksOptions.md) | - | +| [ChildClassA](classes/ChildClassA.md) | - | +| [ChildClassB](classes/ChildClassB.md) | - | +| [ClassWithAccessorKeywords](classes/ClassWithAccessorKeywords.md) | - | +| [ClassWithAccessors](classes/ClassWithAccessors.md) | Comments for ClassWithAccessors | +| [ClassWithComplexProps](classes/ClassWithComplexProps.md) | Comments for ClassWithComplexProps | +| [ClassWithConstructorOverloads](classes/ClassWithConstructorOverloads.md) | Comments for ClassWithConstructorOverloads | +| [ClassWithFlags](classes/ClassWithFlags.md) | Comment for ClassWithFlags | +| [ClassWithModifiers](classes/ClassWithModifiers.md) | Comments for ClassWithModifiers | +| [ClassWithoutPropCategories](classes/ClassWithoutPropCategories.md) | - | +| [ClassWithPropCategories](classes/ClassWithPropCategories.md) | - | +| [ClassWithSimpleProps](classes/ClassWithSimpleProps.md) | Comments for ClassWithSimpleProps | +| [ClassWithSymbols](classes/ClassWithSymbols.md) | - | +| [ClassWithTypeParameters](classes/ClassWithTypeParameters.md) | Comments for ClassWithTypeParameters | +| [DerivedClassA](classes/DerivedClassA.md) | Comments for DerivedClassA | +| [DerivedClassB](classes/DerivedClassB.md) | Comments for DerivedClassB | +| [DisposableClass](classes/DisposableClass.md) | - | +| [GrandChildClassA](classes/GrandChildClassA.md) | - | +| [GrandChildClassB](classes/GrandChildClassB.md) | - | + +## Interfaces + +| Interface | Description | +| :------ | :------ | +| [BasicInterface](interfaces/BasicInterface.md) | Comments for BasicInterface | +| [CustomEventInterface](interfaces/CustomEventInterface.md) | - | +| [ExtendedInterface](interfaces/ExtendedInterface.md) | Comments for ExtendedInterface | +| [IndexableInterface](interfaces/IndexableInterface.md) | Comments for IndexableInterface | +| [InterfaceWithComments](interfaces/InterfaceWithComments.md) | Comments for interface over two lines | +| [InterfaceWithEventProperties](interfaces/InterfaceWithEventProperties.md) | - | +| [InterfaceWithFlags](interfaces/InterfaceWithFlags.md) | Comments for InterfaceWithFlags | +| [InterfaceWithTypeParameters](interfaces/InterfaceWithTypeParameters.md) | Comments for InterfaceWithTypeParameters | +| [MultipleIndexableInterface](interfaces/MultipleIndexableInterface.md) | - | + +## Type Aliases + +| Type alias | Description | +| :------ | :------ | +| [\_\_TypeDeclarationWithSpecialCharacters\_](type-aliases/TypeDeclarationWithSpecialCharacters.md) | Comments for object with special characters | +| [ArrayOfStuff](type-aliases/ArrayOfStuff.md) | - | +| [ArrayType](type-aliases/ArrayType.md) | Comments for ArrayType | +| [ConditionalType](type-aliases/ConditionalType.md) | Comments for ConditionalType | +| [ExternalReferenceType](type-aliases/ExternalReferenceType.md) | Comments for ExternalReferenceType | +| [FunctionType](type-aliases/FunctionType.md) | Comments for FunctionType | +| [IndexAccessType](type-aliases/IndexAccessType.md) | Comments for IndexAccessType | +| [IntersectionType](type-aliases/IntersectionType.md) | Comments for IntersectionType | +| [LiteralType](type-aliases/LiteralType.md) | Comments for LiteralType | +| [PartialMappedType](type-aliases/PartialMappedType.md) | Comments for PartialMappedType | +| [PrimitiveType](type-aliases/PrimitiveType.md) | Comments for PrimitiveType | +| [PromiseTypeWithObject](type-aliases/PromiseTypeWithObject.md) | Comments for promise type returning object | +| [PromiseTypeWithSymbol](type-aliases/PromiseTypeWithSymbol.md) | Comments for promise type returning symbol | +| [QueryType](type-aliases/QueryType.md) | Comments for query type | +| [ReadonlyMappedType](type-aliases/ReadonlyMappedType.md) | Comments for ReadonlyMapedType | +| [StringLiteralType](type-aliases/StringLiteralType.md) | Comments for StringLiteralType | +| [Stuff](type-aliases/Stuff.md) | - | +| [TupleType](type-aliases/TupleType.md) | Comments for TupleType | +| [TypeWithExternalSymbolLinkMapping](type-aliases/TypeWithExternalSymbolLinkMapping.md) | Comments for TypeWithExternalSymbolLinkMapping | +| [TypeWithReturns](type-aliases/TypeWithReturns.md) | Comments for TypeWithReturns | +| [TypeWithTypeParams](type-aliases/TypeWithTypeParams.md) | Comments for TypeWithTypeParams | +| [UnionType](type-aliases/UnionType.md) | Comments for UnionType | +| [UnionTypeWithTemplateStrings](type-aliases/UnionTypeWithTemplateStrings.md) | Union with template strings | +| [UsefulUnionType](type-aliases/UsefulUnionType.md) | Comments for useful UnionType | + +## Variables + +| Variable | Description | +| :------ | :------ | +| [objectLiteralVariable](variables/objectLiteralVariable.md) | Comments for objectLiteralVariable | +| [objectWithSymbol](variables/objectWithSymbol.md) | Comments variable with symbol | +| [someQuery](variables/someQuery.md) | - | +| [stringVariable](variables/stringVariable.md) | A simple string variable | +| [templateVariableString](variables/templateVariableString.md) | A template variable string | +| [typeOperatorVariable](variables/typeOperatorVariable.md) | Comments for typeOperatorVariable | + +## Functions + +| Function | Description | +| :------ | :------ | +| [basicFunction](functions/basicFunction.md) | This is a function that is assigned to a variable. | +| [basicFunctionWithReturns](functions/basicFunctionWithReturns.md) | This is a function that is assigned to a variable. | +| [curriedFunction](functions/curriedFunction.md) | Comments for main curriedFunction | +| [functionReturningAFunction](functions/functionReturningAFunction.md) | Comments for function | +| [functionReturningAnObject](functions/functionReturningAnObject.md) | Comments for function | +| [functionReturningAPromise](functions/functionReturningAPromise.md) | Comments for function | +| [functionReturningAString](functions/functionReturningAString.md) | Comments for function | +| [functionReturningAUnionType](functions/functionReturningAUnionType.md) | Comments for function | +| [functionWithArrayOfOptionalStuff](functions/functionWithArrayOfOptionalStuff.md) | Comments for array of stuff? | +| [functionWithArrayOfStuff](functions/functionWithArrayOfStuff.md) | Comments for array of stuff | +| [functionWithComplexParams](functions/functionWithComplexParams.md) | Function with function parmas | +| [functionWithDefaultParameters](functions/functionWithDefaultParameters.md) | This is a function with a parameter that has a default value. | +| [functionWithMultipleSignatures](functions/functionWithMultipleSignatures.md) | Main function comment. | +| [functionWithNamedParams](functions/functionWithNamedParams.md) | - | +| [functionWithNestedParameters](functions/functionWithNestedParameters.md) | Some nested params. | +| [functionWithOptionalParameters](functions/functionWithOptionalParameters.md) | This is a function with a parameters. | +| [functionWithRestParams](functions/functionWithRestParams.md) | Function with reset parmas | +| [functionWithTypeParameters](functions/functionWithTypeParameters.md) | Function with type parameters | +| [functionWithUnionParams](functions/functionWithUnionParams.md) | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/AbstractClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/AbstractClass.md new file mode 100644 index 000000000..984f82729 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/AbstractClass.md @@ -0,0 +1,42 @@ +# Class: `abstract` AbstractClass + +## Extended by + +- [`DerivedClassA`](DerivedClassA.md) +- [`DerivedClassB`](DerivedClassB.md) + +## Constructors + +### new AbstractClass() + +```ts +new AbstractClass(): AbstractClass +``` + +#### Returns + +[`AbstractClass`](AbstractClass.md) + +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `abstractProp` | `abstract` | `string` | Comments for abstractProp | + +## Methods + +### abstractMethod() + +```ts +abstract abstractMethod(): string +``` + +Comments for abstractMethod + +#### Returns + +`string` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/BaseClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/BaseClass.md new file mode 100644 index 000000000..0a546c636 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/BaseClass.md @@ -0,0 +1,18 @@ +# Class: BaseClass + +## Extended by + +- [`ChildClassA`](ChildClassA.md) +- [`ChildClassB`](ChildClassB.md) + +## Constructors + +### new BaseClass() + +```ts +new BaseClass(): BaseClass +``` + +#### Returns + +[`BaseClass`](BaseClass.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/BasicClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/BasicClass.md new file mode 100644 index 000000000..e6ad83169 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/BasicClass.md @@ -0,0 +1,39 @@ +# Class: BasicClass + +Comments for BasicClass + +## Constructors + +### new BasicClass() + +```ts +new BasicClass(): BasicClass +``` + +#### Returns + +[`BasicClass`](BasicClass.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `prop` | `string` | Comments for prop | + +## Methods + +### method() + +```ts +method(): string +``` + +Comments for method + +#### Returns + +`string` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/CallbacksOptions.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/CallbacksOptions.md new file mode 100644 index 000000000..fa8c0bb57 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/CallbacksOptions.md @@ -0,0 +1,20 @@ +# Class: CallbacksOptions\ + +## Type Parameters + +| Type Parameter | Default type | +| :------ | :------ | +| `P` | [`DisposableClass`](DisposableClass.md) | +| `A` | [`ClassWithModifiers`](ClassWithModifiers.md) | + +## Constructors + +### new CallbacksOptions() + +```ts +new CallbacksOptions(): CallbacksOptions +``` + +#### Returns + +[`CallbacksOptions`](CallbacksOptions.md)\<`P`, `A`\> diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ChildClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ChildClassA.md new file mode 100644 index 000000000..69ea2706a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ChildClassA.md @@ -0,0 +1,26 @@ +# Class: ChildClassA + +## Extends + +- [`BaseClass`](BaseClass.md) + +## Extended by + +- [`GrandChildClassA`](GrandChildClassA.md) +- [`GrandChildClassB`](GrandChildClassB.md) + +## Constructors + +### new ChildClassA() + +```ts +new ChildClassA(): ChildClassA +``` + +#### Returns + +[`ChildClassA`](ChildClassA.md) + +#### Inherited from + +[`BaseClass`](BaseClass.md).[`constructor`](BaseClass.md#constructors) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ChildClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ChildClassB.md new file mode 100644 index 000000000..52d4dd04b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ChildClassB.md @@ -0,0 +1,21 @@ +# Class: ChildClassB + +## Extends + +- [`BaseClass`](BaseClass.md) + +## Constructors + +### new ChildClassB() + +```ts +new ChildClassB(): ChildClassB +``` + +#### Returns + +[`ChildClassB`](ChildClassB.md) + +#### Inherited from + +[`BaseClass`](BaseClass.md).[`constructor`](BaseClass.md#constructors) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithAccessorKeywords.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithAccessorKeywords.md new file mode 100644 index 000000000..dd1b4e7b3 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithAccessorKeywords.md @@ -0,0 +1,53 @@ +# Class: ClassWithAccessorKeywords + +## Constructors + +### new ClassWithAccessorKeywords() + +```ts +new ClassWithAccessorKeywords(): ClassWithAccessorKeywords +``` + +#### Returns + +[`ClassWithAccessorKeywords`](ClassWithAccessorKeywords.md) + +## Accessors + +### accessor1 + +Accessor comments + +#### Example + +```ts +const x = 1; +``` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### accessor2 + +Accessor comments + +#### Remarks + +Remark comments + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### accessor3 + +Accessor comments + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithAccessors.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithAccessors.md new file mode 100644 index 000000000..4ddf0a4f0 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithAccessors.md @@ -0,0 +1,101 @@ +# Class: ClassWithAccessors + +Comments for ClassWithAccessors + +## Constructors + +### new ClassWithAccessors() + +```ts +new ClassWithAccessors(): ClassWithAccessors +``` + +#### Returns + +[`ClassWithAccessors`](ClassWithAccessors.md) + +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `privateProp` | `private` | `string` | + +## Accessors + +### accessor + +#### Get Signature + +```ts +get accessor(): string +``` + +Comments for getter + +##### Returns + +`string` + +#### Set Signature + +```ts +set accessor(value: string): void +``` + +Comments for setter + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `value` | `string` | Param comments | + +##### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### noGetter + +#### Set Signature + +```ts +set noGetter(x: string): void +``` + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `x` | `string` | + +##### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### noSetter + +#### Get Signature + +```ts +get noSetter(): string +``` + +##### Returns + +`string` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithComplexProps.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithComplexProps.md new file mode 100644 index 000000000..7c571dc7c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithComplexProps.md @@ -0,0 +1,23 @@ +# Class: ClassWithComplexProps + +Comments for ClassWithComplexProps + +## Constructors + +### new ClassWithComplexProps() + +```ts +new ClassWithComplexProps(): ClassWithComplexProps +``` + +#### Returns + +[`ClassWithComplexProps`](ClassWithComplexProps.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `objecLiteralProp` | `object` | - | +| `objecLiteralProp.someFunction` | (`a`: `string`) => `string` | Comments for someFunction | +| `objecLiteralProp.someProp` | `string` | Comments for someProp | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithConstructorOverloads.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithConstructorOverloads.md new file mode 100644 index 000000000..42a1060f3 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithConstructorOverloads.md @@ -0,0 +1,66 @@ +# Class: ClassWithConstructorOverloads + +Comments for ClassWithConstructorOverloads + +## Constructors + +### new ClassWithConstructorOverloads() + +```ts +new ClassWithConstructorOverloads(x: number, y: string): ClassWithConstructorOverloads +``` + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `x` | `number` | Comments for x number | +| `y` | `string` | | + +#### Returns + +[`ClassWithConstructorOverloads`](ClassWithConstructorOverloads.md) + +#### Source + +[classes.ts:1](http://source-url) + +### new ClassWithConstructorOverloads() + +```ts +new ClassWithConstructorOverloads(x: string): ClassWithConstructorOverloads +``` + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `x` | `string` | Comments for x string | + +#### Returns + +[`ClassWithConstructorOverloads`](ClassWithConstructorOverloads.md) + +#### Source + +[classes.ts:1](http://source-url) + +### new ClassWithConstructorOverloads() + +```ts +new ClassWithConstructorOverloads(s: string): ClassWithConstructorOverloads +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `s` | `string` | + +#### Returns + +[`ClassWithConstructorOverloads`](ClassWithConstructorOverloads.md) + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithFlags.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithFlags.md new file mode 100644 index 000000000..6ba5154c5 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithFlags.md @@ -0,0 +1,58 @@ +# Class: ClassWithFlags + +Comment for ClassWithFlags + +## Constructors + +### new ClassWithFlags() + +```ts +new ClassWithFlags(): ClassWithFlags +``` + +#### Returns + +[`ClassWithFlags`](ClassWithFlags.md) + +## Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `expermintalProp` | `public` | `string` | **`Experimental`** | +| `internalProp` | `private` | `string` | **`Internal`** | + +## Methods + +### expermintalMethod() + +```ts +expermintalMethod(): void +``` + +**`Experimental`** + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### internalMethod() + +```ts +protected internalMethod(): void +``` + +**`Internal`** + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithModifiers.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithModifiers.md new file mode 100644 index 000000000..5e58d2f80 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithModifiers.md @@ -0,0 +1,79 @@ +# Class: `abstract` ClassWithModifiers + +Comments for ClassWithModifiers + +## Constructors + +### new ClassWithModifiers() + +```ts +new ClassWithModifiers(): ClassWithModifiers +``` + +#### Returns + +[`ClassWithModifiers`](ClassWithModifiers.md) + +## Properties + +| Property | Modifier | Type | Default value | Description | +| :------ | :------ | :------ | :------ | :------ | +| `privateProp` | `private` | `string` | `undefined` | Comments for privateProp | +| `protectedProp` | `protected` | `string` | `undefined` | Comments for protectedProp | +| `publicPropWithDefault` | `public` | `string` | `'propWithDefault'` | Comments for propWithDefault | +| `readonlyProp` | `readonly` | `string` | `undefined` | Comments for abstractProperty | +| `staticProp` | `static` | `string` | `undefined` | Comments for staticProp | + +## Methods + +### privateMethod() + +```ts +private privateMethod(): void +``` + +Comment for privateMethod + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### publicMethod() + +```ts +publicMethod(): void +``` + +Comment for publicMethod + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### staticMethod() + +```ts +static staticMethod(): void +``` + +Comment for staticMethod + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithPropCategories.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithPropCategories.md new file mode 100644 index 000000000..626419d7a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithPropCategories.md @@ -0,0 +1,81 @@ +# Class: ClassWithPropCategories + +## Constructors + +### new ClassWithPropCategories() + +```ts +new ClassWithPropCategories(opts: object): ClassWithPropCategories +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `opts` | \{ `a`: `string`; `b`: `string`; \} | +| `opts.a` | `string` | +| `opts.b` | `string` | + +#### Returns + +[`ClassWithPropCategories`](ClassWithPropCategories.md) + +#### Source + +[classes.ts:1](http://source-url) + +## CatA + +### prop1 + +```ts +prop1: string; +``` + +#### Source + +[classes.ts:1](http://source-url) + +## CatB + +### prop2 + +```ts +prop2: string; +``` + +#### Source + +[classes.ts:1](http://source-url) + +## Other + +### method1() + +```ts +method1(): void +``` + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### method2() + +```ts +method2(): void +``` + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithSimpleProps.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithSimpleProps.md new file mode 100644 index 000000000..77af27bf2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithSimpleProps.md @@ -0,0 +1,24 @@ +# Class: ClassWithSimpleProps + +Comments for ClassWithSimpleProps + +## Constructors + +### new ClassWithSimpleProps() + +```ts +new ClassWithSimpleProps(): ClassWithSimpleProps +``` + +#### Returns + +[`ClassWithSimpleProps`](ClassWithSimpleProps.md) + +## Properties + +| Property | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `propA` | `string` | `'propAValue'` | Comments for propA | +| `propB` | `string` | `'propBDefaultValue'` | Comments for propB | +| `propC` | `string` | `'propCDefaultValue'` | Comments for propB on two lines | +| `propD` | `string` | `undefined` | Comments for propE | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithSymbols.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithSymbols.md new file mode 100644 index 000000000..0c6644583 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithSymbols.md @@ -0,0 +1,35 @@ +# Class: ClassWithSymbols + +## Constructors + +### new ClassWithSymbols() + +```ts +new ClassWithSymbols(): ClassWithSymbols +``` + +#### Returns + +[`ClassWithSymbols`](ClassWithSymbols.md) + +## Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `[symbolConst]?` | `static` | () => `void` | + +## Methods + +### \[dispose\]() + +```ts +dispose: void +``` + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithTypeParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithTypeParameters.md new file mode 100644 index 000000000..2c3cae64e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithTypeParameters.md @@ -0,0 +1,23 @@ +# Class: ClassWithTypeParameters\ + +Comments for ClassWithTypeParameters + +## Type Parameters + +| Type Parameter | Default type | Description | +| :------ | :------ | :------ | +| `A` | - | - | +| `B` *extends* `string` | - | Comments for param B | +| `C` | `boolean` | Comments for param C | + +## Constructors + +### new ClassWithTypeParameters() + +```ts +new ClassWithTypeParameters(): ClassWithTypeParameters +``` + +#### Returns + +[`ClassWithTypeParameters`](ClassWithTypeParameters.md)\<`A`, `B`, `C`\> diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithoutPropCategories.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithoutPropCategories.md new file mode 100644 index 000000000..ccde7c93f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/ClassWithoutPropCategories.md @@ -0,0 +1,64 @@ +# Class: ClassWithoutPropCategories + +## Constructors + +### new ClassWithoutPropCategories() + +```ts +new ClassWithoutPropCategories(opts: object): ClassWithoutPropCategories +``` + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `opts` | \{ `a`: `string`; `b`: `string`; \} | +| `opts.a` | `string` | +| `opts.b` | `string` | + +#### Returns + +[`ClassWithoutPropCategories`](ClassWithoutPropCategories.md) + +#### Source + +[classes.ts:1](http://source-url) + +## Properties + +| Property | Type | +| :------ | :------ | +| `prop1` | `string` | +| `prop2` | `string` | + +## Methods + +### method1() + +```ts +method1(): void +``` + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### method2() + +```ts +method2(): void +``` + +#### Returns + +`void` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/DerivedClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/DerivedClassA.md new file mode 100644 index 000000000..b02f4b630 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/DerivedClassA.md @@ -0,0 +1,68 @@ +# Class: DerivedClassA + +Comments for DerivedClassA + +## Extends + +- [`AbstractClass`](AbstractClass.md) + +## Constructors + +### new DerivedClassA() + +```ts +new DerivedClassA(): DerivedClassA +``` + +#### Returns + +[`DerivedClassA`](DerivedClassA.md) + +#### Inherited from + +[`AbstractClass`](AbstractClass.md).[`constructor`](AbstractClass.md#constructors) + +## Properties + +| Property | Type | Default value | Description | Overrides | +| :------ | :------ | :------ | :------ | :------ | +| `abstractProp` | `string` | `'abstractProp'` | Comments for abstractProp | [`AbstractClass`](AbstractClass.md).`abstractProp` | +| `derivedProp` | `string` | `undefined` | - | - | + +## Methods + +### abstractMethod() + +```ts +abstractMethod(): string +``` + +Comments for abstractMethod + +#### Returns + +`string` + +#### Overrides + +[`AbstractClass`](AbstractClass.md).[`abstractMethod`](AbstractClass.md#abstractmethod) + +#### Source + +[classes.ts:1](http://source-url) + +*** + +### derivedMethod() + +```ts +derivedMethod(): string +``` + +#### Returns + +`string` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/DerivedClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/DerivedClassB.md new file mode 100644 index 000000000..2fa90deb2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/DerivedClassB.md @@ -0,0 +1,51 @@ +# Class: DerivedClassB + +Comments for DerivedClassB + +## Extends + +- [`AbstractClass`](AbstractClass.md) + +## Constructors + +### new DerivedClassB() + +```ts +new DerivedClassB(): DerivedClassB +``` + +#### Returns + +[`DerivedClassB`](DerivedClassB.md) + +#### Inherited from + +[`AbstractClass`](AbstractClass.md).[`constructor`](AbstractClass.md#constructors) + +## Properties + +| Property | Type | Default value | Description | Overrides | +| :------ | :------ | :------ | :------ | :------ | +| `abstractProp` | `string` | `'abstractProp'` | Comments for abstractProp | [`AbstractClass`](AbstractClass.md).`abstractProp` | + +## Methods + +### abstractMethod() + +```ts +abstractMethod(): string +``` + +Comments for abstractMethod + +#### Returns + +`string` + +#### Overrides + +[`AbstractClass`](AbstractClass.md).[`abstractMethod`](AbstractClass.md#abstractmethod) + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/DisposableClass.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/DisposableClass.md new file mode 100644 index 000000000..1a9c08b15 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/DisposableClass.md @@ -0,0 +1,37 @@ +# Class: DisposableClass + +## Implements + +- `Disposable` + +## Constructors + +### new DisposableClass() + +```ts +new DisposableClass(): DisposableClass +``` + +#### Returns + +[`DisposableClass`](DisposableClass.md) + +## Methods + +### \[dispose\]() + +```ts +dispose: void +``` + +#### Returns + +`void` + +#### Implementation of + +`Disposable.[dispose]` + +#### Source + +[classes.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/GrandChildClassA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/GrandChildClassA.md new file mode 100644 index 000000000..6b1171ff9 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/GrandChildClassA.md @@ -0,0 +1,21 @@ +# Class: GrandChildClassA + +## Extends + +- [`ChildClassA`](ChildClassA.md) + +## Constructors + +### new GrandChildClassA() + +```ts +new GrandChildClassA(): GrandChildClassA +``` + +#### Returns + +[`GrandChildClassA`](GrandChildClassA.md) + +#### Inherited from + +[`ChildClassA`](ChildClassA.md).[`constructor`](ChildClassA.md#constructors) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/GrandChildClassB.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/GrandChildClassB.md new file mode 100644 index 000000000..8dff5dca0 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/classes/GrandChildClassB.md @@ -0,0 +1,21 @@ +# Class: GrandChildClassB + +## Extends + +- [`ChildClassA`](ChildClassA.md) + +## Constructors + +### new GrandChildClassB() + +```ts +new GrandChildClassB(): GrandChildClassB +``` + +#### Returns + +[`GrandChildClassB`](GrandChildClassB.md) + +#### Inherited from + +[`ChildClassA`](ChildClassA.md).[`constructor`](ChildClassA.md#constructors) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/enumerations/BasicEnum.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/enumerations/BasicEnum.md new file mode 100644 index 000000000..f5bdd4a40 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/enumerations/BasicEnum.md @@ -0,0 +1,10 @@ +# Enumeration: BasicEnum + +Comments for enum + +## Enumeration Members + +| Enumeration Member | Value | Description | +| :------ | :------ | :------ | +| `MemberA` | `0` | Comments for MemberA | +| `MemberB` | `1` | Comments for MemberB | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/enumerations/EnumWithValues.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/enumerations/EnumWithValues.md new file mode 100644 index 000000000..b2e0aa640 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/enumerations/EnumWithValues.md @@ -0,0 +1,10 @@ +# Enumeration: EnumWithValues + +Comments for enum + +## Enumeration Members + +| Enumeration Member | Value | +| :------ | :------ | +| `MemberA` | `"UP"` | +| `MemberB` | `"DOWN"` | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/basicFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/basicFunction.md new file mode 100644 index 000000000..7b76c6095 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/basicFunction.md @@ -0,0 +1,25 @@ +# Function: basicFunction() + +```ts +function basicFunction(someParam: number): number +``` + +This is a function that is assigned to a variable. + +## See + +http://abc.com + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `someParam` | `number` | This is some numeric parameter. | + +## Returns + +`number` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/basicFunctionWithReturns.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/basicFunctionWithReturns.md new file mode 100644 index 000000000..473a3f7dc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/basicFunctionWithReturns.md @@ -0,0 +1,17 @@ +# Function: basicFunctionWithReturns() + +```ts +function basicFunctionWithReturns(): number +``` + +This is a function that is assigned to a variable. + +## Returns + +`number` + +This is a return value + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/curriedFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/curriedFunction.md new file mode 100644 index 000000000..9b9a4e111 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/curriedFunction.md @@ -0,0 +1,68 @@ +# Function: curriedFunction() + +Comments for main curriedFunction + +## Call Signature + +```ts +function curriedFunction(searchElement: unknown): (iterable: Iterable) => boolean +``` + +Comments for current function 1 + +### Parameters + +| Parameter | Type | +| :------ | :------ | +| `searchElement` | `unknown` | + +### Returns + +`Function` + +#### Type Parameters + +| Type Parameter | +| :------ | +| `Value` | + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `iterable` | `Iterable`\<`Value`, `any`, `any`\> | Comments for iterable arg | + +#### Returns + +`boolean` + +### Source + +[functions.ts:1](http://source-url) + +## Call Signature + +```ts +function curriedFunction(searchElement: unknown, iterable: Iterable): string +``` + +### Type Parameters + +| Type Parameter | +| :------ | +| `Value` | + +### Parameters + +| Parameter | Type | +| :------ | :------ | +| `searchElement` | `unknown` | +| `iterable` | `Iterable`\<`Value`, `any`, `any`\> | + +### Returns + +`string` + +### Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAFunction.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAFunction.md new file mode 100644 index 000000000..3fd24e78c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAFunction.md @@ -0,0 +1,31 @@ +# Function: functionReturningAFunction() + +```ts +function functionReturningAFunction(): (x: string) => boolean +``` + +Comments for function + +## Returns + +`Function` + +### Type Parameters + +| Type Parameter | +| :------ | +| `T` | + +### Parameters + +| Parameter | Type | +| :------ | :------ | +| `x` | `string` | + +### Returns + +`boolean` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAPromise.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAPromise.md new file mode 100644 index 000000000..29cb0e506 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAPromise.md @@ -0,0 +1,21 @@ +# Function: functionReturningAPromise() + +```ts +function functionReturningAPromise(): Promise +``` + +Comments for function + +## Returns + +[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`object`\> + +Return comments + +| Name | Type | +| :------ | :------ | +| `prop` | `string` | + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAString.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAString.md new file mode 100644 index 000000000..6c15dcca1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAString.md @@ -0,0 +1,17 @@ +# Function: functionReturningAString() + +```ts +function functionReturningAString(): string +``` + +Comments for function + +## Returns + +`string` + +Return comments + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAUnionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAUnionType.md new file mode 100644 index 000000000..bdf312345 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAUnionType.md @@ -0,0 +1,17 @@ +# Function: functionReturningAUnionType() + +```ts +function functionReturningAUnionType(): string | boolean | "string1" | "string2" +``` + +Comments for function + +## Returns + +`string` \| `boolean` \| `"string1"` \| `"string2"` + +Return comments + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAnObject.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAnObject.md new file mode 100644 index 000000000..57ef673e2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionReturningAnObject.md @@ -0,0 +1,22 @@ +# Function: functionReturningAnObject() + +```ts +function functionReturningAnObject(): object +``` + +Comments for function + +## Returns + +`object` + +Return comments + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `x` | `number` | 1 | +| `y` | `number` | 2 | + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithArrayOfOptionalStuff.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithArrayOfOptionalStuff.md new file mode 100644 index 000000000..610ff96db --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithArrayOfOptionalStuff.md @@ -0,0 +1,21 @@ +# Function: functionWithArrayOfOptionalStuff() + +```ts +function functionWithArrayOfOptionalStuff(a: [Stuff?]): void +``` + +Comments for array of stuff? + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `a` | [[`Stuff`](../type-aliases/Stuff.md)?] | + +## Returns + +`void` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithArrayOfStuff.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithArrayOfStuff.md new file mode 100644 index 000000000..befd16653 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithArrayOfStuff.md @@ -0,0 +1,21 @@ +# Function: functionWithArrayOfStuff() + +```ts +function functionWithArrayOfStuff(a: [Stuff]): void +``` + +Comments for array of stuff + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `a` | [[`Stuff`](../type-aliases/Stuff.md)] | + +## Returns + +`void` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithComplexParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithComplexParams.md new file mode 100644 index 000000000..93d869e44 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithComplexParams.md @@ -0,0 +1,23 @@ +# Function: functionWithComplexParams() + +```ts +function functionWithComplexParams(paramA: (a: string) => true, paramB: object): boolean +``` + +Function with function parmas + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `paramA` | (`a`: `string`) => `true` | +| `paramB` | \{ `x`: `1`; \} | +| `paramB.x` | `1` | + +## Returns + +`boolean` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithDefaultParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithDefaultParameters.md new file mode 100644 index 000000000..38f852edf --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithDefaultParameters.md @@ -0,0 +1,32 @@ +# Function: functionWithDefaultParameters() + +```ts +function functionWithDefaultParameters( + valueA: string, + valueB: number, + valueC: number, + valueD: boolean, + valueE: boolean, + valueF: string): string +``` + +This is a function with a parameter that has a default value. + +## Parameters + +| Parameter | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `valueA` | `string` | `'defaultValue'` | A parameter with a default string value. | +| `valueB` | `number` | `100` | A parameter with a default numeric value. | +| `valueC` | `number` | `Number.NaN` | A parameter with a default NaN value. | +| `valueD` | `boolean` | `true` | A parameter with a default boolean value. | +| `valueE` | `boolean` | `true` | A parameter with a default null value. | +| `valueF` | `string` | `''` | - | + +## Returns + +`string` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithMultipleSignatures.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithMultipleSignatures.md new file mode 100644 index 000000000..6015f1795 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithMultipleSignatures.md @@ -0,0 +1,48 @@ +# Function: functionWithMultipleSignatures() + +Main function comment. + +## Call Signature + +```ts +function functionWithMultipleSignatures(value: string): string +``` + +This is the first signature of a function with multiple signatures. + +### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `value` | `string` | The name value. | + +### Returns + +`string` + +### Source + +[functions.ts:1](http://source-url) + +## Call Signature + +```ts +function functionWithMultipleSignatures(value: object): string +``` + +This is the second signature of a function with multiple signatures. + +### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `value` | \{ `name`: `string`; \} | An object containing the name value. | +| `value.name` | `string` | A value of the object. | + +### Returns + +`string` + +### Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithNamedParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithNamedParams.md new file mode 100644 index 000000000..bd9657150 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithNamedParams.md @@ -0,0 +1,22 @@ +# Function: functionWithNamedParams() + +```ts +function functionWithNamedParams(__namedParameters: object, anotherParam: string): void +``` + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `__namedParameters` | \{ `bar`: `number`; `foo`: `number`; \} | various options | +| `__namedParameters.bar`? | `number` | - | +| `__namedParameters.foo`? | `number` | - | +| `anotherParam` | `string` | Another param comment | + +## Returns + +`void` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithNestedParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithNestedParameters.md new file mode 100644 index 000000000..c0548bbae --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithNestedParameters.md @@ -0,0 +1,33 @@ +# Function: functionWithNestedParameters() + +```ts +function functionWithNestedParameters( + params: object, + context: any, + somethingElse?: string): boolean +``` + +Some nested params. + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `params` | \{ `name`: `string`; `nestedObj`: `object`; `parent`: `number`; \} | The parameters passed to the method. | +| `params.name` | `string` | The name of the new group. | +| `params.nestedObj` | \{ `name`: `string`; `obj`: `object`; `value`: `number`; \} | A nested object. | +| `params.nestedObj.name`? | `string` | - | +| `params.nestedObj.obj`? | \{ `name`: () => `void`; \} | - | +| `params.nestedObj.obj.name`? | () => `void` | - | +| `params.nestedObj.value`? | `number` | - | +| `params.parent`? | `number` | - | +| `context`? | `any` | The context of the method call. | +| `somethingElse`? | `string` | - | + +## Returns + +`boolean` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithOptionalParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithOptionalParameters.md new file mode 100644 index 000000000..a1f015319 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithOptionalParameters.md @@ -0,0 +1,28 @@ +# Function: functionWithOptionalParameters() + +```ts +function functionWithOptionalParameters( + firstParamWithDefault: boolean, + requiredParam: string, + optionalParam?: string, + paramWithDefault?: number): void +``` + +This is a function with a parameters. + +## Parameters + +| Parameter | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `firstParamWithDefault` | `boolean` | `true` | - | +| `requiredParam` | `string` | `undefined` | A normal parameter. | +| `optionalParam`? | `string` | `undefined` | An optional parameter. | +| `paramWithDefault`? | `number` | `0` | - | + +## Returns + +`void` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithRestParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithRestParams.md new file mode 100644 index 000000000..02cefbe97 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithRestParams.md @@ -0,0 +1,22 @@ +# Function: functionWithRestParams() + +```ts +function functionWithRestParams(param: string, ...restParams: string[]): boolean +``` + +Function with reset parmas + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `param` | `string` | +| ...`restParams` | `string`[] | + +## Returns + +`boolean` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithTypeParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithTypeParameters.md new file mode 100644 index 000000000..0a12a2cb8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithTypeParameters.md @@ -0,0 +1,22 @@ +# Function: functionWithTypeParameters() + +```ts +function functionWithTypeParameters(): boolean +``` + +Function with type parameters + +## Type Parameters + +| Type Parameter | Default type | Description | +| :------ | :------ | :------ | +| `T` | - | Comments for T | +| `Item` | `string` \| `boolean` | - | + +## Returns + +`boolean` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithUnionParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithUnionParams.md new file mode 100644 index 000000000..8b7adfecb --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/functions/functionWithUnionParams.md @@ -0,0 +1,31 @@ +# Function: functionWithUnionParams() + +```ts +function functionWithUnionParams( + primitiveUnions: string | number, + objectUnions: object, + mixedUnions: string | { + a: string; + b: string; + }, + noUnions: string): undefined +``` + +## Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `primitiveUnions` | `string` \| `number` | Comments for primitiveUnions | +| `objectUnions` | \{ `a`: `string`; `b`: `1`; \} | Comments for objectUnions | +| `objectUnions.a` | `string` | Comments for a | +| `objectUnions.b` | `1` | - | +| `mixedUnions` | `string` \| \{ `a`: `string`; `b`: `string`; \} | - | +| `noUnions` | `string` | Comments for noUnions | + +## Returns + +`undefined` + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/BasicInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/BasicInterface.md new file mode 100644 index 000000000..483587cfd --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/BasicInterface.md @@ -0,0 +1,30 @@ +# Interface: BasicInterface + +Comments for BasicInterface + +## Extended by + +- [`ExtendedInterface`](ExtendedInterface.md) + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| ~~`deprecatedProp`~~ | `string` | **Deprecated** This prop is deprecated **See** Comments for some tag | +| `functionProp` | (`s`: `string`) => `boolean` | Comments for functionProper | +| `optionalProp?` | `string` | Comments for optional prop | +| `prop` | `string` | Comments for prop | +| `propReturningObjectDeclaration` | `object` | Comments for propReturningObjectDeclaration | +| `propReturningObjectDeclaration.a` | `boolean` | - | +| `propReturningObjectDeclaration.b` | `string` | - | +| `propReturningObjectDeclarations` | `object` & `object` | Comments for propReturningObjectDeclarations | +| `propReturningSignatureDeclaration?` | () => `string` \| `number` \| `boolean` | Comments for propReturningSignatureDeclaration | +| `propReturningSignatureDeclarations` | () => `any` & (`paramsA`: `true` \| `any`[], `paramsB`?: `any`) => `any` & (`paramsC`: `any`) => `any` | Comments for propReturningSignatureDeclarations | +| `propWithFunction` | (`options`: `object`) => `boolean` | Comments for propWithFunction | +| `propWithProps` | `object` | Comments for propWithProps | +| `propWithProps.callbacks?` | `Partial`\<[`CallbacksOptions`](../classes/CallbacksOptions.md)\<[`DisposableClass`](../classes/DisposableClass.md), [`ClassWithModifiers`](../classes/ClassWithModifiers.md)\>\> | Comments for callbacks | +| `propWithProps.nestedPropA` | `string` | Comments for nestedPropA | +| `propWithProps.nestedPropB` | `boolean` | Comments for nestedPropB | +| `propWithProps.nestedPropC` | `object` | Comments for nestedPropC | +| `propWithProps.nestedPropC.nestedPropCA` | `string` | Comments for nestedPropCA | +| `propWithProps.nestedPropD` | () => `boolean` | Comments for nestedPropD | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/CustomEventInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/CustomEventInterface.md new file mode 100644 index 000000000..14e112071 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/CustomEventInterface.md @@ -0,0 +1,14 @@ +# Interface: CustomEventInterface\ + +## Type Parameters + +| Type Parameter | +| :------ | +| `T` | + +## Properties + +| Property | Type | +| :------ | :------ | +| `detail` | `string` | +| `target` | `T` | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/ExtendedInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/ExtendedInterface.md new file mode 100644 index 000000000..4c9ad8a36 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/ExtendedInterface.md @@ -0,0 +1,31 @@ +# Interface: ExtendedInterface + +Comments for ExtendedInterface + +## Extends + +- [`BasicInterface`](BasicInterface.md) + +## Properties + +| Property | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | +| ~~`deprecatedProp`~~ | `string` | **Deprecated** This prop is deprecated **See** Comments for some tag | [`BasicInterface`](BasicInterface.md).`deprecatedProp` | +| `extendedProp` | `string` | - | - | +| `functionProp` | (`s`: `string`) => `boolean` | Comments for functionProper | [`BasicInterface`](BasicInterface.md).`functionProp` | +| `optionalProp?` | `string` | Comments for optional prop | [`BasicInterface`](BasicInterface.md).`optionalProp` | +| `prop` | `string` | Comments for prop | [`BasicInterface`](BasicInterface.md).`prop` | +| `propReturningObjectDeclaration` | `object` | Comments for propReturningObjectDeclaration | [`BasicInterface`](BasicInterface.md).`propReturningObjectDeclaration` | +| `propReturningObjectDeclaration.a` | `boolean` | - | - | +| `propReturningObjectDeclaration.b` | `string` | - | - | +| `propReturningObjectDeclarations` | `object` & `object` | Comments for propReturningObjectDeclarations | [`BasicInterface`](BasicInterface.md).`propReturningObjectDeclarations` | +| `propReturningSignatureDeclaration?` | () => `string` \| `number` \| `boolean` | Comments for propReturningSignatureDeclaration | [`BasicInterface`](BasicInterface.md).`propReturningSignatureDeclaration` | +| `propReturningSignatureDeclarations` | () => `any` & (`paramsA`: `true` \| `any`[], `paramsB`?: `any`) => `any` & (`paramsC`: `any`) => `any` | Comments for propReturningSignatureDeclarations | [`BasicInterface`](BasicInterface.md).`propReturningSignatureDeclarations` | +| `propWithFunction` | (`options`: `object`) => `boolean` | Comments for propWithFunction | [`BasicInterface`](BasicInterface.md).`propWithFunction` | +| `propWithProps` | `object` | Comments for propWithProps | [`BasicInterface`](BasicInterface.md).`propWithProps` | +| `propWithProps.callbacks?` | `Partial`\<[`CallbacksOptions`](../classes/CallbacksOptions.md)\<[`DisposableClass`](../classes/DisposableClass.md), [`ClassWithModifiers`](../classes/ClassWithModifiers.md)\>\> | Comments for callbacks | - | +| `propWithProps.nestedPropA` | `string` | Comments for nestedPropA | - | +| `propWithProps.nestedPropB` | `boolean` | Comments for nestedPropB | - | +| `propWithProps.nestedPropC` | `object` | Comments for nestedPropC | - | +| `propWithProps.nestedPropC.nestedPropCA` | `string` | Comments for nestedPropCA | - | +| `propWithProps.nestedPropD` | () => `boolean` | Comments for nestedPropD | - | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/IndexableInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/IndexableInterface.md new file mode 100644 index 000000000..f77b931b4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/IndexableInterface.md @@ -0,0 +1,13 @@ +# Interface: IndexableInterface + +Comments for IndexableInterface + +## Indexable + + \[`s`: `string`\]: `string` + +## Properties + +| Property | Type | +| :------ | :------ | +| `prop` | `string` | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/InterfaceWithComments.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/InterfaceWithComments.md new file mode 100644 index 000000000..9a12c9c2a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/InterfaceWithComments.md @@ -0,0 +1,21 @@ +# Interface: InterfaceWithComments\ + +Comments for interface +over two lines + +And some more comments + +## Type Parameters + +| Type Parameter | Description | +| :------ | :------ | +| `A` | This is a parameter. | +| `B` | Comments for a parameter. This sentence is on a soft new line. | +| `C` | This is a parameter. Documentation with a double line | +| `D` |

These are comments with paras

These are comments with paras

Other comments Comments with

paras

These are comments with paras

| + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| ~~`propertyWithComments`~~ | `string` | Some text. - list item - list item **Deprecated** This is a deprecated property **See** https://example.com | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/InterfaceWithEventProperties.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/InterfaceWithEventProperties.md new file mode 100644 index 000000000..0c6231ab7 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/InterfaceWithEventProperties.md @@ -0,0 +1,14 @@ +# Interface: InterfaceWithEventProperties + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `someProp?` | `boolean` | Description for prop someProp | + +## Events + +| Event | Type | Description | +| :------ | :------ | :------ | +| `anotherEvent` | `MouseEvent` | - | +| ~~`someEvent?`~~ | (`eventParam`: [`CustomEventInterface`](CustomEventInterface.md)\<`MouseEvent`\>) => `void` | Description for event someEvent **Deprecated** Deprectaed comments | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/InterfaceWithFlags.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/InterfaceWithFlags.md new file mode 100644 index 000000000..8606e3605 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/InterfaceWithFlags.md @@ -0,0 +1,10 @@ +# Interface: InterfaceWithFlags + +Comments for InterfaceWithFlags + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `expermintalProp?` | `string` | **`Experimental`** | +| `internalProp` | `string` | **`Internal`** Comments for internalProp | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/InterfaceWithTypeParameters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/InterfaceWithTypeParameters.md new file mode 100644 index 000000000..4b7dda8cc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/InterfaceWithTypeParameters.md @@ -0,0 +1,15 @@ +# Interface: InterfaceWithTypeParameters\ + +Comments for InterfaceWithTypeParameters + +## Type Parameters + +| Type Parameter | +| :------ | +| `A` | + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `prop` | `A` | Comments for prop | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/MultipleIndexableInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/MultipleIndexableInterface.md new file mode 100644 index 000000000..46750f398 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/interfaces/MultipleIndexableInterface.md @@ -0,0 +1,13 @@ +# Interface: MultipleIndexableInterface + +## Indexable + + \[`key`: `string`\]: `string` + + \[`index`: `number`\]: `string` + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `prop` | `string` | Prop | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/sidebar.json new file mode 100644 index 000000000..de5681eaf --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/sidebar.json @@ -0,0 +1,442 @@ +[ + { + "title": "Enumerations", + "children": [ + { + "title": "BasicEnum", + "kind": 8, + "path": "enumerations/BasicEnum.md" + }, + { + "title": "EnumWithValues", + "kind": 8, + "path": "enumerations/EnumWithValues.md" + } + ] + }, + { + "title": "Classes", + "children": [ + { + "title": "AbstractClass", + "kind": 128, + "path": "classes/AbstractClass.md" + }, + { + "title": "BaseClass", + "kind": 128, + "path": "classes/BaseClass.md" + }, + { + "title": "BasicClass", + "kind": 128, + "path": "classes/BasicClass.md" + }, + { + "title": "CallbacksOptions", + "kind": 128, + "path": "classes/CallbacksOptions.md" + }, + { + "title": "ChildClassA", + "kind": 128, + "path": "classes/ChildClassA.md" + }, + { + "title": "ChildClassB", + "kind": 128, + "path": "classes/ChildClassB.md" + }, + { + "title": "ClassWithAccessorKeywords", + "kind": 128, + "path": "classes/ClassWithAccessorKeywords.md" + }, + { + "title": "ClassWithAccessors", + "kind": 128, + "path": "classes/ClassWithAccessors.md" + }, + { + "title": "ClassWithComplexProps", + "kind": 128, + "path": "classes/ClassWithComplexProps.md" + }, + { + "title": "ClassWithConstructorOverloads", + "kind": 128, + "path": "classes/ClassWithConstructorOverloads.md" + }, + { + "title": "ClassWithFlags", + "kind": 128, + "path": "classes/ClassWithFlags.md" + }, + { + "title": "ClassWithModifiers", + "kind": 128, + "path": "classes/ClassWithModifiers.md" + }, + { + "title": "ClassWithoutPropCategories", + "kind": 128, + "path": "classes/ClassWithoutPropCategories.md" + }, + { + "title": "ClassWithPropCategories", + "kind": 128, + "path": "classes/ClassWithPropCategories.md" + }, + { + "title": "ClassWithSimpleProps", + "kind": 128, + "path": "classes/ClassWithSimpleProps.md" + }, + { + "title": "ClassWithSymbols", + "kind": 128, + "path": "classes/ClassWithSymbols.md" + }, + { + "title": "ClassWithTypeParameters", + "kind": 128, + "path": "classes/ClassWithTypeParameters.md" + }, + { + "title": "DerivedClassA", + "kind": 128, + "path": "classes/DerivedClassA.md" + }, + { + "title": "DerivedClassB", + "kind": 128, + "path": "classes/DerivedClassB.md" + }, + { + "title": "DisposableClass", + "kind": 128, + "path": "classes/DisposableClass.md" + }, + { + "title": "GrandChildClassA", + "kind": 128, + "path": "classes/GrandChildClassA.md" + }, + { + "title": "GrandChildClassB", + "kind": 128, + "path": "classes/GrandChildClassB.md" + } + ] + }, + { + "title": "Interfaces", + "children": [ + { + "title": "BasicInterface", + "kind": 256, + "path": "interfaces/BasicInterface.md" + }, + { + "title": "CustomEventInterface", + "kind": 256, + "path": "interfaces/CustomEventInterface.md" + }, + { + "title": "ExtendedInterface", + "kind": 256, + "path": "interfaces/ExtendedInterface.md" + }, + { + "title": "IndexableInterface", + "kind": 256, + "path": "interfaces/IndexableInterface.md" + }, + { + "title": "InterfaceWithComments", + "kind": 256, + "path": "interfaces/InterfaceWithComments.md" + }, + { + "title": "InterfaceWithEventProperties", + "kind": 256, + "path": "interfaces/InterfaceWithEventProperties.md" + }, + { + "title": "InterfaceWithFlags", + "kind": 256, + "path": "interfaces/InterfaceWithFlags.md" + }, + { + "title": "InterfaceWithTypeParameters", + "kind": 256, + "path": "interfaces/InterfaceWithTypeParameters.md" + }, + { + "title": "MultipleIndexableInterface", + "kind": 256, + "path": "interfaces/MultipleIndexableInterface.md" + } + ] + }, + { + "title": "Type Aliases", + "children": [ + { + "title": "__TypeDeclarationWithSpecialCharacters_", + "kind": 2097152, + "path": "type-aliases/TypeDeclarationWithSpecialCharacters.md" + }, + { + "title": "ArrayOfStuff", + "kind": 2097152, + "path": "type-aliases/ArrayOfStuff.md" + }, + { + "title": "ArrayType", + "kind": 2097152, + "path": "type-aliases/ArrayType.md" + }, + { + "title": "ConditionalType", + "kind": 2097152, + "path": "type-aliases/ConditionalType.md" + }, + { + "title": "ExternalReferenceType", + "kind": 2097152, + "path": "type-aliases/ExternalReferenceType.md" + }, + { + "title": "FunctionType", + "kind": 2097152, + "path": "type-aliases/FunctionType.md" + }, + { + "title": "IndexAccessType", + "kind": 2097152, + "path": "type-aliases/IndexAccessType.md" + }, + { + "title": "IntersectionType", + "kind": 2097152, + "path": "type-aliases/IntersectionType.md" + }, + { + "title": "LiteralType", + "kind": 2097152, + "path": "type-aliases/LiteralType.md" + }, + { + "title": "PartialMappedType", + "kind": 2097152, + "path": "type-aliases/PartialMappedType.md" + }, + { + "title": "PrimitiveType", + "kind": 2097152, + "path": "type-aliases/PrimitiveType.md" + }, + { + "title": "PromiseTypeWithObject", + "kind": 2097152, + "path": "type-aliases/PromiseTypeWithObject.md" + }, + { + "title": "PromiseTypeWithSymbol", + "kind": 2097152, + "path": "type-aliases/PromiseTypeWithSymbol.md" + }, + { + "title": "QueryType", + "kind": 2097152, + "path": "type-aliases/QueryType.md" + }, + { + "title": "ReadonlyMappedType", + "kind": 2097152, + "path": "type-aliases/ReadonlyMappedType.md" + }, + { + "title": "StringLiteralType", + "kind": 2097152, + "path": "type-aliases/StringLiteralType.md" + }, + { + "title": "Stuff", + "kind": 2097152, + "path": "type-aliases/Stuff.md" + }, + { + "title": "TupleType", + "kind": 2097152, + "path": "type-aliases/TupleType.md" + }, + { + "title": "TypeWithExternalSymbolLinkMapping", + "kind": 2097152, + "path": "type-aliases/TypeWithExternalSymbolLinkMapping.md" + }, + { + "title": "TypeWithReturns", + "kind": 2097152, + "path": "type-aliases/TypeWithReturns.md" + }, + { + "title": "TypeWithTypeParams", + "kind": 2097152, + "path": "type-aliases/TypeWithTypeParams.md" + }, + { + "title": "UnionType", + "kind": 2097152, + "path": "type-aliases/UnionType.md" + }, + { + "title": "UnionTypeWithTemplateStrings", + "kind": 2097152, + "path": "type-aliases/UnionTypeWithTemplateStrings.md" + }, + { + "title": "UsefulUnionType", + "kind": 2097152, + "path": "type-aliases/UsefulUnionType.md" + } + ] + }, + { + "title": "Variables", + "children": [ + { + "title": "objectLiteralVariable", + "kind": 32, + "path": "variables/objectLiteralVariable.md" + }, + { + "title": "objectWithSymbol", + "kind": 32, + "path": "variables/objectWithSymbol.md" + }, + { + "title": "someQuery", + "kind": 32, + "path": "variables/someQuery.md" + }, + { + "title": "stringVariable", + "kind": 32, + "path": "variables/stringVariable.md" + }, + { + "title": "templateVariableString", + "kind": 32, + "path": "variables/templateVariableString.md" + }, + { + "title": "typeOperatorVariable", + "kind": 32, + "path": "variables/typeOperatorVariable.md" + } + ] + }, + { + "title": "Functions", + "children": [ + { + "title": "basicFunction", + "kind": 64, + "path": "functions/basicFunction.md" + }, + { + "title": "basicFunctionWithReturns", + "kind": 64, + "path": "functions/basicFunctionWithReturns.md" + }, + { + "title": "curriedFunction", + "kind": 64, + "path": "functions/curriedFunction.md" + }, + { + "title": "functionReturningAFunction", + "kind": 64, + "path": "functions/functionReturningAFunction.md" + }, + { + "title": "functionReturningAnObject", + "kind": 64, + "path": "functions/functionReturningAnObject.md" + }, + { + "title": "functionReturningAPromise", + "kind": 64, + "path": "functions/functionReturningAPromise.md" + }, + { + "title": "functionReturningAString", + "kind": 64, + "path": "functions/functionReturningAString.md" + }, + { + "title": "functionReturningAUnionType", + "kind": 64, + "path": "functions/functionReturningAUnionType.md" + }, + { + "title": "functionWithArrayOfOptionalStuff", + "kind": 64, + "path": "functions/functionWithArrayOfOptionalStuff.md" + }, + { + "title": "functionWithArrayOfStuff", + "kind": 64, + "path": "functions/functionWithArrayOfStuff.md" + }, + { + "title": "functionWithComplexParams", + "kind": 64, + "path": "functions/functionWithComplexParams.md" + }, + { + "title": "functionWithDefaultParameters", + "kind": 64, + "path": "functions/functionWithDefaultParameters.md" + }, + { + "title": "functionWithMultipleSignatures", + "kind": 64, + "path": "functions/functionWithMultipleSignatures.md" + }, + { + "title": "functionWithNamedParams", + "kind": 64, + "path": "functions/functionWithNamedParams.md" + }, + { + "title": "functionWithNestedParameters", + "kind": 64, + "path": "functions/functionWithNestedParameters.md" + }, + { + "title": "functionWithOptionalParameters", + "kind": 64, + "path": "functions/functionWithOptionalParameters.md" + }, + { + "title": "functionWithRestParams", + "kind": 64, + "path": "functions/functionWithRestParams.md" + }, + { + "title": "functionWithTypeParameters", + "kind": 64, + "path": "functions/functionWithTypeParameters.md" + }, + { + "title": "functionWithUnionParams", + "kind": 64, + "path": "functions/functionWithUnionParams.md" + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ArrayOfStuff.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ArrayOfStuff.md new file mode 100644 index 000000000..281a2b22e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ArrayOfStuff.md @@ -0,0 +1,9 @@ +# Type Alias: ArrayOfStuff + +```ts +type ArrayOfStuff: object[]; +``` + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ArrayType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ArrayType.md new file mode 100644 index 000000000..6a5cb14f8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ArrayType.md @@ -0,0 +1,11 @@ +# Type Alias: ArrayType + +```ts +type ArrayType: string[]; +``` + +Comments for ArrayType + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ConditionalType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ConditionalType.md new file mode 100644 index 000000000..3e4005825 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ConditionalType.md @@ -0,0 +1,17 @@ +# Type Alias: ConditionalType\ + +```ts +type ConditionalType: T extends string ? "string" : T extends number ? "number" : T extends boolean ? "boolean" : T extends undefined ? "undefined" : "object"; +``` + +Comments for ConditionalType + +## Type Parameters + +| Type Parameter | +| :------ | +| `T` | + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ExternalReferenceType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ExternalReferenceType.md new file mode 100644 index 000000000..82404de2a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ExternalReferenceType.md @@ -0,0 +1,11 @@ +# Type Alias: ExternalReferenceType + +```ts +type ExternalReferenceType: ClassWithTypeParameters<"x", "y">; +``` + +Comments for ExternalReferenceType + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/FunctionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/FunctionType.md new file mode 100644 index 000000000..1283c0ff3 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/FunctionType.md @@ -0,0 +1,22 @@ +# Type Alias: FunctionType() + +```ts +type FunctionType: (name: string, value: unknown) => void; +``` + +Comments for FunctionType + +## Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | +| `value` | `unknown` | + +## Returns + +`void` + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/IndexAccessType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/IndexAccessType.md new file mode 100644 index 000000000..49407f0dc --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/IndexAccessType.md @@ -0,0 +1,11 @@ +# Type Alias: IndexAccessType + +```ts +type IndexAccessType: ArrayOfStuff[number]; +``` + +Comments for IndexAccessType + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/IntersectionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/IntersectionType.md new file mode 100644 index 000000000..625d4ab91 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/IntersectionType.md @@ -0,0 +1,17 @@ +# Type Alias: IntersectionType + +```ts +type IntersectionType: TupleType & ArrayType & object; +``` + +Comments for IntersectionType + +## Type declaration + +| Name | Type | +| :------ | :------ | +| `bar` | `number` | + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/LiteralType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/LiteralType.md new file mode 100644 index 000000000..e5613f560 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/LiteralType.md @@ -0,0 +1,28 @@ +# Type Alias: LiteralType + +```ts +type LiteralType: object; +``` + +Comments for LiteralType + +## Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `someFunctionWithArrow` | () => `string` | Comments for someFunctionWithArrow | +| `x`? | `string` | comment for x | +| `y` | `object` | comment for y | +| `y.x` | `string` | comment for y.x | +| `y.y`? | `boolean` \| `string` | comment for y.y | +| `y.z` | (`x`: `string`) => `string` | comment for y.z | +| `z` | (`x`: `string`) => `string` | - | +| `get accessorA` | [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\> | Comments for accessorA getter | +| `set accessorA` | `void` | Comments for accessorA setter | +| `get accessorB` | `string` | - | +| `set accessorB` | `void` | - | +| `someFunction()` | [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | Comments for someFunction | + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/PartialMappedType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/PartialMappedType.md new file mode 100644 index 000000000..6309ff737 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/PartialMappedType.md @@ -0,0 +1,17 @@ +# Type Alias: PartialMappedType\ + +```ts +type PartialMappedType: { [P in keyof T]?: T[P] }; +``` + +Comments for PartialMappedType + +## Type Parameters + +| Type Parameter | +| :------ | +| `T` | + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/PrimitiveType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/PrimitiveType.md new file mode 100644 index 000000000..f57a8d0cb --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/PrimitiveType.md @@ -0,0 +1,11 @@ +# Type Alias: PrimitiveType + +```ts +type PrimitiveType: boolean; +``` + +Comments for PrimitiveType + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/PromiseTypeWithObject.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/PromiseTypeWithObject.md new file mode 100644 index 000000000..c703f9921 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/PromiseTypeWithObject.md @@ -0,0 +1,17 @@ +# Type Alias: PromiseTypeWithObject + +```ts +type PromiseTypeWithObject: Promise; +``` + +Comments for promise type returning object + +## Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `x` | `1` | comments for x | + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/PromiseTypeWithSymbol.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/PromiseTypeWithSymbol.md new file mode 100644 index 000000000..32a79fb5d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/PromiseTypeWithSymbol.md @@ -0,0 +1,11 @@ +# Type Alias: PromiseTypeWithSymbol + +```ts +type PromiseTypeWithSymbol: Promise; +``` + +Comments for promise type returning symbol + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/QueryType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/QueryType.md new file mode 100644 index 000000000..e40846972 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/QueryType.md @@ -0,0 +1,11 @@ +# Type Alias: QueryType + +```ts +type QueryType: typeof someQuery; +``` + +Comments for query type + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ReadonlyMappedType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ReadonlyMappedType.md new file mode 100644 index 000000000..640d743c8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/ReadonlyMappedType.md @@ -0,0 +1,17 @@ +# Type Alias: ReadonlyMappedType\ + +```ts +type ReadonlyMappedType: { readonly [P in keyof T]: T[P] }; +``` + +Comments for ReadonlyMapedType + +## Type Parameters + +| Type Parameter | +| :------ | +| `T` | + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/StringLiteralType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/StringLiteralType.md new file mode 100644 index 000000000..c777a2834 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/StringLiteralType.md @@ -0,0 +1,17 @@ +# Type Alias: StringLiteralType + +```ts +type StringLiteralType: + | " " + | "string" + | "string|with|pipes" + | "string`with`backticks" + | "" + | "*"; +``` + +Comments for StringLiteralType + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/Stuff.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/Stuff.md new file mode 100644 index 000000000..ccf220a51 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/Stuff.md @@ -0,0 +1,16 @@ +# Type Alias: Stuff + +```ts +type Stuff: object; +``` + +## Type declaration + +| Name | Type | +| :------ | :------ | +| `a` | `string` | +| `b` | `string` | + +## Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TupleType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TupleType.md new file mode 100644 index 000000000..6c043d536 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TupleType.md @@ -0,0 +1,11 @@ +# Type Alias: TupleType + +```ts +type TupleType: [string, number]; +``` + +Comments for TupleType + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TypeDeclarationWithSpecialCharacters.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TypeDeclarationWithSpecialCharacters.md new file mode 100644 index 000000000..0a6500968 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TypeDeclarationWithSpecialCharacters.md @@ -0,0 +1,43 @@ +# Type Alias: \_\_TypeDeclarationWithSpecialCharacters\_\ + +```ts +type __TypeDeclarationWithSpecialCharacters_: object; +``` + +Comments for object with special characters + +## Type Parameters + +| Type Parameter | +| :------ | +| `T` | +| `U` | + +## Type declaration + +| Name | Type | +| :------ | :------ | +| `_` | `"_"` | +| `_foo_` | `"_foo_"` | +| `_prop_with_underscore_` | `"_prop_with_underscore_"` | +| `_x` | (`_param`: `T`) => `U` | +| `?` | `T` \| `U` | +| `{prop-with-brackets}` | `"{prop-with-brackets}"` | +| `*` | `"*"` | +| `**foo**` | `"**foo**"` | +| `*foo*` | `"*foo*"` | +| \ | "\\" | +| \a | "\\a" | +| \n | "\\n" | +| \` | "\`" | +| \`prop\`with\`backticks\` | "\`prop\`with\`backticks\`" | +| `<` | `"<"` | +| `` | `""` | +| `>` | `">"` | +| \| | "\|" | +| \|prop\|with\|pipes\| | "\|prop\|with\|pipes\|" | +| `~` | `"~"` | + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TypeWithExternalSymbolLinkMapping.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TypeWithExternalSymbolLinkMapping.md new file mode 100644 index 000000000..b4868d426 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TypeWithExternalSymbolLinkMapping.md @@ -0,0 +1,11 @@ +# Type Alias: TypeWithExternalSymbolLinkMapping + +```ts +type TypeWithExternalSymbolLinkMapping: Application; +``` + +Comments for TypeWithExternalSymbolLinkMapping + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TypeWithReturns.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TypeWithReturns.md new file mode 100644 index 000000000..fdfdd0e6b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TypeWithReturns.md @@ -0,0 +1,15 @@ +# Type Alias: TypeWithReturns + +```ts +type TypeWithReturns: string; +``` + +Comments for TypeWithReturns + +## Returns + +- return comments. + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TypeWithTypeParams.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TypeWithTypeParams.md new file mode 100644 index 000000000..195fd325e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/TypeWithTypeParams.md @@ -0,0 +1,18 @@ +# Type Alias: TypeWithTypeParams\ + +```ts +type TypeWithTypeParams: [T, R]; +``` + +Comments for TypeWithTypeParams + +## Type Parameters + +| Type Parameter | +| :------ | +| `T` | +| `R` | + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/UnionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/UnionType.md new file mode 100644 index 000000000..38287cb9c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/UnionType.md @@ -0,0 +1,13 @@ +# Type Alias: UnionType + +```ts +type UnionType: string | boolean | { + z: string; +}; +``` + +Comments for UnionType + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/UnionTypeWithTemplateStrings.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/UnionTypeWithTemplateStrings.md new file mode 100644 index 000000000..0c638eb31 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/UnionTypeWithTemplateStrings.md @@ -0,0 +1,11 @@ +# Type Alias: UnionTypeWithTemplateStrings + +```ts +type UnionTypeWithTemplateStrings: `v${number}` | `v${number}.${number}` | `v${number}.${number}.${number}`; +``` + +Union with template strings + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/UsefulUnionType.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/UsefulUnionType.md new file mode 100644 index 000000000..94dad5fd3 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/type-aliases/UsefulUnionType.md @@ -0,0 +1,27 @@ +# Type Alias: UsefulUnionType + +```ts +type UsefulUnionType: string | boolean | { + z: string; +}; +``` + +Comments for useful UnionType + +## Type declaration + +`string` + +`boolean` + +\{ + `z`: `string`; + \} + +| Name | Type | Description | +| :------ | :------ | :------ | +| `z` | `string` | Comments for z | + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/objectLiteralVariable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/objectLiteralVariable.md new file mode 100644 index 000000000..0f1f45a6b --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/objectLiteralVariable.md @@ -0,0 +1,27 @@ +# Variable: objectLiteralVariable + +```ts +const objectLiteralVariable: object; +``` + +Comments for objectLiteralVariable + +## See + +xyz.com + +## Type declaration + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `valueA` | `number` | 100 | Comments for valueA | +| `valueB` | `boolean` | true | - | +| `valueX` | `object` | - | Comments for valueX | +| `valueX.valueA` | `number`[] | - | Comment for valueX.valueA | +| `valueX.valueY` | (`z`: `string`) => `object` | - | - | +| `valueX.valueZ` | `string` | 'foo' | - | +| `valueY` | (`unionParam`: `"a"` \| `"b"`, `_undercoreParam_`: `string`) => `string` | - | - | + +## Source + +[variables.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/objectWithSymbol.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/objectWithSymbol.md new file mode 100644 index 000000000..b44d2c59a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/objectWithSymbol.md @@ -0,0 +1,17 @@ +# Variable: objectWithSymbol + +```ts +const objectWithSymbol: object; +``` + +Comments variable with symbol + +## Type declaration + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `[sym]` | `string` | 'value' | Comments for symbol | + +## Source + +[variables.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/someQuery.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/someQuery.md new file mode 100644 index 000000000..0aa21f1ed --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/someQuery.md @@ -0,0 +1,9 @@ +# Variable: someQuery + +```ts +const someQuery: 1 = 1; +``` + +## Source + +[types.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/stringVariable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/stringVariable.md new file mode 100644 index 000000000..279d40c42 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/stringVariable.md @@ -0,0 +1,11 @@ +# Variable: stringVariable + +```ts +const stringVariable: "stringConstWithDefaultValue" = 'stringConstWithDefaultValue'; +``` + +A simple string variable + +## Source + +[variables.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/templateVariableString.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/templateVariableString.md new file mode 100644 index 000000000..700c9e25f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/templateVariableString.md @@ -0,0 +1,11 @@ +# Variable: templateVariableString + +```ts +const templateVariableString: "\nThis is a template string\n/* with a comment */\nAnd a \n"; +``` + +A template variable string + +## Source + +[variables.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/typeOperatorVariable.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/typeOperatorVariable.md new file mode 100644 index 000000000..bbe0b7025 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/members/opts-2/variables/typeOperatorVariable.md @@ -0,0 +1,11 @@ +# Variable: typeOperatorVariable + +```ts +const typeOperatorVariable: unique symbol; +``` + +Comments for typeOperatorVariable + +## Source + +[variables.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-1/README.md new file mode 100644 index 000000000..8bc10a451 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-1/README.md @@ -0,0 +1,9 @@ +# MY README + +> Some block quote + +Some text. + +## Readme heading + +Some text. diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-1/globals.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-1/globals.md new file mode 100644 index 000000000..d9265f2fb --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-1/globals.md @@ -0,0 +1,3339 @@ +# typedoc-stubs + +Module comments + +## Enumerations + +### BasicEnum + +Comments for enum + +#### Enumeration Members + +##### MemberA + +> **MemberA**: `0` + +Comments for MemberA + +###### Source + +[enums.ts:1](http://source-url) + +##### MemberB + +> **MemberB**: `1` + +Comments for MemberB + +###### Source + +[enums.ts:1](http://source-url) + +*** + +### EnumWithValues + +Comments for enum + +#### Enumeration Members + +##### MemberA + +> **MemberA**: `"UP"` + +###### Source + +[enums.ts:1](http://source-url) + +##### MemberB + +> **MemberB**: `"DOWN"` + +###### Source + +[enums.ts:1](http://source-url) + +## Classes + +### `abstract` AbstractClass + +#### Extended by + +- [`DerivedClassA`](globals.md#derivedclassa) +- [`DerivedClassB`](globals.md#derivedclassb) + +#### Constructors + +##### new AbstractClass() + +> **new AbstractClass**(): [`AbstractClass`](globals.md#abstractclass) + +###### Returns + +[`AbstractClass`](globals.md#abstractclass) + +#### Properties + +##### abstractProp + +> `abstract` **abstractProp**: `string` + +Comments for abstractProp + +###### Source + +[classes.ts:1](http://source-url) + +#### Methods + +##### abstractMethod() + +> `abstract` **abstractMethod**(): `string` + +Comments for abstractMethod + +###### Returns + +`string` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### BaseClass + +#### Extended by + +- [`ChildClassA`](globals.md#childclassa) +- [`ChildClassB`](globals.md#childclassb) + +#### Constructors + +##### new BaseClass() + +> **new BaseClass**(): [`BaseClass`](globals.md#baseclass) + +###### Returns + +[`BaseClass`](globals.md#baseclass) + +*** + +### BasicClass + +Comments for BasicClass + +#### Constructors + +##### new BasicClass() + +> **new BasicClass**(): [`BasicClass`](globals.md#basicclass) + +###### Returns + +[`BasicClass`](globals.md#basicclass) + +#### Properties + +##### prop + +> **prop**: `string` + +Comments for prop + +###### Source + +[classes.ts:1](http://source-url) + +#### Methods + +##### method() + +> **method**(): `string` + +Comments for method + +###### Returns + +`string` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### CallbacksOptions\ + +#### Type Parameters + +##### P + +Default type [`DisposableClass`](globals.md#disposableclass) + +##### A + +Default type [`ClassWithModifiers`](globals.md#classwithmodifiers) + +#### Constructors + +##### new CallbacksOptions() + +> **new CallbacksOptions**\<`P`, `A`\>(): [`CallbacksOptions`](globals.md#callbacksoptionsp-a)\<`P`, `A`\> + +###### Returns + +[`CallbacksOptions`](globals.md#callbacksoptionsp-a)\<`P`, `A`\> + +*** + +### ChildClassA + +#### Extends + +- [`BaseClass`](globals.md#baseclass) + +#### Extended by + +- [`GrandChildClassA`](globals.md#grandchildclassa) +- [`GrandChildClassB`](globals.md#grandchildclassb) + +#### Constructors + +##### new ChildClassA() + +> **new ChildClassA**(): [`ChildClassA`](globals.md#childclassa) + +###### Returns + +[`ChildClassA`](globals.md#childclassa) + +###### Inherited from + +[`BaseClass`](globals.md#baseclass).[`constructor`](globals.md#constructors-1) + +*** + +### ChildClassB + +#### Extends + +- [`BaseClass`](globals.md#baseclass) + +#### Constructors + +##### new ChildClassB() + +> **new ChildClassB**(): [`ChildClassB`](globals.md#childclassb) + +###### Returns + +[`ChildClassB`](globals.md#childclassb) + +###### Inherited from + +[`BaseClass`](globals.md#baseclass).[`constructor`](globals.md#constructors-1) + +*** + +### ClassWithAccessorKeywords + +#### Constructors + +##### new ClassWithAccessorKeywords() + +> **new ClassWithAccessorKeywords**(): [`ClassWithAccessorKeywords`](globals.md#classwithaccessorkeywords) + +###### Returns + +[`ClassWithAccessorKeywords`](globals.md#classwithaccessorkeywords) + +#### Accessors + +##### accessor1 + +Accessor comments + +###### Example + +```ts +const x = 1; +``` + +###### Source + +[classes.ts:1](http://source-url) + +##### accessor2 + +Accessor comments + +###### Remarks + +Remark comments + +###### Source + +[classes.ts:1](http://source-url) + +##### accessor3 + +Accessor comments + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### ClassWithAccessors + +Comments for ClassWithAccessors + +#### Constructors + +##### new ClassWithAccessors() + +> **new ClassWithAccessors**(): [`ClassWithAccessors`](globals.md#classwithaccessors) + +###### Returns + +[`ClassWithAccessors`](globals.md#classwithaccessors) + +#### Properties + +##### privateProp + +> `private` **privateProp**: `string` + +###### Source + +[classes.ts:1](http://source-url) + +#### Accessors + +##### accessor + +###### Get Signature + +> **get** **accessor**(): `string` + +Comments for getter + +###### Returns + +`string` + +###### Set Signature + +> **set** **accessor**(`value`): `void` + +Comments for setter + +###### Parameters + +###### value + +`string` + +Param comments + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +##### noGetter + +###### Set Signature + +> **set** **noGetter**(`x`): `void` + +###### Parameters + +###### x + +`string` + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +##### noSetter + +###### Get Signature + +> **get** **noSetter**(): `string` + +###### Returns + +`string` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### ClassWithComplexProps + +Comments for ClassWithComplexProps + +#### Constructors + +##### new ClassWithComplexProps() + +> **new ClassWithComplexProps**(): [`ClassWithComplexProps`](globals.md#classwithcomplexprops) + +###### Returns + +[`ClassWithComplexProps`](globals.md#classwithcomplexprops) + +#### Properties + +##### objecLiteralProp + +> **objecLiteralProp**: `object` + +###### someFunction() + +> **someFunction**: (`a`) => `string` + +Comments for someFunction + +###### Parameters + +###### a + +`string` + +###### Returns + +`string` + +###### someProp + +> **someProp**: `string` = `'someProp'` + +Comments for someProp + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### ClassWithConstructorOverloads + +Comments for ClassWithConstructorOverloads + +#### Constructors + +##### new ClassWithConstructorOverloads() + +> **new ClassWithConstructorOverloads**(`x`, `y`): [`ClassWithConstructorOverloads`](globals.md#classwithconstructoroverloads) + +###### Parameters + +###### x + +`number` + +Comments for x number + +###### y + +`string` + +###### Returns + +[`ClassWithConstructorOverloads`](globals.md#classwithconstructoroverloads) + +###### Source + +[classes.ts:1](http://source-url) + +##### new ClassWithConstructorOverloads() + +> **new ClassWithConstructorOverloads**(`x`): [`ClassWithConstructorOverloads`](globals.md#classwithconstructoroverloads) + +###### Parameters + +###### x + +`string` + +Comments for x string + +###### Returns + +[`ClassWithConstructorOverloads`](globals.md#classwithconstructoroverloads) + +###### Source + +[classes.ts:1](http://source-url) + +##### new ClassWithConstructorOverloads() + +> **new ClassWithConstructorOverloads**(`s`): [`ClassWithConstructorOverloads`](globals.md#classwithconstructoroverloads) + +###### Parameters + +###### s + +`string` + +###### Returns + +[`ClassWithConstructorOverloads`](globals.md#classwithconstructoroverloads) + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### ClassWithFlags + +Comment for ClassWithFlags + +#### Constructors + +##### new ClassWithFlags() + +> **new ClassWithFlags**(): [`ClassWithFlags`](globals.md#classwithflags) + +###### Returns + +[`ClassWithFlags`](globals.md#classwithflags) + +#### Properties + +##### expermintalProp + +> **expermintalProp**: `string` + +**`Experimental`** + +###### Source + +[classes.ts:1](http://source-url) + +##### internalProp + +> `private` **internalProp**: `string` + +**`Internal`** + +###### Source + +[classes.ts:1](http://source-url) + +#### Methods + +##### expermintalMethod() + +> **expermintalMethod**(): `void` + +**`Experimental`** + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +##### internalMethod() + +> `protected` **internalMethod**(): `void` + +**`Internal`** + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### `abstract` ClassWithModifiers + +Comments for ClassWithModifiers + +#### Constructors + +##### new ClassWithModifiers() + +> **new ClassWithModifiers**(): [`ClassWithModifiers`](globals.md#classwithmodifiers) + +###### Returns + +[`ClassWithModifiers`](globals.md#classwithmodifiers) + +#### Properties + +##### privateProp + +> `private` **privateProp**: `string` + +Comments for privateProp + +###### Source + +[classes.ts:1](http://source-url) + +##### protectedProp + +> `protected` **protectedProp**: `string` + +Comments for protectedProp + +###### Source + +[classes.ts:1](http://source-url) + +##### publicPropWithDefault + +> **publicPropWithDefault**: `string` = `'propWithDefault'` + +Comments for propWithDefault + +###### Source + +[classes.ts:1](http://source-url) + +##### readonlyProp + +> `readonly` **readonlyProp**: `string` + +Comments for abstractProperty + +###### Source + +[classes.ts:1](http://source-url) + +##### staticProp + +> `static` **staticProp**: `string` + +Comments for staticProp + +###### Source + +[classes.ts:1](http://source-url) + +#### Methods + +##### privateMethod() + +> `private` **privateMethod**(): `void` + +Comment for privateMethod + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +##### publicMethod() + +> **publicMethod**(): `void` + +Comment for publicMethod + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +##### staticMethod() + +> `static` **staticMethod**(): `void` + +Comment for staticMethod + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### ClassWithoutPropCategories + +#### Constructors + +##### new ClassWithoutPropCategories() + +> **new ClassWithoutPropCategories**(`opts`): [`ClassWithoutPropCategories`](globals.md#classwithoutpropcategories) + +###### Parameters + +###### opts + +###### opts.a + +`string` + +###### opts.b + +`string` + +###### Returns + +[`ClassWithoutPropCategories`](globals.md#classwithoutpropcategories) + +###### Source + +[classes.ts:1](http://source-url) + +#### Properties + +##### prop1 + +> **prop1**: `string` + +###### Source + +[classes.ts:1](http://source-url) + +##### prop2 + +> **prop2**: `string` + +###### Source + +[classes.ts:1](http://source-url) + +#### Methods + +##### method1() + +> **method1**(): `void` + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +##### method2() + +> **method2**(): `void` + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### ClassWithPropCategories + +#### Constructors + +##### new ClassWithPropCategories() + +> **new ClassWithPropCategories**(`opts`): [`ClassWithPropCategories`](globals.md#classwithpropcategories) + +###### Parameters + +###### opts + +###### opts.a + +`string` + +###### opts.b + +`string` + +###### Returns + +[`ClassWithPropCategories`](globals.md#classwithpropcategories) + +###### Source + +[classes.ts:1](http://source-url) + +#### CatA + +##### prop1 + +> **prop1**: `string` + +###### Source + +[classes.ts:1](http://source-url) + +#### CatB + +##### prop2 + +> **prop2**: `string` + +###### Source + +[classes.ts:1](http://source-url) + +#### Other + +##### method1() + +> **method1**(): `void` + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +##### method2() + +> **method2**(): `void` + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### ClassWithSimpleProps + +Comments for ClassWithSimpleProps + +#### Constructors + +##### new ClassWithSimpleProps() + +> **new ClassWithSimpleProps**(): [`ClassWithSimpleProps`](globals.md#classwithsimpleprops) + +###### Returns + +[`ClassWithSimpleProps`](globals.md#classwithsimpleprops) + +#### Properties + +##### propA + +> **propA**: `string` = `'propAValue'` + +Comments for propA + +###### Source + +[classes.ts:1](http://source-url) + +##### propB + +> **propB**: `string` = `'propBValue'` + +Comments for propB + +###### Default Value + +```ts +'propBDefaultValue' +``` + +###### Source + +[classes.ts:1](http://source-url) + +##### propC + +> **propC**: `string` + +Comments for propB +on two lines + +###### Default Value + +```ts +'propCDefaultValue' +``` + +###### Source + +[classes.ts:1](http://source-url) + +##### propD + +> **propD**: `string` + +Comments for propE + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### ClassWithSymbols + +#### Constructors + +##### new ClassWithSymbols() + +> **new ClassWithSymbols**(): [`ClassWithSymbols`](globals.md#classwithsymbols) + +###### Returns + +[`ClassWithSymbols`](globals.md#classwithsymbols) + +#### Properties + +##### \[symbolConst\]()? + +> `static` `optional` **\[symbolConst\]**: () => `void` + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +#### Methods + +##### \[dispose\]() + +> **\[dispose\]**(): `void` + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### ClassWithTypeParameters\ + +Comments for ClassWithTypeParameters + +#### Type Parameters + +##### A + +\- + +##### B + +*extends*: `string` + +Comments for param B + +##### C + +Default type `boolean` + +Comments for param C + +#### Constructors + +##### new ClassWithTypeParameters() + +> **new ClassWithTypeParameters**\<`A`, `B`, `C`\>(): [`ClassWithTypeParameters`](globals.md#classwithtypeparametersa-b-c)\<`A`, `B`, `C`\> + +###### Returns + +[`ClassWithTypeParameters`](globals.md#classwithtypeparametersa-b-c)\<`A`, `B`, `C`\> + +*** + +### DerivedClassA + +Comments for DerivedClassA + +#### Extends + +- [`AbstractClass`](globals.md#abstractclass) + +#### Constructors + +##### new DerivedClassA() + +> **new DerivedClassA**(): [`DerivedClassA`](globals.md#derivedclassa) + +###### Returns + +[`DerivedClassA`](globals.md#derivedclassa) + +###### Inherited from + +[`AbstractClass`](globals.md#abstractclass).[`constructor`](globals.md#constructors) + +#### Properties + +##### abstractProp + +> **abstractProp**: `string` = `'abstractProp'` + +Comments for abstractProp + +###### Overrides + +[`AbstractClass`](globals.md#abstractclass).[`abstractProp`](globals.md#abstractprop) + +###### Source + +[classes.ts:1](http://source-url) + +##### derivedProp + +> **derivedProp**: `string` + +###### Source + +[classes.ts:1](http://source-url) + +#### Methods + +##### abstractMethod() + +> **abstractMethod**(): `string` + +Comments for abstractMethod + +###### Returns + +`string` + +###### Overrides + +[`AbstractClass`](globals.md#abstractclass).[`abstractMethod`](globals.md#abstractmethod) + +###### Source + +[classes.ts:1](http://source-url) + +##### derivedMethod() + +> **derivedMethod**(): `string` + +###### Returns + +`string` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### DerivedClassB + +Comments for DerivedClassB + +#### Extends + +- [`AbstractClass`](globals.md#abstractclass) + +#### Constructors + +##### new DerivedClassB() + +> **new DerivedClassB**(): [`DerivedClassB`](globals.md#derivedclassb) + +###### Returns + +[`DerivedClassB`](globals.md#derivedclassb) + +###### Inherited from + +[`AbstractClass`](globals.md#abstractclass).[`constructor`](globals.md#constructors) + +#### Properties + +##### abstractProp + +> **abstractProp**: `string` = `'abstractProp'` + +Comments for abstractProp + +###### Overrides + +[`AbstractClass`](globals.md#abstractclass).[`abstractProp`](globals.md#abstractprop) + +###### Source + +[classes.ts:1](http://source-url) + +#### Methods + +##### abstractMethod() + +> **abstractMethod**(): `string` + +Comments for abstractMethod + +###### Returns + +`string` + +###### Overrides + +[`AbstractClass`](globals.md#abstractclass).[`abstractMethod`](globals.md#abstractmethod) + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### DisposableClass + +#### Implements + +- `Disposable` + +#### Constructors + +##### new DisposableClass() + +> **new DisposableClass**(): [`DisposableClass`](globals.md#disposableclass) + +###### Returns + +[`DisposableClass`](globals.md#disposableclass) + +#### Methods + +##### \[dispose\]() + +> **\[dispose\]**(): `void` + +###### Returns + +`void` + +###### Implementation of + +`Disposable.[dispose]` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### GrandChildClassA + +#### Extends + +- [`ChildClassA`](globals.md#childclassa) + +#### Constructors + +##### new GrandChildClassA() + +> **new GrandChildClassA**(): [`GrandChildClassA`](globals.md#grandchildclassa) + +###### Returns + +[`GrandChildClassA`](globals.md#grandchildclassa) + +###### Inherited from + +[`ChildClassA`](globals.md#childclassa).[`constructor`](globals.md#constructors-4) + +*** + +### GrandChildClassB + +#### Extends + +- [`ChildClassA`](globals.md#childclassa) + +#### Constructors + +##### new GrandChildClassB() + +> **new GrandChildClassB**(): [`GrandChildClassB`](globals.md#grandchildclassb) + +###### Returns + +[`GrandChildClassB`](globals.md#grandchildclassb) + +###### Inherited from + +[`ChildClassA`](globals.md#childclassa).[`constructor`](globals.md#constructors-4) + +## Interfaces + +### BasicInterface + +Comments for BasicInterface + +#### Extended by + +- [`ExtendedInterface`](globals.md#extendedinterface) + +#### Properties + +##### ~~deprecatedProp~~ + +> **deprecatedProp**: `string` + +###### Deprecated + +This prop is deprecated + +###### See + +Comments for some tag + +###### Source + +[interfaces.ts:1](http://source-url) + +##### functionProp() + +> **functionProp**: (`s`) => `boolean` + +Comments for functionProper + +###### Parameters + +###### s + +`string` + +Comment for param s + +###### Returns + +`boolean` + +###### Source + +[interfaces.ts:1](http://source-url) + +##### optionalProp? + +> `optional` **optionalProp**: `string` + +Comments for optional prop + +###### Source + +[interfaces.ts:1](http://source-url) + +##### prop + +> **prop**: `string` + +Comments for prop + +###### Source + +[interfaces.ts:1](http://source-url) + +##### propReturningObjectDeclaration + +> **propReturningObjectDeclaration**: `object` + +Comments for propReturningObjectDeclaration + +###### a + +> **a**: `boolean` + +###### b + +> **b**: `string` + +###### Source + +[interfaces.ts:1](http://source-url) + +##### propReturningObjectDeclarations + +> **propReturningObjectDeclarations**: `object` & `object` + +Comments for propReturningObjectDeclarations + +###### Type declaration + +###### a + +> **a**: `boolean` + +###### b + +> **b**: `string` + +###### Type declaration + +###### c + +> **c**: `boolean` + +###### d + +> **d**: `string` + +###### Source + +[interfaces.ts:1](http://source-url) + +##### propReturningSignatureDeclaration()? + +> `optional` **propReturningSignatureDeclaration**: () => `string` \| `number` \| `boolean` + +Comments for propReturningSignatureDeclaration + +###### Returns + +`string` \| `number` \| `boolean` + +###### Source + +[interfaces.ts:1](http://source-url) + +##### propReturningSignatureDeclarations + +> **propReturningSignatureDeclarations**: () => `any` & (`paramsA`, `paramsB`?) => `any` & (`paramsC`) => `any` + +Comments for propReturningSignatureDeclarations + +###### Source + +[interfaces.ts:1](http://source-url) + +##### propWithFunction() + +> **propWithFunction**: (`options`) => `boolean` + +Comments for propWithFunction + +###### Parameters + +###### options + +###### options.a + +`boolean` + +###### options.b + +`string` + +###### Returns + +`boolean` + +###### Source + +[interfaces.ts:1](http://source-url) + +##### propWithProps + +> **propWithProps**: `object` + +Comments for propWithProps + +###### callbacks? + +> `optional` **callbacks**: `Partial`\<[`CallbacksOptions`](globals.md#callbacksoptionsp-a)\<[`DisposableClass`](globals.md#disposableclass), [`ClassWithModifiers`](globals.md#classwithmodifiers)\>\> + +Comments for callbacks + +###### nestedPropA + +> **nestedPropA**: `string` + +Comments for nestedPropA + +###### nestedPropB + +> **nestedPropB**: `boolean` + +Comments for nestedPropB + +###### nestedPropC + +> **nestedPropC**: `object` + +Comments for nestedPropC + +###### nestedPropC.nestedPropCA + +> **nestedPropCA**: `string` + +Comments for nestedPropCA + +###### nestedPropD() + +> **nestedPropD**: () => `boolean` + +Comments for nestedPropD + +###### Returns + +`boolean` + +###### Source + +[interfaces.ts:1](http://source-url) + +*** + +### CustomEventInterface\ + +#### Type Parameters + +##### T + +\- + +#### Properties + +##### detail + +> **detail**: `string` + +###### Source + +[interfaces.ts:1](http://source-url) + +##### target + +> **target**: `T` + +###### Source + +[interfaces.ts:1](http://source-url) + +*** + +### ExtendedInterface + +Comments for ExtendedInterface + +#### Extends + +- [`BasicInterface`](globals.md#basicinterface) + +#### Properties + +##### ~~deprecatedProp~~ + +> **deprecatedProp**: `string` + +###### Deprecated + +This prop is deprecated + +###### See + +Comments for some tag + +###### Inherited from + +[`BasicInterface`](globals.md#basicinterface).[`deprecatedProp`](globals.md#deprecatedprop) + +###### Source + +[interfaces.ts:1](http://source-url) + +##### extendedProp + +> **extendedProp**: `string` + +###### Source + +[interfaces.ts:1](http://source-url) + +##### functionProp() + +> **functionProp**: (`s`) => `boolean` + +Comments for functionProper + +###### Parameters + +###### s + +`string` + +Comment for param s + +###### Returns + +`boolean` + +###### Inherited from + +[`BasicInterface`](globals.md#basicinterface).[`functionProp`](globals.md#functionprop) + +###### Source + +[interfaces.ts:1](http://source-url) + +##### optionalProp? + +> `optional` **optionalProp**: `string` + +Comments for optional prop + +###### Inherited from + +[`BasicInterface`](globals.md#basicinterface).[`optionalProp`](globals.md#optionalprop) + +###### Source + +[interfaces.ts:1](http://source-url) + +##### prop + +> **prop**: `string` + +Comments for prop + +###### Inherited from + +[`BasicInterface`](globals.md#basicinterface).[`prop`](globals.md#prop-1) + +###### Source + +[interfaces.ts:1](http://source-url) + +##### propReturningObjectDeclaration + +> **propReturningObjectDeclaration**: `object` + +Comments for propReturningObjectDeclaration + +###### a + +> **a**: `boolean` + +###### b + +> **b**: `string` + +###### Inherited from + +[`BasicInterface`](globals.md#basicinterface).[`propReturningObjectDeclaration`](globals.md#propreturningobjectdeclaration) + +###### Source + +[interfaces.ts:1](http://source-url) + +##### propReturningObjectDeclarations + +> **propReturningObjectDeclarations**: `object` & `object` + +Comments for propReturningObjectDeclarations + +###### Type declaration + +###### a + +> **a**: `boolean` + +###### b + +> **b**: `string` + +###### Type declaration + +###### c + +> **c**: `boolean` + +###### d + +> **d**: `string` + +###### Inherited from + +[`BasicInterface`](globals.md#basicinterface).[`propReturningObjectDeclarations`](globals.md#propreturningobjectdeclarations) + +###### Source + +[interfaces.ts:1](http://source-url) + +##### propReturningSignatureDeclaration()? + +> `optional` **propReturningSignatureDeclaration**: () => `string` \| `number` \| `boolean` + +Comments for propReturningSignatureDeclaration + +###### Returns + +`string` \| `number` \| `boolean` + +###### Inherited from + +[`BasicInterface`](globals.md#basicinterface).[`propReturningSignatureDeclaration`](globals.md#propreturningsignaturedeclaration) + +###### Source + +[interfaces.ts:1](http://source-url) + +##### propReturningSignatureDeclarations + +> **propReturningSignatureDeclarations**: () => `any` & (`paramsA`, `paramsB`?) => `any` & (`paramsC`) => `any` + +Comments for propReturningSignatureDeclarations + +###### Inherited from + +[`BasicInterface`](globals.md#basicinterface).[`propReturningSignatureDeclarations`](globals.md#propreturningsignaturedeclarations) + +###### Source + +[interfaces.ts:1](http://source-url) + +##### propWithFunction() + +> **propWithFunction**: (`options`) => `boolean` + +Comments for propWithFunction + +###### Parameters + +###### options + +###### options.a + +`boolean` + +###### options.b + +`string` + +###### Returns + +`boolean` + +###### Inherited from + +[`BasicInterface`](globals.md#basicinterface).[`propWithFunction`](globals.md#propwithfunction) + +###### Source + +[interfaces.ts:1](http://source-url) + +##### propWithProps + +> **propWithProps**: `object` + +Comments for propWithProps + +###### callbacks? + +> `optional` **callbacks**: `Partial`\<[`CallbacksOptions`](globals.md#callbacksoptionsp-a)\<[`DisposableClass`](globals.md#disposableclass), [`ClassWithModifiers`](globals.md#classwithmodifiers)\>\> + +Comments for callbacks + +###### nestedPropA + +> **nestedPropA**: `string` + +Comments for nestedPropA + +###### nestedPropB + +> **nestedPropB**: `boolean` + +Comments for nestedPropB + +###### nestedPropC + +> **nestedPropC**: `object` + +Comments for nestedPropC + +###### nestedPropC.nestedPropCA + +> **nestedPropCA**: `string` + +Comments for nestedPropCA + +###### nestedPropD() + +> **nestedPropD**: () => `boolean` + +Comments for nestedPropD + +###### Returns + +`boolean` + +###### Inherited from + +[`BasicInterface`](globals.md#basicinterface).[`propWithProps`](globals.md#propwithprops) + +###### Source + +[interfaces.ts:1](http://source-url) + +*** + +### IndexableInterface + +Comments for IndexableInterface + +#### Indexable + + \[`s`: `string`\]: `string` + +#### Properties + +##### prop + +> **prop**: `string` + +###### Source + +[interfaces.ts:1](http://source-url) + +*** + +### InterfaceWithComments\ + +Comments for interface +over two lines + +And some more comments + +#### Type Parameters + +##### A + +This is a parameter. + +##### B + +Comments for a parameter. +This sentence is on a soft new line. + +##### C + +This is a parameter. + + Documentation with a double line + +##### D + +

These are comments with paras

+

These are comments with paras

+Other comments +Comments with

paras

+ +

These are comments with paras

+ +#### Properties + +##### ~~propertyWithComments~~ + +> **propertyWithComments**: `string` + +Some text. + +- list item +- list item + +###### Deprecated + +This is a deprecated property + +###### See + +https://example.com + +###### Source + +[interfaces.ts:1](http://source-url) + +*** + +### InterfaceWithEventProperties + +#### Properties + +##### someProp? + +> `optional` **someProp**: `boolean` + +Description for prop someProp + +###### Source + +[interfaces.ts:1](http://source-url) + +#### Events + +##### anotherEvent + +> **anotherEvent**: `MouseEvent` + +###### Source + +[interfaces.ts:1](http://source-url) + +##### ~~someEvent()?~~ + +> `optional` **someEvent**: (`eventParam`) => `void` + +Description for event someEvent + +###### Deprecated + +Deprectaed comments + +###### Parameters + +###### eventParam + +[`CustomEventInterface`](globals.md#customeventinterfacet)\<`MouseEvent`\> + +Comments for param eventParam + +###### Returns + +`void` + +###### Source + +[interfaces.ts:1](http://source-url) + +*** + +### InterfaceWithFlags + +Comments for InterfaceWithFlags + +#### Properties + +##### expermintalProp? + +> `optional` **expermintalProp**: `string` + +**`Experimental`** + +###### Source + +[interfaces.ts:1](http://source-url) + +##### internalProp + +> **internalProp**: `string` + +**`Internal`** + +Comments for internalProp + +###### Source + +[interfaces.ts:1](http://source-url) + +*** + +### InterfaceWithTypeParameters\ + +Comments for InterfaceWithTypeParameters + +#### Type Parameters + +##### A + +\- + +#### Properties + +##### prop + +> **prop**: `A` + +Comments for prop + +###### Source + +[interfaces.ts:1](http://source-url) + +*** + +### MultipleIndexableInterface + +#### Indexable + + \[`key`: `string`\]: `string` + + \[`index`: `number`\]: `string` + +#### Properties + +##### prop + +> **prop**: `string` + +Prop + +###### Source + +[interfaces.ts:1](http://source-url) + +## Type Aliases + +### \_\_TypeDeclarationWithSpecialCharacters\_\ + +> **\_\_TypeDeclarationWithSpecialCharacters\_**\<`T`, `U`\>: `object` + +Comments for object with special characters + +#### Type Parameters + +##### T + +\- + +##### U + +\- + +#### Type declaration + +##### \_ + +> **\_**: `"_"` + +##### \_foo\_ + +> **\_foo\_**: `"_foo_"` + +##### \_prop\_with\_underscore\_ + +> **\_prop\_with\_underscore\_**: `"_prop_with_underscore_"` + +##### \_x() + +> **\_x**: (`_param`) => `U` + +###### Parameters + +###### \_param + +`T` + +###### Returns + +`U` + +##### ? + +> **?**: `T` \| `U` + +##### \{prop-with-brackets\} + +> **\{prop-with-brackets\}**: `"{prop-with-brackets}"` + +##### \* + +> **\***: `"*"` + +##### \*\*foo\*\* + +> **\*\*foo\*\***: `"**foo**"` + +##### \*foo\* + +> **\*foo\***: `"*foo*"` + +##### \ + +> \: "\\" + +##### \a + +> \a: "\\a" + +##### \n + +> \n: "\\n" + +##### \` + +> \`: "\`" + +##### \`prop\`with\`backticks\` + +> \`prop\`with\`backticks\`: "\`prop\`with\`backticks\`" + +##### \< + +> **\<**: `"<"` + +##### \ + +> **\**: `""` + +##### \> + +> **\>**: `">"` + +##### \| + +> **\|**: "\|" + +##### \|prop\|with\|pipes\| + +> **\|prop\|with\|pipes\|**: "\|prop\|with\|pipes\|" + +##### ~ + +> **~**: `"~"` + +#### Source + +[types.ts:1](http://source-url) + +*** + +### ArrayOfStuff + +> **ArrayOfStuff**: `object`[] + +#### Source + +[types.ts:1](http://source-url) + +*** + +### ArrayType + +> **ArrayType**: `string`[] + +Comments for ArrayType + +#### Source + +[types.ts:1](http://source-url) + +*** + +### ConditionalType\ + +> **ConditionalType**\<`T`\>: `T` *extends* `string` ? `"string"` : `T` *extends* `number` ? `"number"` : `T` *extends* `boolean` ? `"boolean"` : `T` *extends* `undefined` ? `"undefined"` : `"object"` + +Comments for ConditionalType + +#### Type Parameters + +##### T + +\- + +#### Source + +[types.ts:1](http://source-url) + +*** + +### ExternalReferenceType + +> **ExternalReferenceType**: [`ClassWithTypeParameters`](globals.md#classwithtypeparametersa-b-c)\<`"x"`, `"y"`\> + +Comments for ExternalReferenceType + +#### Source + +[types.ts:1](http://source-url) + +*** + +### FunctionType() + +> **FunctionType**: (`name`, `value`) => `void` + +Comments for FunctionType + +#### Parameters + +##### name + +`string` + +##### value + +`unknown` + +#### Returns + +`void` + +#### Source + +[types.ts:1](http://source-url) + +*** + +### IndexAccessType + +> **IndexAccessType**: [`ArrayOfStuff`](globals.md#arrayofstuff)\[`number`\] + +Comments for IndexAccessType + +#### Source + +[types.ts:1](http://source-url) + +*** + +### IntersectionType + +> **IntersectionType**: [`TupleType`](globals.md#tupletype) & [`ArrayType`](globals.md#arraytype) & `object` + +Comments for IntersectionType + +#### Type declaration + +##### bar + +> **bar**: `number` + +#### Source + +[types.ts:1](http://source-url) + +*** + +### LiteralType + +> **LiteralType**: `object` + +Comments for LiteralType + +#### Type declaration + +##### someFunctionWithArrow() + +> **someFunctionWithArrow**: () => `string` + +Comments for someFunctionWithArrow + +###### Returns + +`string` + +##### x? + +> `optional` **x**: `string` + +comment for x + +##### y + +> **y**: `object` + +comment for y + +###### y.x + +> **x**: `string` + +comment for y.x + +###### y.y? + +> `optional` **y**: `boolean` \| `string` + +comment for y.y + +###### y.z() + +> **z**: (`x`) => `string` + +comment for y.z + +###### Parameters + +###### x + +`string` + +###### Returns + +`string` + +##### z() + +> **z**: (`x`) => `string` + +###### Parameters + +###### x + +`string` + +###### Returns + +`string` + +##### accessorA + +###### Get Signature + +> **get** **accessorA**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\> + +Comments for accessorA getter + +###### Returns + +[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\> + +###### Set Signature + +> **set** **accessorA**(`x`): `void` + +Comments for accessorA setter + +###### Parameters + +###### x + +[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\> + +###### Returns + +`void` + +##### accessorB + +###### Get Signature + +> **get** **accessorB**(): `string` + +###### Returns + +`string` + +###### Set Signature + +> **set** **accessorB**(`x`): `void` + +###### Parameters + +###### x + +`string` + +###### Returns + +`void` + +##### someFunction() + +Comments for someFunction + +###### Parameters + +###### param + +`string` + +###### Returns + +[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> + +#### Source + +[types.ts:1](http://source-url) + +*** + +### PartialMappedType\ + +> **PartialMappedType**\<`T`\>: `{ [P in keyof T]?: T[P] }` + +Comments for PartialMappedType + +#### Type Parameters + +##### T + +\- + +#### Source + +[types.ts:1](http://source-url) + +*** + +### PrimitiveType + +> **PrimitiveType**: `boolean` + +Comments for PrimitiveType + +#### Source + +[types.ts:1](http://source-url) + +*** + +### PromiseTypeWithObject + +> **PromiseTypeWithObject**: [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`object`\> + +Comments for promise type returning object + +#### Type declaration + +##### x + +> **x**: `1` + +comments for x + +#### Source + +[types.ts:1](http://source-url) + +*** + +### PromiseTypeWithSymbol + +> **PromiseTypeWithSymbol**: [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`IndexAccessType`](globals.md#indexaccesstype)\> + +Comments for promise type returning symbol + +#### Source + +[types.ts:1](http://source-url) + +*** + +### QueryType + +> **QueryType**: *typeof* [`someQuery`](globals.md#somequery) + +Comments for query type + +#### Source + +[types.ts:1](http://source-url) + +*** + +### ReadonlyMappedType\ + +> **ReadonlyMappedType**\<`T`\>: `{ readonly [P in keyof T]: T[P] }` + +Comments for ReadonlyMapedType + +#### Type Parameters + +##### T + +\- + +#### Source + +[types.ts:1](http://source-url) + +*** + +### StringLiteralType + +> **StringLiteralType**: `" "` \| `"string"` \| "string\|with\|pipes" \| "string\`with\`backticks" \| `""` \| `"*"` + +Comments for StringLiteralType + +#### Source + +[types.ts:1](http://source-url) + +*** + +### Stuff + +> **Stuff**: `object` + +#### Type declaration + +##### a + +> **a**: `string` + +##### b + +> **b**: `string` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### TupleType + +> **TupleType**: [`string`, `number`] + +Comments for TupleType + +#### Source + +[types.ts:1](http://source-url) + +*** + +### TypeWithExternalSymbolLinkMapping + +> **TypeWithExternalSymbolLinkMapping**: [`Application`](https://typedoc.org/api/classes/Application.html) + +Comments for TypeWithExternalSymbolLinkMapping + +#### Source + +[types.ts:1](http://source-url) + +*** + +### TypeWithReturns + +> **TypeWithReturns**: `string` + +Comments for TypeWithReturns + +#### Returns + +- return comments. + +#### Source + +[types.ts:1](http://source-url) + +*** + +### TypeWithTypeParams\ + +> **TypeWithTypeParams**\<`T`, `R`\>: [`T`, `R`] + +Comments for TypeWithTypeParams + +#### Type Parameters + +##### T + +\- + +##### R + +\- + +#### Source + +[types.ts:1](http://source-url) + +*** + +### UnionType + +> **UnionType**: `string` \| `boolean` \| \{`z`: `string`; \} + +Comments for UnionType + +#### Source + +[types.ts:1](http://source-url) + +*** + +### UnionTypeWithTemplateStrings + +> **UnionTypeWithTemplateStrings**: \`v$\{number\}\` \| \`v$\{number\}.$\{number\}\` \| \`v$\{number\}.$\{number\}.$\{number\}\` + +Union with template strings + +#### Source + +[types.ts:1](http://source-url) + +*** + +### UsefulUnionType + +> **UsefulUnionType**: `string` \| `boolean` \| \{`z`: `string`; \} + +Comments for useful UnionType + +#### Type declaration + +`string` + +`boolean` + +\{`z`: `string`; \} + +##### z + +> **z**: `string` + +Comments for z + +#### Source + +[types.ts:1](http://source-url) + +## Variables + +### objectLiteralVariable + +> `const` **objectLiteralVariable**: `object` + +Comments for objectLiteralVariable + +#### See + +xyz.com + +#### Type declaration + +##### valueA + +> **valueA**: `number` = `100` + +Comments for valueA + +##### valueB + +> **valueB**: `boolean` = `true` + +##### valueX + +> **valueX**: `object` + +Comments for valueX + +###### valueX.valueA + +> **valueA**: `number`[] + +Comment for valueX.valueA + +###### valueX.valueY() + +> **valueY**: (`z`) => `object` + +###### Parameters + +###### z + +`string` + +###### Returns + +`object` + +###### a + +> **a**: `string` = `'test'` + +###### b + +> **b**: `string` = `z` + +###### c + +> **c**: `object` + +###### c.a + +> **a**: `number` = `1` + +###### c.b + +> **b**: `number` = `2` + +###### valueX.valueZ + +> **valueZ**: `string` = `'foo'` + +##### valueY() + +> **valueY**: (`unionParam`, `_undercoreParam_`) => `string` + +###### Parameters + +###### unionParam + +`"a"` | `"b"` + +###### \_undercoreParam\_ + +`string` + +###### Returns + +`string` + +#### Source + +[variables.ts:1](http://source-url) + +*** + +### objectWithSymbol + +> `const` **objectWithSymbol**: `object` + +Comments variable with symbol + +#### Type declaration + +##### \[sym\] + +> **\[sym\]**: `string` = `'value'` + +Comments for symbol + +#### Source + +[variables.ts:1](http://source-url) + +*** + +### someQuery + +> `const` **someQuery**: `1` = `1` + +#### Source + +[types.ts:1](http://source-url) + +*** + +### stringVariable + +> `const` **stringVariable**: `"stringConstWithDefaultValue"` = `'stringConstWithDefaultValue'` + +A simple string variable + +#### Source + +[variables.ts:1](http://source-url) + +*** + +### templateVariableString + +> `const` **templateVariableString**: "\nThis is a template string\n/\* with a comment \*/\nAnd a \\\n" + +A template variable string + +#### Source + +[variables.ts:1](http://source-url) + +*** + +### typeOperatorVariable + +> `const` **typeOperatorVariable**: unique `symbol` + +Comments for typeOperatorVariable + +#### Source + +[variables.ts:1](http://source-url) + +## Functions + +### basicFunction() + +> **basicFunction**(`someParam`): `number` + +This is a function that is assigned to a variable. + +#### See + +http://abc.com + +#### Parameters + +##### someParam + +`number` + +This is some numeric parameter. + +#### Returns + +`number` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### basicFunctionWithReturns() + +> **basicFunctionWithReturns**(): `number` + +This is a function that is assigned to a variable. + +#### Returns + +`number` + +This is a return value + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### curriedFunction() + +Comments for main curriedFunction + +#### Call Signature + +> **curriedFunction**(`searchElement`): \<`Value`\>(`iterable`) => `boolean` + +Comments for current function 1 + +##### Parameters + +###### searchElement + +`unknown` + +##### Returns + +`Function` + +###### Type Parameters + +###### Value + +\- + +###### Parameters + +###### iterable + +`Iterable`\<`Value`, `any`, `any`\> + +Comments for iterable arg + +###### Returns + +`boolean` + +##### Source + +[functions.ts:1](http://source-url) + +#### Call Signature + +> **curriedFunction**\<`Value`\>(`searchElement`, `iterable`): `string` + +##### Type Parameters + +###### Value + +\- + +##### Parameters + +###### searchElement + +`unknown` + +###### iterable + +`Iterable`\<`Value`, `any`, `any`\> + +##### Returns + +`string` + +##### Source + +[functions.ts:1](http://source-url) + +*** + +### functionReturningAFunction() + +> **functionReturningAFunction**(): \<`T`\>(`x`) => `boolean` + +Comments for function + +#### Returns + +`Function` + +##### Type Parameters + +###### T + +\- + +##### Parameters + +###### x + +`string` + +##### Returns + +`boolean` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionReturningAnObject() + +> **functionReturningAnObject**(): `object` + +Comments for function + +#### Returns + +`object` + +Return comments + +##### x + +> **x**: `number` = `1` + +##### y + +> **y**: `number` = `2` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionReturningAPromise() + +> **functionReturningAPromise**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`object`\> + +Comments for function + +#### Returns + +[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`object`\> + +Return comments + +##### prop + +> **prop**: `string` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionReturningAString() + +> **functionReturningAString**(): `string` + +Comments for function + +#### Returns + +`string` + +Return comments + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionReturningAUnionType() + +> **functionReturningAUnionType**(): `string` \| `boolean` \| `"string1"` \| `"string2"` + +Comments for function + +#### Returns + +`string` \| `boolean` \| `"string1"` \| `"string2"` + +Return comments + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithArrayOfOptionalStuff() + +> **functionWithArrayOfOptionalStuff**(`a`): `void` + +Comments for array of stuff? + +#### Parameters + +##### a + +[[`Stuff`](globals.md#stuff)?] + +#### Returns + +`void` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithArrayOfStuff() + +> **functionWithArrayOfStuff**(`a`): `void` + +Comments for array of stuff + +#### Parameters + +##### a + +[[`Stuff`](globals.md#stuff)] + +#### Returns + +`void` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithComplexParams() + +> **functionWithComplexParams**(`paramA`, `paramB`): `boolean` + +Function with function parmas + +#### Parameters + +##### paramA + +(`a`) => `true` + +##### paramB + +###### paramB.x + +`1` + +#### Returns + +`boolean` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithDefaultParameters() + +> **functionWithDefaultParameters**(`valueA`, `valueB`, `valueC`, `valueD`, `valueE`, `valueF`): `string` + +This is a function with a parameter that has a default value. + +#### Parameters + +##### valueA + +`string` = `'defaultValue'` + +A parameter with a default string value. + +##### valueB + +`number` = `100` + +A parameter with a default numeric value. + +##### valueC + +`number` = `Number.NaN` + +A parameter with a default NaN value. + +##### valueD + +`boolean` = `true` + +A parameter with a default boolean value. + +##### valueE + +`boolean` = `true` + +A parameter with a default null value. + +##### valueF + +`string` = `''` + +#### Returns + +`string` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithMultipleSignatures() + +Main function comment. + +#### Call Signature + +> **functionWithMultipleSignatures**(`value`): `string` + +This is the first signature of a function with multiple signatures. + +##### Parameters + +###### value + +`string` + +The name value. + +##### Returns + +`string` + +##### Source + +[functions.ts:1](http://source-url) + +#### Call Signature + +> **functionWithMultipleSignatures**(`value`): `string` + +This is the second signature of a function with multiple signatures. + +##### Parameters + +###### value + +An object containing the name value. + +###### value.name + +`string` + +A value of the object. + +##### Returns + +`string` + +##### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithNamedParams() + +> **functionWithNamedParams**(`__namedParameters`, `anotherParam`): `void` + +#### Parameters + +##### \_\_namedParameters + +various options + +###### __namedParameters.bar + +`number` = `43` + +###### __namedParameters.foo + +`number` = `42` + +##### anotherParam + +`string` + +Another param comment + +#### Returns + +`void` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithNestedParameters() + +> **functionWithNestedParameters**(`params`, `context`, `somethingElse`?): `boolean` + +Some nested params. + +#### Parameters + +##### params + +The parameters passed to the method. + +###### params.name + +`string` + +The name of the new group. + +###### params.nestedObj + +`object` + +A nested object. + +###### params.nestedObj.name + +`string` + +###### params.nestedObj.obj + +`object` + +###### params.nestedObj.obj.name + +() => `void` + +###### params.nestedObj.value + +`number` + +###### params.parent + +`number` + +##### context + +`any` + +The context of the method call. + +##### somethingElse? + +`string` + +#### Returns + +`boolean` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithOptionalParameters() + +> **functionWithOptionalParameters**(`firstParamWithDefault`, `requiredParam`, `optionalParam`?, `paramWithDefault`?): `void` + +This is a function with a parameters. + +#### Parameters + +##### firstParamWithDefault + +`boolean` = `true` + +##### requiredParam + +`string` + +A normal parameter. + +##### optionalParam? + +`string` + +An optional parameter. + +##### paramWithDefault? + +`number` = `0` + +#### Returns + +`void` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithRestParams() + +> **functionWithRestParams**(`param`, ...`restParams`): `boolean` + +Function with reset parmas + +#### Parameters + +##### param + +`string` + +##### restParams + +...`string`[] + +#### Returns + +`boolean` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithTypeParameters() + +> **functionWithTypeParameters**\<`T`, `Item`\>(): `boolean` + +Function with type parameters + +#### Type Parameters + +##### T + +Comments for T + +##### Item + +Default type `string` \| `boolean` + +#### Returns + +`boolean` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithUnionParams() + +> **functionWithUnionParams**(`primitiveUnions`, `objectUnions`, `mixedUnions`, `noUnions`): `undefined` + +#### Parameters + +##### primitiveUnions + +`string` | `number` + +##### objectUnions + +Comments for objectUnions + +###### objectUnions.a + +`string` + +Comments for a + +###### objectUnions.b + +`1` + +##### mixedUnions + +`string` + +\{`a`: `string`;`b`: `string`; \} + +###### mixedUnions.a + +`string` = `''` + +a comments + +###### mixedUnions.b + +`string` = `''` + +b comments + +##### noUnions + +`string` + +Comments for noUnions + +#### Returns + +`undefined` + +#### Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-1/sidebar.json new file mode 100644 index 000000000..0637a088a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-1/sidebar.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-2/README.md new file mode 100644 index 000000000..ce906831f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-2/README.md @@ -0,0 +1,2380 @@ +# typedoc-stubs + +Module comments + +## Enumerations + +### BasicEnum + +Comments for enum + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| :------ | :------ | :------ | +| `MemberA` | `0` | Comments for MemberA | +| `MemberB` | `1` | Comments for MemberB | + +*** + +### EnumWithValues + +Comments for enum + +#### Enumeration Members + +| Enumeration Member | Value | +| :------ | :------ | +| `MemberA` | `"UP"` | +| `MemberB` | `"DOWN"` | + +## Classes + +### `abstract` AbstractClass + +#### Extended by + +- [`DerivedClassA`](README.md#derivedclassa) +- [`DerivedClassB`](README.md#derivedclassb) + +#### Constructors + +##### new AbstractClass() + +```ts +new AbstractClass(): AbstractClass +``` + +###### Returns + +[`AbstractClass`](README.md#abstractclass) + +#### Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `abstractProp` | `abstract` | `string` | Comments for abstractProp | + +#### Methods + +##### abstractMethod() + +```ts +abstract abstractMethod(): string +``` + +Comments for abstractMethod + +###### Returns + +`string` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### BaseClass + +#### Extended by + +- [`ChildClassA`](README.md#childclassa) +- [`ChildClassB`](README.md#childclassb) + +#### Constructors + +##### new BaseClass() + +```ts +new BaseClass(): BaseClass +``` + +###### Returns + +[`BaseClass`](README.md#baseclass) + +*** + +### BasicClass + +Comments for BasicClass + +#### Constructors + +##### new BasicClass() + +```ts +new BasicClass(): BasicClass +``` + +###### Returns + +[`BasicClass`](README.md#basicclass) + +#### Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `prop` | `string` | Comments for prop | + +#### Methods + +##### method() + +```ts +method(): string +``` + +Comments for method + +###### Returns + +`string` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### CallbacksOptions\ + +#### Type Parameters + +| Type Parameter | Default type | +| :------ | :------ | +| `P` | [`DisposableClass`](README.md#disposableclass) | +| `A` | [`ClassWithModifiers`](README.md#classwithmodifiers) | + +#### Constructors + +##### new CallbacksOptions() + +```ts +new CallbacksOptions(): CallbacksOptions +``` + +###### Returns + +[`CallbacksOptions`](README.md#callbacksoptionsp-a)\<`P`, `A`\> + +*** + +### ChildClassA + +#### Extends + +- [`BaseClass`](README.md#baseclass) + +#### Extended by + +- [`GrandChildClassA`](README.md#grandchildclassa) +- [`GrandChildClassB`](README.md#grandchildclassb) + +#### Constructors + +##### new ChildClassA() + +```ts +new ChildClassA(): ChildClassA +``` + +###### Returns + +[`ChildClassA`](README.md#childclassa) + +###### Inherited from + +[`BaseClass`](README.md#baseclass).[`constructor`](README.md#constructors-1) + +*** + +### ChildClassB + +#### Extends + +- [`BaseClass`](README.md#baseclass) + +#### Constructors + +##### new ChildClassB() + +```ts +new ChildClassB(): ChildClassB +``` + +###### Returns + +[`ChildClassB`](README.md#childclassb) + +###### Inherited from + +[`BaseClass`](README.md#baseclass).[`constructor`](README.md#constructors-1) + +*** + +### ClassWithAccessorKeywords + +#### Constructors + +##### new ClassWithAccessorKeywords() + +```ts +new ClassWithAccessorKeywords(): ClassWithAccessorKeywords +``` + +###### Returns + +[`ClassWithAccessorKeywords`](README.md#classwithaccessorkeywords) + +#### Accessors + +##### accessor1 + +Accessor comments + +###### Example + +```ts +const x = 1; +``` + +###### Source + +[classes.ts:1](http://source-url) + +##### accessor2 + +Accessor comments + +###### Remarks + +Remark comments + +###### Source + +[classes.ts:1](http://source-url) + +##### accessor3 + +Accessor comments + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### ClassWithAccessors + +Comments for ClassWithAccessors + +#### Constructors + +##### new ClassWithAccessors() + +```ts +new ClassWithAccessors(): ClassWithAccessors +``` + +###### Returns + +[`ClassWithAccessors`](README.md#classwithaccessors) + +#### Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `privateProp` | `private` | `string` | + +#### Accessors + +##### accessor + +###### Get Signature + +```ts +get accessor(): string +``` + +Comments for getter + +###### Returns + +`string` + +###### Set Signature + +```ts +set accessor(value: string): void +``` + +Comments for setter + +###### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `value` | `string` | Param comments | + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +##### noGetter + +###### Set Signature + +```ts +set noGetter(x: string): void +``` + +###### Parameters + +| Parameter | Type | +| :------ | :------ | +| `x` | `string` | + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +##### noSetter + +###### Get Signature + +```ts +get noSetter(): string +``` + +###### Returns + +`string` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### ClassWithComplexProps + +Comments for ClassWithComplexProps + +#### Constructors + +##### new ClassWithComplexProps() + +```ts +new ClassWithComplexProps(): ClassWithComplexProps +``` + +###### Returns + +[`ClassWithComplexProps`](README.md#classwithcomplexprops) + +#### Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `objecLiteralProp` | `object` | - | +| `objecLiteralProp.someFunction` | (`a`: `string`) => `string` | Comments for someFunction | +| `objecLiteralProp.someProp` | `string` | Comments for someProp | + +*** + +### ClassWithConstructorOverloads + +Comments for ClassWithConstructorOverloads + +#### Constructors + +##### new ClassWithConstructorOverloads() + +```ts +new ClassWithConstructorOverloads(x: number, y: string): ClassWithConstructorOverloads +``` + +###### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `x` | `number` | Comments for x number | +| `y` | `string` | | + +###### Returns + +[`ClassWithConstructorOverloads`](README.md#classwithconstructoroverloads) + +###### Source + +[classes.ts:1](http://source-url) + +##### new ClassWithConstructorOverloads() + +```ts +new ClassWithConstructorOverloads(x: string): ClassWithConstructorOverloads +``` + +###### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `x` | `string` | Comments for x string | + +###### Returns + +[`ClassWithConstructorOverloads`](README.md#classwithconstructoroverloads) + +###### Source + +[classes.ts:1](http://source-url) + +##### new ClassWithConstructorOverloads() + +```ts +new ClassWithConstructorOverloads(s: string): ClassWithConstructorOverloads +``` + +###### Parameters + +| Parameter | Type | +| :------ | :------ | +| `s` | `string` | + +###### Returns + +[`ClassWithConstructorOverloads`](README.md#classwithconstructoroverloads) + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### ClassWithFlags + +Comment for ClassWithFlags + +#### Constructors + +##### new ClassWithFlags() + +```ts +new ClassWithFlags(): ClassWithFlags +``` + +###### Returns + +[`ClassWithFlags`](README.md#classwithflags) + +#### Properties + +| Property | Modifier | Type | Description | +| :------ | :------ | :------ | :------ | +| `expermintalProp` | `public` | `string` | **`Experimental`** | +| `internalProp` | `private` | `string` | **`Internal`** | + +#### Methods + +##### expermintalMethod() + +```ts +expermintalMethod(): void +``` + +**`Experimental`** + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +##### internalMethod() + +```ts +protected internalMethod(): void +``` + +**`Internal`** + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### `abstract` ClassWithModifiers + +Comments for ClassWithModifiers + +#### Constructors + +##### new ClassWithModifiers() + +```ts +new ClassWithModifiers(): ClassWithModifiers +``` + +###### Returns + +[`ClassWithModifiers`](README.md#classwithmodifiers) + +#### Properties + +| Property | Modifier | Type | Default value | Description | +| :------ | :------ | :------ | :------ | :------ | +| `privateProp` | `private` | `string` | `undefined` | Comments for privateProp | +| `protectedProp` | `protected` | `string` | `undefined` | Comments for protectedProp | +| `publicPropWithDefault` | `public` | `string` | `'propWithDefault'` | Comments for propWithDefault | +| `readonlyProp` | `readonly` | `string` | `undefined` | Comments for abstractProperty | +| `staticProp` | `static` | `string` | `undefined` | Comments for staticProp | + +#### Methods + +##### privateMethod() + +```ts +private privateMethod(): void +``` + +Comment for privateMethod + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +##### publicMethod() + +```ts +publicMethod(): void +``` + +Comment for publicMethod + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +##### staticMethod() + +```ts +static staticMethod(): void +``` + +Comment for staticMethod + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### ClassWithoutPropCategories + +#### Constructors + +##### new ClassWithoutPropCategories() + +```ts +new ClassWithoutPropCategories(opts: object): ClassWithoutPropCategories +``` + +###### Parameters + +| Parameter | Type | +| :------ | :------ | +| `opts` | \{ `a`: `string`; `b`: `string`; \} | +| `opts.a` | `string` | +| `opts.b` | `string` | + +###### Returns + +[`ClassWithoutPropCategories`](README.md#classwithoutpropcategories) + +###### Source + +[classes.ts:1](http://source-url) + +#### Properties + +| Property | Type | +| :------ | :------ | +| `prop1` | `string` | +| `prop2` | `string` | + +#### Methods + +##### method1() + +```ts +method1(): void +``` + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +##### method2() + +```ts +method2(): void +``` + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### ClassWithPropCategories + +#### Constructors + +##### new ClassWithPropCategories() + +```ts +new ClassWithPropCategories(opts: object): ClassWithPropCategories +``` + +###### Parameters + +| Parameter | Type | +| :------ | :------ | +| `opts` | \{ `a`: `string`; `b`: `string`; \} | +| `opts.a` | `string` | +| `opts.b` | `string` | + +###### Returns + +[`ClassWithPropCategories`](README.md#classwithpropcategories) + +###### Source + +[classes.ts:1](http://source-url) + +#### CatA + +##### prop1 + +```ts +prop1: string; +``` + +###### Source + +[classes.ts:1](http://source-url) + +#### CatB + +##### prop2 + +```ts +prop2: string; +``` + +###### Source + +[classes.ts:1](http://source-url) + +#### Other + +##### method1() + +```ts +method1(): void +``` + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +##### method2() + +```ts +method2(): void +``` + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### ClassWithSimpleProps + +Comments for ClassWithSimpleProps + +#### Constructors + +##### new ClassWithSimpleProps() + +```ts +new ClassWithSimpleProps(): ClassWithSimpleProps +``` + +###### Returns + +[`ClassWithSimpleProps`](README.md#classwithsimpleprops) + +#### Properties + +| Property | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `propA` | `string` | `'propAValue'` | Comments for propA | +| `propB` | `string` | `'propBDefaultValue'` | Comments for propB | +| `propC` | `string` | `'propCDefaultValue'` | Comments for propB on two lines | +| `propD` | `string` | `undefined` | Comments for propE | + +*** + +### ClassWithSymbols + +#### Constructors + +##### new ClassWithSymbols() + +```ts +new ClassWithSymbols(): ClassWithSymbols +``` + +###### Returns + +[`ClassWithSymbols`](README.md#classwithsymbols) + +#### Properties + +| Property | Modifier | Type | +| :------ | :------ | :------ | +| `[symbolConst]?` | `static` | () => `void` | + +#### Methods + +##### \[dispose\]() + +```ts +dispose: void +``` + +###### Returns + +`void` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### ClassWithTypeParameters\ + +Comments for ClassWithTypeParameters + +#### Type Parameters + +| Type Parameter | Default type | Description | +| :------ | :------ | :------ | +| `A` | - | - | +| `B` *extends* `string` | - | Comments for param B | +| `C` | `boolean` | Comments for param C | + +#### Constructors + +##### new ClassWithTypeParameters() + +```ts +new ClassWithTypeParameters(): ClassWithTypeParameters +``` + +###### Returns + +[`ClassWithTypeParameters`](README.md#classwithtypeparametersa-b-c)\<`A`, `B`, `C`\> + +*** + +### DerivedClassA + +Comments for DerivedClassA + +#### Extends + +- [`AbstractClass`](README.md#abstractclass) + +#### Constructors + +##### new DerivedClassA() + +```ts +new DerivedClassA(): DerivedClassA +``` + +###### Returns + +[`DerivedClassA`](README.md#derivedclassa) + +###### Inherited from + +[`AbstractClass`](README.md#abstractclass).[`constructor`](README.md#constructors) + +#### Properties + +| Property | Type | Default value | Description | Overrides | +| :------ | :------ | :------ | :------ | :------ | +| `abstractProp` | `string` | `'abstractProp'` | Comments for abstractProp | [`AbstractClass`](README.md#abstractclass).`abstractProp` | +| `derivedProp` | `string` | `undefined` | - | - | + +#### Methods + +##### abstractMethod() + +```ts +abstractMethod(): string +``` + +Comments for abstractMethod + +###### Returns + +`string` + +###### Overrides + +[`AbstractClass`](README.md#abstractclass).[`abstractMethod`](README.md#abstractmethod) + +###### Source + +[classes.ts:1](http://source-url) + +##### derivedMethod() + +```ts +derivedMethod(): string +``` + +###### Returns + +`string` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### DerivedClassB + +Comments for DerivedClassB + +#### Extends + +- [`AbstractClass`](README.md#abstractclass) + +#### Constructors + +##### new DerivedClassB() + +```ts +new DerivedClassB(): DerivedClassB +``` + +###### Returns + +[`DerivedClassB`](README.md#derivedclassb) + +###### Inherited from + +[`AbstractClass`](README.md#abstractclass).[`constructor`](README.md#constructors) + +#### Properties + +| Property | Type | Default value | Description | Overrides | +| :------ | :------ | :------ | :------ | :------ | +| `abstractProp` | `string` | `'abstractProp'` | Comments for abstractProp | [`AbstractClass`](README.md#abstractclass).`abstractProp` | + +#### Methods + +##### abstractMethod() + +```ts +abstractMethod(): string +``` + +Comments for abstractMethod + +###### Returns + +`string` + +###### Overrides + +[`AbstractClass`](README.md#abstractclass).[`abstractMethod`](README.md#abstractmethod) + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### DisposableClass + +#### Implements + +- `Disposable` + +#### Constructors + +##### new DisposableClass() + +```ts +new DisposableClass(): DisposableClass +``` + +###### Returns + +[`DisposableClass`](README.md#disposableclass) + +#### Methods + +##### \[dispose\]() + +```ts +dispose: void +``` + +###### Returns + +`void` + +###### Implementation of + +`Disposable.[dispose]` + +###### Source + +[classes.ts:1](http://source-url) + +*** + +### GrandChildClassA + +#### Extends + +- [`ChildClassA`](README.md#childclassa) + +#### Constructors + +##### new GrandChildClassA() + +```ts +new GrandChildClassA(): GrandChildClassA +``` + +###### Returns + +[`GrandChildClassA`](README.md#grandchildclassa) + +###### Inherited from + +[`ChildClassA`](README.md#childclassa).[`constructor`](README.md#constructors-4) + +*** + +### GrandChildClassB + +#### Extends + +- [`ChildClassA`](README.md#childclassa) + +#### Constructors + +##### new GrandChildClassB() + +```ts +new GrandChildClassB(): GrandChildClassB +``` + +###### Returns + +[`GrandChildClassB`](README.md#grandchildclassb) + +###### Inherited from + +[`ChildClassA`](README.md#childclassa).[`constructor`](README.md#constructors-4) + +## Interfaces + +### BasicInterface + +Comments for BasicInterface + +#### Extended by + +- [`ExtendedInterface`](README.md#extendedinterface) + +#### Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| ~~`deprecatedProp`~~ | `string` | **Deprecated** This prop is deprecated **See** Comments for some tag | +| `functionProp` | (`s`: `string`) => `boolean` | Comments for functionProper | +| `optionalProp?` | `string` | Comments for optional prop | +| `prop` | `string` | Comments for prop | +| `propReturningObjectDeclaration` | `object` | Comments for propReturningObjectDeclaration | +| `propReturningObjectDeclaration.a` | `boolean` | - | +| `propReturningObjectDeclaration.b` | `string` | - | +| `propReturningObjectDeclarations` | `object` & `object` | Comments for propReturningObjectDeclarations | +| `propReturningSignatureDeclaration?` | () => `string` \| `number` \| `boolean` | Comments for propReturningSignatureDeclaration | +| `propReturningSignatureDeclarations` | () => `any` & (`paramsA`: `true` \| `any`[], `paramsB`?: `any`) => `any` & (`paramsC`: `any`) => `any` | Comments for propReturningSignatureDeclarations | +| `propWithFunction` | (`options`: `object`) => `boolean` | Comments for propWithFunction | +| `propWithProps` | `object` | Comments for propWithProps | +| `propWithProps.callbacks?` | `Partial`\<[`CallbacksOptions`](README.md#callbacksoptionsp-a)\<[`DisposableClass`](README.md#disposableclass), [`ClassWithModifiers`](README.md#classwithmodifiers)\>\> | Comments for callbacks | +| `propWithProps.nestedPropA` | `string` | Comments for nestedPropA | +| `propWithProps.nestedPropB` | `boolean` | Comments for nestedPropB | +| `propWithProps.nestedPropC` | `object` | Comments for nestedPropC | +| `propWithProps.nestedPropC.nestedPropCA` | `string` | Comments for nestedPropCA | +| `propWithProps.nestedPropD` | () => `boolean` | Comments for nestedPropD | + +*** + +### CustomEventInterface\ + +#### Type Parameters + +| Type Parameter | +| :------ | +| `T` | + +#### Properties + +| Property | Type | +| :------ | :------ | +| `detail` | `string` | +| `target` | `T` | + +*** + +### ExtendedInterface + +Comments for ExtendedInterface + +#### Extends + +- [`BasicInterface`](README.md#basicinterface) + +#### Properties + +| Property | Type | Description | Inherited from | +| :------ | :------ | :------ | :------ | +| ~~`deprecatedProp`~~ | `string` | **Deprecated** This prop is deprecated **See** Comments for some tag | [`BasicInterface`](README.md#basicinterface).`deprecatedProp` | +| `extendedProp` | `string` | - | - | +| `functionProp` | (`s`: `string`) => `boolean` | Comments for functionProper | [`BasicInterface`](README.md#basicinterface).`functionProp` | +| `optionalProp?` | `string` | Comments for optional prop | [`BasicInterface`](README.md#basicinterface).`optionalProp` | +| `prop` | `string` | Comments for prop | [`BasicInterface`](README.md#basicinterface).`prop` | +| `propReturningObjectDeclaration` | `object` | Comments for propReturningObjectDeclaration | [`BasicInterface`](README.md#basicinterface).`propReturningObjectDeclaration` | +| `propReturningObjectDeclaration.a` | `boolean` | - | - | +| `propReturningObjectDeclaration.b` | `string` | - | - | +| `propReturningObjectDeclarations` | `object` & `object` | Comments for propReturningObjectDeclarations | [`BasicInterface`](README.md#basicinterface).`propReturningObjectDeclarations` | +| `propReturningSignatureDeclaration?` | () => `string` \| `number` \| `boolean` | Comments for propReturningSignatureDeclaration | [`BasicInterface`](README.md#basicinterface).`propReturningSignatureDeclaration` | +| `propReturningSignatureDeclarations` | () => `any` & (`paramsA`: `true` \| `any`[], `paramsB`?: `any`) => `any` & (`paramsC`: `any`) => `any` | Comments for propReturningSignatureDeclarations | [`BasicInterface`](README.md#basicinterface).`propReturningSignatureDeclarations` | +| `propWithFunction` | (`options`: `object`) => `boolean` | Comments for propWithFunction | [`BasicInterface`](README.md#basicinterface).`propWithFunction` | +| `propWithProps` | `object` | Comments for propWithProps | [`BasicInterface`](README.md#basicinterface).`propWithProps` | +| `propWithProps.callbacks?` | `Partial`\<[`CallbacksOptions`](README.md#callbacksoptionsp-a)\<[`DisposableClass`](README.md#disposableclass), [`ClassWithModifiers`](README.md#classwithmodifiers)\>\> | Comments for callbacks | - | +| `propWithProps.nestedPropA` | `string` | Comments for nestedPropA | - | +| `propWithProps.nestedPropB` | `boolean` | Comments for nestedPropB | - | +| `propWithProps.nestedPropC` | `object` | Comments for nestedPropC | - | +| `propWithProps.nestedPropC.nestedPropCA` | `string` | Comments for nestedPropCA | - | +| `propWithProps.nestedPropD` | () => `boolean` | Comments for nestedPropD | - | + +*** + +### IndexableInterface + +Comments for IndexableInterface + +#### Indexable + + \[`s`: `string`\]: `string` + +#### Properties + +| Property | Type | +| :------ | :------ | +| `prop` | `string` | + +*** + +### InterfaceWithComments\ + +Comments for interface +over two lines + +And some more comments + +#### Type Parameters + +| Type Parameter | Description | +| :------ | :------ | +| `A` | This is a parameter. | +| `B` | Comments for a parameter. This sentence is on a soft new line. | +| `C` | This is a parameter. Documentation with a double line | +| `D` |

These are comments with paras

These are comments with paras

Other comments Comments with

paras

These are comments with paras

| + +#### Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| ~~`propertyWithComments`~~ | `string` | Some text. - list item - list item **Deprecated** This is a deprecated property **See** https://example.com | + +*** + +### InterfaceWithEventProperties + +#### Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `someProp?` | `boolean` | Description for prop someProp | + +#### Events + +| Event | Type | Description | +| :------ | :------ | :------ | +| `anotherEvent` | `MouseEvent` | - | +| ~~`someEvent?`~~ | (`eventParam`: [`CustomEventInterface`](README.md#customeventinterfacet)\<`MouseEvent`\>) => `void` | Description for event someEvent **Deprecated** Deprectaed comments | + +*** + +### InterfaceWithFlags + +Comments for InterfaceWithFlags + +#### Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `expermintalProp?` | `string` | **`Experimental`** | +| `internalProp` | `string` | **`Internal`** Comments for internalProp | + +*** + +### InterfaceWithTypeParameters\ + +Comments for InterfaceWithTypeParameters + +#### Type Parameters + +| Type Parameter | +| :------ | +| `A` | + +#### Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `prop` | `A` | Comments for prop | + +*** + +### MultipleIndexableInterface + +#### Indexable + + \[`key`: `string`\]: `string` + + \[`index`: `number`\]: `string` + +#### Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `prop` | `string` | Prop | + +## Type Aliases + +### \_\_TypeDeclarationWithSpecialCharacters\_\ + +```ts +type __TypeDeclarationWithSpecialCharacters_: object; +``` + +Comments for object with special characters + +#### Type Parameters + +| Type Parameter | +| :------ | +| `T` | +| `U` | + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `_` | `"_"` | +| `_foo_` | `"_foo_"` | +| `_prop_with_underscore_` | `"_prop_with_underscore_"` | +| `_x` | (`_param`: `T`) => `U` | +| `?` | `T` \| `U` | +| `{prop-with-brackets}` | `"{prop-with-brackets}"` | +| `*` | `"*"` | +| `**foo**` | `"**foo**"` | +| `*foo*` | `"*foo*"` | +| \ | "\\" | +| \a | "\\a" | +| \n | "\\n" | +| \` | "\`" | +| \`prop\`with\`backticks\` | "\`prop\`with\`backticks\`" | +| `<` | `"<"` | +| `` | `""` | +| `>` | `">"` | +| \| | "\|" | +| \|prop\|with\|pipes\| | "\|prop\|with\|pipes\|" | +| `~` | `"~"` | + +#### Source + +[types.ts:1](http://source-url) + +*** + +### ArrayOfStuff + +```ts +type ArrayOfStuff: object[]; +``` + +#### Source + +[types.ts:1](http://source-url) + +*** + +### ArrayType + +```ts +type ArrayType: string[]; +``` + +Comments for ArrayType + +#### Source + +[types.ts:1](http://source-url) + +*** + +### ConditionalType\ + +```ts +type ConditionalType: T extends string ? "string" : T extends number ? "number" : T extends boolean ? "boolean" : T extends undefined ? "undefined" : "object"; +``` + +Comments for ConditionalType + +#### Type Parameters + +| Type Parameter | +| :------ | +| `T` | + +#### Source + +[types.ts:1](http://source-url) + +*** + +### ExternalReferenceType + +```ts +type ExternalReferenceType: ClassWithTypeParameters<"x", "y">; +``` + +Comments for ExternalReferenceType + +#### Source + +[types.ts:1](http://source-url) + +*** + +### FunctionType() + +```ts +type FunctionType: (name: string, value: unknown) => void; +``` + +Comments for FunctionType + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `name` | `string` | +| `value` | `unknown` | + +#### Returns + +`void` + +#### Source + +[types.ts:1](http://source-url) + +*** + +### IndexAccessType + +```ts +type IndexAccessType: ArrayOfStuff[number]; +``` + +Comments for IndexAccessType + +#### Source + +[types.ts:1](http://source-url) + +*** + +### IntersectionType + +```ts +type IntersectionType: TupleType & ArrayType & object; +``` + +Comments for IntersectionType + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `bar` | `number` | + +#### Source + +[types.ts:1](http://source-url) + +*** + +### LiteralType + +```ts +type LiteralType: object; +``` + +Comments for LiteralType + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `someFunctionWithArrow` | () => `string` | Comments for someFunctionWithArrow | +| `x`? | `string` | comment for x | +| `y` | `object` | comment for y | +| `y.x` | `string` | comment for y.x | +| `y.y`? | `boolean` \| `string` | comment for y.y | +| `y.z` | (`x`: `string`) => `string` | comment for y.z | +| `z` | (`x`: `string`) => `string` | - | +| `get accessorA` | [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\> | Comments for accessorA getter | +| `set accessorA` | `void` | Comments for accessorA setter | +| `get accessorB` | `string` | - | +| `set accessorB` | `void` | - | +| `someFunction()` | [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`any`\> | Comments for someFunction | + +#### Source + +[types.ts:1](http://source-url) + +*** + +### PartialMappedType\ + +```ts +type PartialMappedType: { [P in keyof T]?: T[P] }; +``` + +Comments for PartialMappedType + +#### Type Parameters + +| Type Parameter | +| :------ | +| `T` | + +#### Source + +[types.ts:1](http://source-url) + +*** + +### PrimitiveType + +```ts +type PrimitiveType: boolean; +``` + +Comments for PrimitiveType + +#### Source + +[types.ts:1](http://source-url) + +*** + +### PromiseTypeWithObject + +```ts +type PromiseTypeWithObject: Promise; +``` + +Comments for promise type returning object + +#### Type declaration + +| Name | Type | Description | +| :------ | :------ | :------ | +| `x` | `1` | comments for x | + +#### Source + +[types.ts:1](http://source-url) + +*** + +### PromiseTypeWithSymbol + +```ts +type PromiseTypeWithSymbol: Promise; +``` + +Comments for promise type returning symbol + +#### Source + +[types.ts:1](http://source-url) + +*** + +### QueryType + +```ts +type QueryType: typeof someQuery; +``` + +Comments for query type + +#### Source + +[types.ts:1](http://source-url) + +*** + +### ReadonlyMappedType\ + +```ts +type ReadonlyMappedType: { readonly [P in keyof T]: T[P] }; +``` + +Comments for ReadonlyMapedType + +#### Type Parameters + +| Type Parameter | +| :------ | +| `T` | + +#### Source + +[types.ts:1](http://source-url) + +*** + +### StringLiteralType + +```ts +type StringLiteralType: + | " " + | "string" + | "string|with|pipes" + | "string`with`backticks" + | "" + | "*"; +``` + +Comments for StringLiteralType + +#### Source + +[types.ts:1](http://source-url) + +*** + +### Stuff + +```ts +type Stuff: object; +``` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `a` | `string` | +| `b` | `string` | + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### TupleType + +```ts +type TupleType: [string, number]; +``` + +Comments for TupleType + +#### Source + +[types.ts:1](http://source-url) + +*** + +### TypeWithExternalSymbolLinkMapping + +```ts +type TypeWithExternalSymbolLinkMapping: Application; +``` + +Comments for TypeWithExternalSymbolLinkMapping + +#### Source + +[types.ts:1](http://source-url) + +*** + +### TypeWithReturns + +```ts +type TypeWithReturns: string; +``` + +Comments for TypeWithReturns + +#### Returns + +- return comments. + +#### Source + +[types.ts:1](http://source-url) + +*** + +### TypeWithTypeParams\ + +```ts +type TypeWithTypeParams: [T, R]; +``` + +Comments for TypeWithTypeParams + +#### Type Parameters + +| Type Parameter | +| :------ | +| `T` | +| `R` | + +#### Source + +[types.ts:1](http://source-url) + +*** + +### UnionType + +```ts +type UnionType: string | boolean | { + z: string; +}; +``` + +Comments for UnionType + +#### Source + +[types.ts:1](http://source-url) + +*** + +### UnionTypeWithTemplateStrings + +```ts +type UnionTypeWithTemplateStrings: `v${number}` | `v${number}.${number}` | `v${number}.${number}.${number}`; +``` + +Union with template strings + +#### Source + +[types.ts:1](http://source-url) + +*** + +### UsefulUnionType + +```ts +type UsefulUnionType: string | boolean | { + z: string; +}; +``` + +Comments for useful UnionType + +#### Type declaration + +`string` + +`boolean` + +\{ + `z`: `string`; + \} + +| Name | Type | Description | +| :------ | :------ | :------ | +| `z` | `string` | Comments for z | + +#### Source + +[types.ts:1](http://source-url) + +## Variables + +### objectLiteralVariable + +```ts +const objectLiteralVariable: object; +``` + +Comments for objectLiteralVariable + +#### See + +xyz.com + +#### Type declaration + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `valueA` | `number` | 100 | Comments for valueA | +| `valueB` | `boolean` | true | - | +| `valueX` | `object` | - | Comments for valueX | +| `valueX.valueA` | `number`[] | - | Comment for valueX.valueA | +| `valueX.valueY` | (`z`: `string`) => `object` | - | - | +| `valueX.valueZ` | `string` | 'foo' | - | +| `valueY` | (`unionParam`: `"a"` \| `"b"`, `_undercoreParam_`: `string`) => `string` | - | - | + +#### Source + +[variables.ts:1](http://source-url) + +*** + +### objectWithSymbol + +```ts +const objectWithSymbol: object; +``` + +Comments variable with symbol + +#### Type declaration + +| Name | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `[sym]` | `string` | 'value' | Comments for symbol | + +#### Source + +[variables.ts:1](http://source-url) + +*** + +### someQuery + +```ts +const someQuery: 1 = 1; +``` + +#### Source + +[types.ts:1](http://source-url) + +*** + +### stringVariable + +```ts +const stringVariable: "stringConstWithDefaultValue" = 'stringConstWithDefaultValue'; +``` + +A simple string variable + +#### Source + +[variables.ts:1](http://source-url) + +*** + +### templateVariableString + +```ts +const templateVariableString: "\nThis is a template string\n/* with a comment */\nAnd a \n"; +``` + +A template variable string + +#### Source + +[variables.ts:1](http://source-url) + +*** + +### typeOperatorVariable + +```ts +const typeOperatorVariable: unique symbol; +``` + +Comments for typeOperatorVariable + +#### Source + +[variables.ts:1](http://source-url) + +## Functions + +### basicFunction() + +```ts +function basicFunction(someParam: number): number +``` + +This is a function that is assigned to a variable. + +#### See + +http://abc.com + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `someParam` | `number` | This is some numeric parameter. | + +#### Returns + +`number` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### basicFunctionWithReturns() + +```ts +function basicFunctionWithReturns(): number +``` + +This is a function that is assigned to a variable. + +#### Returns + +`number` + +This is a return value + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### curriedFunction() + +Comments for main curriedFunction + +#### Call Signature + +```ts +function curriedFunction(searchElement: unknown): (iterable: Iterable) => boolean +``` + +Comments for current function 1 + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `searchElement` | `unknown` | + +##### Returns + +`Function` + +###### Type Parameters + +| Type Parameter | +| :------ | +| `Value` | + +###### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `iterable` | `Iterable`\<`Value`, `any`, `any`\> | Comments for iterable arg | + +###### Returns + +`boolean` + +##### Source + +[functions.ts:1](http://source-url) + +#### Call Signature + +```ts +function curriedFunction(searchElement: unknown, iterable: Iterable): string +``` + +##### Type Parameters + +| Type Parameter | +| :------ | +| `Value` | + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `searchElement` | `unknown` | +| `iterable` | `Iterable`\<`Value`, `any`, `any`\> | + +##### Returns + +`string` + +##### Source + +[functions.ts:1](http://source-url) + +*** + +### functionReturningAFunction() + +```ts +function functionReturningAFunction(): (x: string) => boolean +``` + +Comments for function + +#### Returns + +`Function` + +##### Type Parameters + +| Type Parameter | +| :------ | +| `T` | + +##### Parameters + +| Parameter | Type | +| :------ | :------ | +| `x` | `string` | + +##### Returns + +`boolean` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionReturningAnObject() + +```ts +function functionReturningAnObject(): object +``` + +Comments for function + +#### Returns + +`object` + +Return comments + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `x` | `number` | 1 | +| `y` | `number` | 2 | + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionReturningAPromise() + +```ts +function functionReturningAPromise(): Promise +``` + +Comments for function + +#### Returns + +[`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`object`\> + +Return comments + +| Name | Type | +| :------ | :------ | +| `prop` | `string` | + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionReturningAString() + +```ts +function functionReturningAString(): string +``` + +Comments for function + +#### Returns + +`string` + +Return comments + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionReturningAUnionType() + +```ts +function functionReturningAUnionType(): string | boolean | "string1" | "string2" +``` + +Comments for function + +#### Returns + +`string` \| `boolean` \| `"string1"` \| `"string2"` + +Return comments + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithArrayOfOptionalStuff() + +```ts +function functionWithArrayOfOptionalStuff(a: [Stuff?]): void +``` + +Comments for array of stuff? + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `a` | [[`Stuff`](README.md#stuff)?] | + +#### Returns + +`void` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithArrayOfStuff() + +```ts +function functionWithArrayOfStuff(a: [Stuff]): void +``` + +Comments for array of stuff + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `a` | [[`Stuff`](README.md#stuff)] | + +#### Returns + +`void` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithComplexParams() + +```ts +function functionWithComplexParams(paramA: (a: string) => true, paramB: object): boolean +``` + +Function with function parmas + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `paramA` | (`a`: `string`) => `true` | +| `paramB` | \{ `x`: `1`; \} | +| `paramB.x` | `1` | + +#### Returns + +`boolean` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithDefaultParameters() + +```ts +function functionWithDefaultParameters( + valueA: string, + valueB: number, + valueC: number, + valueD: boolean, + valueE: boolean, + valueF: string): string +``` + +This is a function with a parameter that has a default value. + +#### Parameters + +| Parameter | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `valueA` | `string` | `'defaultValue'` | A parameter with a default string value. | +| `valueB` | `number` | `100` | A parameter with a default numeric value. | +| `valueC` | `number` | `Number.NaN` | A parameter with a default NaN value. | +| `valueD` | `boolean` | `true` | A parameter with a default boolean value. | +| `valueE` | `boolean` | `true` | A parameter with a default null value. | +| `valueF` | `string` | `''` | - | + +#### Returns + +`string` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithMultipleSignatures() + +Main function comment. + +#### Call Signature + +```ts +function functionWithMultipleSignatures(value: string): string +``` + +This is the first signature of a function with multiple signatures. + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `value` | `string` | The name value. | + +##### Returns + +`string` + +##### Source + +[functions.ts:1](http://source-url) + +#### Call Signature + +```ts +function functionWithMultipleSignatures(value: object): string +``` + +This is the second signature of a function with multiple signatures. + +##### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `value` | \{ `name`: `string`; \} | An object containing the name value. | +| `value.name` | `string` | A value of the object. | + +##### Returns + +`string` + +##### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithNamedParams() + +```ts +function functionWithNamedParams(__namedParameters: object, anotherParam: string): void +``` + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `__namedParameters` | \{ `bar`: `number`; `foo`: `number`; \} | various options | +| `__namedParameters.bar`? | `number` | - | +| `__namedParameters.foo`? | `number` | - | +| `anotherParam` | `string` | Another param comment | + +#### Returns + +`void` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithNestedParameters() + +```ts +function functionWithNestedParameters( + params: object, + context: any, + somethingElse?: string): boolean +``` + +Some nested params. + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `params` | \{ `name`: `string`; `nestedObj`: `object`; `parent`: `number`; \} | The parameters passed to the method. | +| `params.name` | `string` | The name of the new group. | +| `params.nestedObj` | \{ `name`: `string`; `obj`: `object`; `value`: `number`; \} | A nested object. | +| `params.nestedObj.name`? | `string` | - | +| `params.nestedObj.obj`? | \{ `name`: () => `void`; \} | - | +| `params.nestedObj.obj.name`? | () => `void` | - | +| `params.nestedObj.value`? | `number` | - | +| `params.parent`? | `number` | - | +| `context`? | `any` | The context of the method call. | +| `somethingElse`? | `string` | - | + +#### Returns + +`boolean` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithOptionalParameters() + +```ts +function functionWithOptionalParameters( + firstParamWithDefault: boolean, + requiredParam: string, + optionalParam?: string, + paramWithDefault?: number): void +``` + +This is a function with a parameters. + +#### Parameters + +| Parameter | Type | Default value | Description | +| :------ | :------ | :------ | :------ | +| `firstParamWithDefault` | `boolean` | `true` | - | +| `requiredParam` | `string` | `undefined` | A normal parameter. | +| `optionalParam`? | `string` | `undefined` | An optional parameter. | +| `paramWithDefault`? | `number` | `0` | - | + +#### Returns + +`void` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithRestParams() + +```ts +function functionWithRestParams(param: string, ...restParams: string[]): boolean +``` + +Function with reset parmas + +#### Parameters + +| Parameter | Type | +| :------ | :------ | +| `param` | `string` | +| ...`restParams` | `string`[] | + +#### Returns + +`boolean` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithTypeParameters() + +```ts +function functionWithTypeParameters(): boolean +``` + +Function with type parameters + +#### Type Parameters + +| Type Parameter | Default type | Description | +| :------ | :------ | :------ | +| `T` | - | Comments for T | +| `Item` | `string` \| `boolean` | - | + +#### Returns + +`boolean` + +#### Source + +[functions.ts:1](http://source-url) + +*** + +### functionWithUnionParams() + +```ts +function functionWithUnionParams( + primitiveUnions: string | number, + objectUnions: object, + mixedUnions: string | { + a: string; + b: string; + }, + noUnions: string): undefined +``` + +#### Parameters + +| Parameter | Type | Description | +| :------ | :------ | :------ | +| `primitiveUnions` | `string` \| `number` | Comments for primitiveUnions | +| `objectUnions` | \{ `a`: `string`; `b`: `1`; \} | Comments for objectUnions | +| `objectUnions.a` | `string` | Comments for a | +| `objectUnions.b` | `1` | - | +| `mixedUnions` | `string` \| \{ `a`: `string`; `b`: `string`; \} | - | +| `noUnions` | `string` | Comments for noUnions | + +#### Returns + +`undefined` + +#### Source + +[functions.ts:1](http://source-url) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-2/sidebar.json new file mode 100644 index 000000000..0637a088a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/reflections/modules/opts-2/sidebar.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/README.md new file mode 100644 index 000000000..43fba54af --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/README.md @@ -0,0 +1,14 @@ +**My API - v0.0** + +*** + +# :tada: Custom Index Title + +## モジュール + +- [module-1](module-1/README.md) +- [module-2](module-2/README.md) + +*** + +Copyright Test diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/module-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/module-1/README.md new file mode 100644 index 000000000..4305d2465 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/module-1/README.md @@ -0,0 +1,17 @@ +[**My API - v0.0**](../README.md) + +*** + +[typedoc-stubs](../README.md) / module-1 + +# module-1 + +## インデックス + +### インターフェイス + +- [SomeInterface](interfaces/SomeInterface.md) + +*** + +Copyright Test diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/module-1/interfaces/SomeInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/module-1/interfaces/SomeInterface.md new file mode 100644 index 000000000..fb8061302 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/module-1/interfaces/SomeInterface.md @@ -0,0 +1,23 @@ +[**My API - v0.0**](../../README.md) + +*** + +[typedoc-stubs](../../README.md) / [module-1](../README.md) / SomeInterface + +# SomeInterface + +## プロパティ + +| プロパティ | Type (jp) | 説明 | +| :------ | :------ | :------ | +| `someProp?` | `boolean` | Description for prop someProp | + +## Events + +| イベント | Type (jp) | +| :------ | :------ | +| `someEvent` | `MouseEvent` | + +*** + +Copyright Test diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/module-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/module-2/README.md new file mode 100644 index 000000000..b6b216ac6 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/module-2/README.md @@ -0,0 +1,17 @@ +[**My API - v0.0**](../README.md) + +*** + +[typedoc-stubs](../README.md) / module-2 + +# module-2 + +## インデックス + +### 変数 + +- [constA](variables/constA.md) + +*** + +Copyright Test diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/module-2/variables/constA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/module-2/variables/constA.md new file mode 100644 index 000000000..b7172e44a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/module-2/variables/constA.md @@ -0,0 +1,13 @@ +[**My API - v0.0**](../../README.md) + +*** + +[typedoc-stubs](../../README.md) / [module-2](../README.md) / constA + +# constA + +> `const` **constA**: `true` = `true` + +*** + +Copyright Test diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/sidebar.json new file mode 100644 index 000000000..c30ebd5cd --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-1/sidebar.json @@ -0,0 +1,36 @@ +[ + { + "title": "module-1", + "kind": 2, + "path": "module-1/README.md", + "children": [ + { + "title": "インターフェイス", + "children": [ + { + "title": "SomeInterface", + "kind": 256, + "path": "module-1/interfaces/SomeInterface.md" + } + ] + } + ] + }, + { + "title": "module-2", + "kind": 2, + "path": "module-2/README.md", + "children": [ + { + "title": "変数", + "children": [ + { + "title": "constA", + "kind": 32, + "path": "module-2/variables/constA.md" + } + ] + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/README.md new file mode 100644 index 000000000..fdbaaf3d1 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/README.md @@ -0,0 +1,10 @@ +**typedoc-stubs v0.0** + +*** + +# :tada typedoc-stubs and version 0.0 + +## Modules + +- [module-1](module-1/README.md) +- [module-2](module-2/README.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/module-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/module-1/README.md new file mode 100644 index 000000000..9c467b12f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/module-1/README.md @@ -0,0 +1,13 @@ +[**typedoc-stubs v0.0**](../README.md) + +*** + +[Home](../README.md) / module-1 + +# Module - module-1 + +## TOC + +### CoolInterfaces + +- [SomeInterface](interfaces/SomeInterface.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/module-1/interfaces/SomeInterface.md b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/module-1/interfaces/SomeInterface.md new file mode 100644 index 000000000..8298a2815 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/module-1/interfaces/SomeInterface.md @@ -0,0 +1,19 @@ +[**typedoc-stubs v0.0**](../../README.md) + +*** + +[Home](../../README.md) / [module-1](../README.md) / SomeInterface + +# CoolInterfaces: Interface - SomeInterface + +## Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `someProp?` | `boolean` | Description for prop someProp | + +## Events + +| Event | Type | +| :------ | :------ | +| `someEvent` | `MouseEvent` | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/module-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/module-2/README.md new file mode 100644 index 000000000..4cb707d7c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/module-2/README.md @@ -0,0 +1,13 @@ +[**typedoc-stubs v0.0**](../README.md) + +*** + +[Home](../README.md) / module-2 + +# Module - module-2 + +## TOC + +### CoolVars + +- [constA](variables/constA.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/module-2/variables/constA.md b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/module-2/variables/constA.md new file mode 100644 index 000000000..669437ef8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/module-2/variables/constA.md @@ -0,0 +1,9 @@ +[**typedoc-stubs v0.0**](../../README.md) + +*** + +[Home](../../README.md) / [module-2](../README.md) / constA + +# CoolVars: Variable - constA + +> `const` **constA**: `true` = `true` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/sidebar.json new file mode 100644 index 000000000..b4b0b1f1d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/members/opts-2/sidebar.json @@ -0,0 +1,36 @@ +[ + { + "title": "module-1", + "kind": 2, + "path": "module-1/README.md", + "children": [ + { + "title": "CoolInterfaces", + "children": [ + { + "title": "SomeInterface", + "kind": 256, + "path": "module-1/interfaces/SomeInterface.md" + } + ] + } + ] + }, + { + "title": "module-2", + "kind": 2, + "path": "module-2/README.md", + "children": [ + { + "title": "CoolVars", + "children": [ + { + "title": "constA", + "kind": 32, + "path": "module-2/variables/constA.md" + } + ] + } + ] + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-1/README.md new file mode 100644 index 000000000..6c03eb297 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-1/README.md @@ -0,0 +1,14 @@ +**My API - v0.0** + +*** + +# :tada: Custom Index Title + +## モジュール + +- [module-1](module-1.md) +- [module-2](module-2.md) + +*** + +Copyright Test diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-1/module-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-1/module-1.md new file mode 100644 index 000000000..edaa84806 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-1/module-1.md @@ -0,0 +1,27 @@ +[**My API - v0.0**](README.md) + +*** + +[typedoc-stubs](README.md) / module-1 + +# module-1 + +## インターフェイス + +### SomeInterface + +#### プロパティ + +| プロパティ | Type (jp) | 説明 | +| :------ | :------ | :------ | +| `someProp?` | `boolean` | Description for prop someProp | + +#### Events + +| イベント | Type (jp) | +| :------ | :------ | +| `someEvent` | `MouseEvent` | + +*** + +Copyright Test diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-1/module-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-1/module-2.md new file mode 100644 index 000000000..e3442556f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-1/module-2.md @@ -0,0 +1,17 @@ +[**My API - v0.0**](README.md) + +*** + +[typedoc-stubs](README.md) / module-2 + +# module-2 + +## 変数 + +### constA + +> `const` **constA**: `true` = `true` + +*** + +Copyright Test diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-1/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-1/sidebar.json new file mode 100644 index 000000000..c5e019107 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-1/sidebar.json @@ -0,0 +1,12 @@ +[ + { + "title": "module-1", + "kind": 2, + "path": "module-1.md" + }, + { + "title": "module-2", + "kind": 2, + "path": "module-2.md" + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-2/README.md new file mode 100644 index 000000000..822fc9784 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-2/README.md @@ -0,0 +1,10 @@ +**typedoc-stubs v0.0** + +*** + +# :tada typedoc-stubs and version 0.0 + +## Modules + +- [module-1](module-1.md) +- [module-2](module-2.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-2/module-1.md b/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-2/module-1.md new file mode 100644 index 000000000..46cf7ceb8 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-2/module-1.md @@ -0,0 +1,23 @@ +[**typedoc-stubs v0.0**](README.md) + +*** + +[Home](README.md) / module-1 + +# Module - module-1 + +## CoolInterfaces + +### SomeInterface + +#### Properties + +| Property | Type | Description | +| :------ | :------ | :------ | +| `someProp?` | `boolean` | Description for prop someProp | + +#### Events + +| Event | Type | +| :------ | :------ | +| `someEvent` | `MouseEvent` | diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-2/module-2.md b/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-2/module-2.md new file mode 100644 index 000000000..3a12afb51 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-2/module-2.md @@ -0,0 +1,13 @@ +[**typedoc-stubs v0.0**](README.md) + +*** + +[Home](README.md) / module-2 + +# Module - module-2 + +## CoolVars + +### constA + +> `const` **constA**: `true` = `true` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-2/sidebar.json b/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-2/sidebar.json new file mode 100644 index 000000000..c5e019107 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/text/modules/opts-2/sidebar.json @@ -0,0 +1,12 @@ +[ + { + "title": "module-1", + "kind": 2, + "path": "module-1.md" + }, + { + "title": "module-2", + "kind": 2, + "path": "module-2.md" + } +] \ No newline at end of file diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/README.md new file mode 100644 index 000000000..a11d1789d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/README.md @@ -0,0 +1,17 @@ +# typedoc-stubs + +## Classes + +- [ClassWithChars](classes/ClassWithChars.md) + +## Interfaces + +- [InterfaceWithChars](interfaces/InterfaceWithChars.md) + +## Variables + +- [variableWithChars](variables/variableWithChars.md) + +## Functions + +- [some\_prettier\_function](functions/some_prettier_function.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/classes/ClassWithChars.md b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/classes/ClassWithChars.md new file mode 100644 index 000000000..a9f0b753e --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/classes/ClassWithChars.md @@ -0,0 +1,23 @@ +# Class: ClassWithChars<T> + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +## Constructors + +### new ClassWithChars() + +> **new ClassWithChars**<`T`>(): [`ClassWithChars`](ClassWithChars.md)<`T`> + +#### Returns + +[`ClassWithChars`](ClassWithChars.md)<`T`> + +## Properties + +### prop + +> **prop**: `T` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/functions/some_prettier_function.md b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/functions/some_prettier_function.md new file mode 100644 index 000000000..03057d910 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/functions/some_prettier_function.md @@ -0,0 +1,28 @@ +# Function: some\_prettier\_function() + +> **some\_prettier\_function**(`param`): `string` + +```ts +reallyUgly ( +javascript + ) +``` + +```ts +const originalSingleQuote = 'hello' +const originalDoubleQuote = "hello" +``` + +```css +.h1 { color : red } +``` + +## Parameters + +| Parameter | Type | +| ------ | ------ | +| `param` | `string` | + +## Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/interfaces/InterfaceWithChars.md b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/interfaces/InterfaceWithChars.md new file mode 100644 index 000000000..868abb795 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/interfaces/InterfaceWithChars.md @@ -0,0 +1,31 @@ +# Interface: InterfaceWithChars<T> + +## Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +## Properties + +### < + +> **<**: `string` + +*** + +### <tag> + +> **<tag>**: `string` + +*** + +### > + +> **>**: `string` + +*** + +### prop + +> **prop**: `T` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/variables/variableWithChars.md b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/variables/variableWithChars.md new file mode 100644 index 000000000..2f200b6b2 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-1/variables/variableWithChars.md @@ -0,0 +1,17 @@ +# Variable: variableWithChars + +> `const` **variableWithChars**: \{``: `string`;``: `string`;``: `string`; \} + +## Type declaration + +### <x> + +> **<x>**: `string` = `'>'` + +### <y> + +> **<y>**: `string` = `'<'` + +### <z> + +> **<z>**: `string` = `''` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/README.md new file mode 100644 index 000000000..0b0581782 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/README.md @@ -0,0 +1,17 @@ +# typedoc-stubs + +## Classes + +- [ClassWithChars](classes/ClassWithChars.md) + +## Interfaces + +- [InterfaceWithChars](interfaces/InterfaceWithChars.md) + +## Variables + +- [variableWithChars](variables/variableWithChars.md) + +## Functions + +- [some_prettier_function](functions/some_prettier_function.md) diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/classes/ClassWithChars.md b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/classes/ClassWithChars.md new file mode 100644 index 000000000..a4b0e104d --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/classes/ClassWithChars.md @@ -0,0 +1,27 @@ +# Class: ClassWithChars<T> + +## Type Parameters + +| Type Parameter | +| -------------- | +| `T` | + +## Constructors + +### new ClassWithChars() + +```ts +new ClassWithChars(): ClassWithChars +``` + +#### Returns + +[`ClassWithChars`](ClassWithChars.md)<`T`> + +## Properties + +### prop + +```ts +prop: T; +``` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/functions/some_prettier_function.md b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/functions/some_prettier_function.md new file mode 100644 index 000000000..185d1f63a --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/functions/some_prettier_function.md @@ -0,0 +1,30 @@ +# Function: some_prettier_function() + +```ts +function some_prettier_function(param): string; +``` + +```ts +reallyUgly(javascript); +``` + +```ts +const originalSingleQuote = "hello"; +const originalDoubleQuote = "hello"; +``` + +```css +.h1 { + color: red; +} +``` + +## Parameters + +| Parameter | Type | +| --------- | -------- | +| `param` | `string` | + +## Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/interfaces/InterfaceWithChars.md b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/interfaces/InterfaceWithChars.md new file mode 100644 index 000000000..2c987e74c --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/interfaces/InterfaceWithChars.md @@ -0,0 +1,39 @@ +# Interface: InterfaceWithChars<T> + +## Type Parameters + +| Type Parameter | +| -------------- | +| `T` | + +## Properties + +### < + +```ts +<: string; +``` + +--- + +### <tag> + +```ts +: string; +``` + +--- + +### > + +```ts +>: string; +``` + +--- + +### prop + +```ts +prop: T; +``` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/variables/variableWithChars.md b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/variables/variableWithChars.md new file mode 100644 index 000000000..ba3fe987f --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/members/opts-2/variables/variableWithChars.md @@ -0,0 +1,29 @@ +# Variable: variableWithChars + +```ts +const variableWithChars: { + : string; + : string; + : string; +}; +``` + +## Type declaration + +### <x> + +```ts +: string = '>'; +``` + +### <y> + +```ts +: string = '<'; +``` + +### <z> + +```ts +: string = ''; +``` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/utils/modules/opts-1/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/modules/opts-1/README.md new file mode 100644 index 000000000..ee7f8d039 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/modules/opts-1/README.md @@ -0,0 +1,106 @@ +# typedoc-stubs + +## Classes + +### ClassWithChars<T> + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +#### Constructors + +##### new ClassWithChars() + +> **new ClassWithChars**<`T`>(): [`ClassWithChars`](README.md#classwithcharst)<`T`> + +###### Returns + +[`ClassWithChars`](README.md#classwithcharst)<`T`> + +#### Properties + +##### prop + +> **prop**: `T` + +## Interfaces + +### InterfaceWithChars<T> + +#### Type Parameters + +| Type Parameter | +| ------ | +| `T` | + +#### Properties + +##### < + +> **<**: `string` + +##### <tag> + +> **<tag>**: `string` + +##### > + +> **>**: `string` + +##### prop + +> **prop**: `T` + +## Variables + +### variableWithChars + +> `const` **variableWithChars**: \{``: `string`;``: `string`;``: `string`; \} + +#### Type declaration + +##### <x> + +> **<x>**: `string` = `'>'` + +##### <y> + +> **<y>**: `string` = `'<'` + +##### <z> + +> **<z>**: `string` = `''` + +## Functions + +### some\_prettier\_function() + +> **some\_prettier\_function**(`param`): `string` + +```ts +reallyUgly ( +javascript + ) +``` + +```ts +const originalSingleQuote = 'hello' +const originalDoubleQuote = "hello" +``` + +```css +.h1 { color : red } +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `param` | `string` | + +#### Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/out/utils/modules/opts-2/README.md b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/modules/opts-2/README.md new file mode 100644 index 000000000..024ea6ef4 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/out/utils/modules/opts-2/README.md @@ -0,0 +1,132 @@ +# typedoc-stubs + +## Classes + +### ClassWithChars<T> + +#### Type Parameters + +| Type Parameter | +| -------------- | +| `T` | + +#### Constructors + +##### new ClassWithChars() + +```ts +new ClassWithChars(): ClassWithChars +``` + +###### Returns + +[`ClassWithChars`](README.md#classwithcharst)<`T`> + +#### Properties + +##### prop + +```ts +prop: T; +``` + +## Interfaces + +### InterfaceWithChars<T> + +#### Type Parameters + +| Type Parameter | +| -------------- | +| `T` | + +#### Properties + +##### < + +```ts +<: string; +``` + +##### <tag> + +```ts +: string; +``` + +##### > + +```ts +>: string; +``` + +##### prop + +```ts +prop: T; +``` + +## Variables + +### variableWithChars + +```ts +const variableWithChars: { + : string; + : string; + : string; +}; +``` + +#### Type declaration + +##### <x> + +```ts +: string = '>'; +``` + +##### <y> + +```ts +: string = '<'; +``` + +##### <z> + +```ts +: string = ''; +``` + +## Functions + +### some_prettier_function() + +```ts +function some_prettier_function(param): string; +``` + +```ts +reallyUgly(javascript); +``` + +```ts +const originalSingleQuote = "hello"; +const originalDoubleQuote = "hello"; +``` + +```css +.h1 { + color: red; +} +``` + +#### Parameters + +| Parameter | Type | +| --------- | -------- | +| `param` | `string` | + +#### Returns + +`string` diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/readme/index.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/readme/index.ts index 3b90ec41f..9a694c33d 100644 --- a/packages/typedoc-plugin-markdown/test/fixtures/src/readme/index.ts +++ b/packages/typedoc-plugin-markdown/test/fixtures/src/readme/index.ts @@ -1,5 +1,5 @@ /** - * Module commments + * Module comments for documentation. * * @module */ diff --git a/devtools/packages/fixtures/typedoc.cjs b/packages/typedoc-plugin-markdown/test/fixtures/typedoc.cjs similarity index 100% rename from devtools/packages/fixtures/typedoc.cjs rename to packages/typedoc-plugin-markdown/test/fixtures/typedoc.cjs diff --git a/packages/typedoc-plugin-markdown/test/fixtures/typedoc.readme.cjs b/packages/typedoc-plugin-markdown/test/fixtures/typedoc.readme.cjs new file mode 100644 index 000000000..52e790522 --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/typedoc.readme.cjs @@ -0,0 +1,11 @@ +// @ts-check + +const baseOptions = require('./typedoc.cjs'); + +/** @type {import('typedoc').TypeDocOptions & import('typedoc-plugin-markdown').PluginOptions} */ +module.exports = { + ...baseOptions, + pageTitleTemplates: { + index: 'My API - {version}', + }, +}; diff --git a/packages/typedoc-plugin-markdown/test/fixtures/typedoc.text-1.cjs b/packages/typedoc-plugin-markdown/test/fixtures/typedoc.text-1.cjs new file mode 100644 index 000000000..86cc92dfe --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/typedoc.text-1.cjs @@ -0,0 +1,21 @@ +// @ts-check + +const baseOptions = require('./typedoc.cjs'); + +/** @type {import('typedoc').TypeDocOptions} */ +module.exports = { + ...baseOptions, + textContentMappings: { + 'breadcrumb.index': 'Home', + 'header.title': 'My API - {version}', + 'footer.text': 'Copyright Test', + 'title.indexPage': ':tada: Custom Index Title', + 'title.memberPage': '{name}', + }, + lang: 'jp', + locales: { + jp: { + theme_type: 'Type (jp)', + }, + }, +}; diff --git a/packages/typedoc-plugin-markdown/test/fixtures/typedoc.text-2.cjs b/packages/typedoc-plugin-markdown/test/fixtures/typedoc.text-2.cjs new file mode 100644 index 000000000..4106c24cf --- /dev/null +++ b/packages/typedoc-plugin-markdown/test/fixtures/typedoc.text-2.cjs @@ -0,0 +1,23 @@ +// @ts-check + +const baseOptions = require('./typedoc.cjs'); + +/** @type {import('typedoc').TypeDocOptions & import('typedoc-plugin-markdown').PluginOptions} */ +module.exports = { + ...baseOptions, + textContentMappings: { + 'breadcrumbs.home': 'Home', + }, + pageTitleTemplates: { + index: (args) => `:tada ${args.projectName} and version ${args.version}`, + member: (args) => `${args.group}: ${args.kind} - ${args.name}`, + module: (args) => `${args.kind} - ${args.name}`, + }, + locales: { + en: { + theme_index: 'TOC', + kind_plural_interface: 'CoolInterfaces', + kind_plural_variable: 'CoolVars', + }, + }, +}; diff --git a/packages/typedoc-plugin-markdown/test/fixtures/typedoc.text-locales.cjs b/packages/typedoc-plugin-markdown/test/fixtures/typedoc.text-locales.cjs deleted file mode 100644 index a81d368ac..000000000 --- a/packages/typedoc-plugin-markdown/test/fixtures/typedoc.text-locales.cjs +++ /dev/null @@ -1,19 +0,0 @@ -// @ts-check - -const baseOptions = require('../../../../devtools/packages/fixtures/typedoc.cjs'); - -/** @type {import('typedoc').TypeDocOptions} */ -module.exports = { - ...baseOptions, - textContentMappings: { - 'header.title': 'My API - {version} (jp)', - 'header.docs': 'Docs (jp)', - 'footer.text': 'Copyright Test (jp)', - }, - lang: 'jp', - locales: { - jp: { - theme_type: 'Type (jp)', - }, - }, -}; diff --git a/packages/typedoc-plugin-markdown/test/fixtures/typedoc.text-mappings.cjs b/packages/typedoc-plugin-markdown/test/fixtures/typedoc.text-mappings.cjs deleted file mode 100644 index d18a659b1..000000000 --- a/packages/typedoc-plugin-markdown/test/fixtures/typedoc.text-mappings.cjs +++ /dev/null @@ -1,22 +0,0 @@ -// @ts-check - -const baseOptions = require('../../../../devtools/packages/fixtures/typedoc.cjs'); - -/** @type {import('typedoc').TypeDocOptions} */ -module.exports = { - ...baseOptions, - textContentMappings: { - 'header.title': 'My API - {version}', - 'header.docs': 'API', - 'footer.text': 'Copyright Test', - 'title.indexPage': ':tada: Custom Index Title', - 'title.memberPage': (args) => `${args.group}: ${args.name}`, - }, - locales: { - en: { - theme_index: 'TOC', - kind_plural_interface: 'CoolInterfaces', - kind_plural_variable: 'CoolVars', - }, - }, -}; diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap index c7359e855..9770ffb21 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap @@ -321,7 +321,7 @@ exports[`Comments should get tables for properties: (Output File Strategy "membe ## Constructors -### Constructor +### new ClassPropertiesTable() > **new ClassPropertiesTable**(): [\`ClassPropertiesTable\`](ClassPropertiesTable.md) @@ -357,7 +357,7 @@ exports[`Comments should get tables for properties: (Output File Strategy "membe -### Constructor +### new ClassPropertiesTable() > **new ClassPropertiesTable**(): [\`ClassPropertiesTable\`](https://example.com/Class.ClassPropertiesTable.md) diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/entryfiles.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/entryfiles.spec.ts.snap index 69c4f8bf7..95c7eee98 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/entryfiles.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/entryfiles.spec.ts.snap @@ -1,7 +1,7 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`EntryFiles should get entry module: (Output File Strategy "members") (Option Group "1") 1`] = ` -"**@scope/entryfile** • **Documentation** +"**@scope/entryfile** *** @@ -16,7 +16,7 @@ exports[`EntryFiles should get entry module: (Output File Strategy "members") (O `; exports[`EntryFiles should get entry module: (Output File Strategy "members") (Option Group "2") 1`] = ` -"**@scope/entryfile** • **Documentation** +"**@scope/entryfile** *** @@ -31,7 +31,7 @@ exports[`EntryFiles should get entry module: (Output File Strategy "members") (O `; exports[`EntryFiles should get module member for members: (Output File Strategy "members") (Option Group "1") 1`] = ` -"[**@scope/entryfile**](../../README.mdx) • **Documentation** +"[**@scope/entryfile**](../../README.mdx) *** @@ -41,7 +41,7 @@ exports[`EntryFiles should get module member for members: (Output File Strategy ## Constructors -### Constructor +### new ModuleClass() > **new ModuleClass**(): [\`ModuleClass\`](ModuleClass.mdx) @@ -52,7 +52,7 @@ exports[`EntryFiles should get module member for members: (Output File Strategy `; exports[`EntryFiles should get module member for members: (Output File Strategy "members") (Option Group "2") 1`] = ` -"[**@scope/entryfile**](../../index.mdx) • **Documentation** +"[**@scope/entryfile**](../../index.mdx) *** @@ -62,7 +62,7 @@ exports[`EntryFiles should get module member for members: (Output File Strategy ## Constructors -### Constructor +### new ModuleClass() > **new ModuleClass**(): [\`ModuleClass\`](ModuleClass.mdx) @@ -73,7 +73,7 @@ exports[`EntryFiles should get module member for members: (Output File Strategy `; exports[`EntryFiles should get readme file: (Output File Strategy "members") (Option Group "1") 1`] = ` -"[**@scope/entryfile**](README.mdx) • [**Documentation**](README.mdx) +"[**@scope/entryfile**](README.mdx) *** diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/groups.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/groups.spec.ts.snap index 0afd19ef3..a295f1c56 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/groups.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/groups.spec.ts.snap @@ -1,7 +1,7 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`Groups should compile basic module index page: (Output File Strategy "members") (Option Group "1") 1`] = ` -"[**typedoc-stubs**](../index.md) • **Documentation** +"[**typedoc-stubs**](../index.md) *** @@ -57,7 +57,7 @@ A basic module `; exports[`Groups should compile basic module index page: (Output File Strategy "members") (Option Group "2") 1`] = ` -"[**typedoc-stubs**](../index.md) • **Documentation** +"[**typedoc-stubs**](../index.md) *** @@ -272,7 +272,7 @@ _DECLARATION_MEMBER_PARTIAL_ `; exports[`Groups should compile basic module index page: (Output File Strategy "modules") (Option Group "1") 1`] = ` -"[**typedoc-stubs**](index.md) • **Documentation** +"[**typedoc-stubs**](index.md) *** @@ -300,7 +300,7 @@ ClassA function. #### Constructors -##### Constructor +##### new ClassA() _SIGNATURE_MEMBER_PARTIAL_ @@ -310,7 +310,7 @@ _SIGNATURE_MEMBER_PARTIAL_ #### Constructors -##### Constructor +##### new ClassB() _SIGNATURE_MEMBER_PARTIAL_ @@ -380,7 +380,7 @@ _SIGNATURE_MEMBER_PARTIAL_ `; exports[`Groups should compile basic module index page: (Output File Strategy "modules") (Option Group "2") 1`] = ` -"[**typedoc-stubs**](index.md) • **Documentation** +"[**typedoc-stubs**](index.md) *** @@ -449,7 +449,7 @@ ClassA function. -#### Constructor +#### new ClassA() _SIGNATURE_MEMBER_PARTIAL_ @@ -463,7 +463,7 @@ _SIGNATURE_MEMBER_PARTIAL_ -#### Constructor +#### new ClassB() _SIGNATURE_MEMBER_PARTIAL_ @@ -516,7 +516,7 @@ _DECLARATION_MEMBER_PARTIAL_ `; exports[`Groups should compile categories group page: (Output File Strategy "modules") (Option Group "1") 1`] = ` -"[**typedoc-stubs**](index.md) • **Documentation** +"[**typedoc-stubs**](index.md) *** @@ -581,7 +581,7 @@ A module that contains categories `; exports[`Groups should compile categories group page: (Output File Strategy "modules") (Option Group "2") 1`] = ` -"[**typedoc-stubs**](index.md) • **Documentation** +"[**typedoc-stubs**](index.md) *** @@ -666,7 +666,7 @@ A module that contains categories `; exports[`Groups should compile categories index page: (Output File Strategy "members") (Option Group "1") 1`] = ` -"[**typedoc-stubs**](../index.md) • **Documentation** +"[**typedoc-stubs**](../index.md) *** @@ -732,7 +732,7 @@ A module that contains categories `; exports[`Groups should compile categories index page: (Output File Strategy "members") (Option Group "2") 1`] = ` -"[**typedoc-stubs**](../index.md) • **Documentation** +"[**typedoc-stubs**](../index.md) *** @@ -943,7 +943,7 @@ A module that contains categories `; exports[`Groups should compile custom groups index page: (Output File Strategy "members") (Option Group "1") 1`] = ` -"[**typedoc-stubs**](../index.md) • **Documentation** +"[**typedoc-stubs**](../index.md) *** @@ -977,7 +977,7 @@ A module that contains custom groupings `; exports[`Groups should compile custom groups index page: (Output File Strategy "members") (Option Group "2") 1`] = ` -"[**typedoc-stubs**](../index.md) • **Documentation** +"[**typedoc-stubs**](../index.md) *** @@ -1020,7 +1020,7 @@ _DECLARATION_MEMBER_PARTIAL_ `; exports[`Groups should compile index page for project: (Output File Strategy "members") (Option Group "1") 1`] = ` -"[**typedoc-stubs**](index.md) • **Documentation** +"[**typedoc-stubs**](index.md) *** @@ -1043,7 +1043,7 @@ exports[`Groups should compile index page for project: (Output File Strategy "me `; exports[`Groups should compile index page for project: (Output File Strategy "members") (Option Group "2") 1`] = ` -"**typedoc-stubs** • **Documentation** +"**typedoc-stubs** *** @@ -1173,7 +1173,7 @@ A module named index `; exports[`Groups should compile index page for project: (Output File Strategy "modules") (Option Group "1") 1`] = ` -"[**typedoc-stubs**](index.md) • **Documentation** +"[**typedoc-stubs**](index.md) *** @@ -1196,7 +1196,7 @@ exports[`Groups should compile index page for project: (Output File Strategy "mo `; exports[`Groups should compile index page for project: (Output File Strategy "modules") (Option Group "2") 1`] = ` -"**typedoc-stubs** • **Documentation** +"**typedoc-stubs** *** @@ -1326,7 +1326,7 @@ A module named index `; exports[`Groups should compile module index for a namespace: (Output File Strategy "members") (Option Group "1") 1`] = ` -"[**typedoc-stubs**](../../../index.md) • **Documentation** +"[**typedoc-stubs**](../../../index.md) *** @@ -1351,7 +1351,7 @@ exports[`Groups should compile module index for a namespace: (Output File Strate `; exports[`Groups should compile module index for a namespace: (Output File Strategy "members") (Option Group "2") 1`] = ` -"[**typedoc-stubs**](../../../index.md) • **Documentation** +"[**typedoc-stubs**](../../../index.md) *** @@ -1414,7 +1414,7 @@ exports[`Groups should compile module index for a namespace: (Output File Strate `; exports[`Groups should compile module index for a namespace: (Output File Strategy "modules") (Option Group "1") 1`] = ` -"[**typedoc-stubs**](../../../index.md) • **Documentation** +"[**typedoc-stubs**](../../../index.md) *** @@ -1437,7 +1437,7 @@ exports[`Groups should compile module index for a namespace: (Output File Strate `; exports[`Groups should compile module index for a namespace: (Output File Strategy "modules") (Option Group "2") 1`] = ` -"[**typedoc-stubs**](../../../index.md) • **Documentation** +"[**typedoc-stubs**](../../../index.md) *** @@ -1479,7 +1479,7 @@ exports[`Groups should compile module index for a namespace: (Output File Strate `; exports[`Groups should compile module index with namespaces index page: (Output File Strategy "members") (Option Group "1") 1`] = ` -"[**typedoc-stubs**](../index.md) • **Documentation** +"[**typedoc-stubs**](../index.md) *** @@ -1543,7 +1543,7 @@ A module that contains namespaces `; exports[`Groups should compile module index with namespaces index page: (Output File Strategy "members") (Option Group "2") 1`] = ` -"[**typedoc-stubs**](../index.md) • **Documentation** +"[**typedoc-stubs**](../index.md) *** @@ -1794,7 +1794,7 @@ _DECLARATION_MEMBER_PARTIAL_ `; exports[`Groups should compile module index with namespaces index page: (Output File Strategy "modules") (Option Group "1") 1`] = ` -"[**typedoc-stubs**](../index.md) • **Documentation** +"[**typedoc-stubs**](../index.md) *** @@ -1827,7 +1827,7 @@ A module that contains namespaces #### Constructors -##### Constructor +##### new \\_\\_Class\\_A\\_() _SIGNATURE_MEMBER_PARTIAL_ @@ -1837,7 +1837,7 @@ _SIGNATURE_MEMBER_PARTIAL_ #### Constructors -##### Constructor +##### new ClassB() _SIGNATURE_MEMBER_PARTIAL_ @@ -1888,7 +1888,7 @@ _SIGNATURE_MEMBER_PARTIAL_ `; exports[`Groups should compile module index with namespaces index page: (Output File Strategy "modules") (Option Group "2") 1`] = ` -"[**typedoc-stubs**](../index.md) • **Documentation** +"[**typedoc-stubs**](../index.md) *** @@ -1973,7 +1973,7 @@ _SIGNATURE_MEMBER_PARTIAL_ -#### Constructor +#### new \\_\\_Class\\_A\\_() _SIGNATURE_MEMBER_PARTIAL_ @@ -1987,7 +1987,7 @@ _SIGNATURE_MEMBER_PARTIAL_ -#### Constructor +#### new ClassB() _SIGNATURE_MEMBER_PARTIAL_ @@ -2038,7 +2038,7 @@ _DECLARATION_MEMBER_PARTIAL_ `; exports[`Groups should compile readme for a project: (Output File Strategy "modules") (Option Group "1") 1`] = ` -"**typedoc-stubs** • [**Documentation**](modules.md) +"**typedoc-stubs** *** @@ -2055,7 +2055,7 @@ Some text. `; exports[`Groups should compile references group page: (Output File Strategy "modules") (Option Group "1") 1`] = ` -"[**typedoc-stubs**](index.md) • **Documentation** +"[**typedoc-stubs**](index.md) *** @@ -2088,7 +2088,7 @@ Renames and re-exports [InterfaceB](basic.md#interfaceb) `; exports[`Groups should compile references group page: (Output File Strategy "modules") (Option Group "2") 1`] = ` -"[**typedoc-stubs**](index.md) • **Documentation** +"[**typedoc-stubs**](index.md) *** @@ -2127,7 +2127,7 @@ Renames and re-exports [InterfaceB](basic.md#interfaceb) `; exports[`Groups should compile references index page: (Output File Strategy "members") (Option Group "1") 1`] = ` -"[**typedoc-stubs**](../index.md) • **Documentation** +"[**typedoc-stubs**](../index.md) *** @@ -2166,7 +2166,7 @@ Renames and re-exports [InterfaceB](../basic/interfaces/InterfaceB.md) `; exports[`Groups should compile references index page: (Output File Strategy "members") (Option Group "2") 1`] = ` -"[**typedoc-stubs**](../index.md) • **Documentation** +"[**typedoc-stubs**](../index.md) *** diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/packages.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/packages.spec.ts.snap index aa17a118b..bda80c644 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/packages.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/packages.spec.ts.snap @@ -1,7 +1,7 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`Packages should compile index for a single package: (Output File Strategy "members") (Option Group "1") 1`] = ` -"**@scope/package-1 v1.0.0** • [**Documentation**](packages.md) +"**@scope/package-1 v1.0.0** *** @@ -12,7 +12,7 @@ Readme content `; exports[`Packages should compile index page for packages: (Output File Strategy "members") (Option Group "1") 1`] = ` -"[**packages-example**](index.md) • **Documentation** +"[**packages-example**](index.md) *** @@ -32,7 +32,7 @@ exports[`Packages should compile index page for packages: (Output File Strategy `; exports[`Packages should compile index page for packages: (Output File Strategy "members") (Option Group "1") 2`] = ` -"[**@scope/package-1 v1.0.0**](index.md) • **Documentation** +"[**@scope/package-1 v1.0.0**](index.md) *** @@ -51,7 +51,7 @@ Some more comments for package-1 `; exports[`Packages should compile index page for packages: (Output File Strategy "members") (Option Group "1") 3`] = ` -"[**package-2 v1.0.0**](index.md) • **Documentation** +"[**package-2 v1.0.0**](index.md) *** @@ -67,7 +67,7 @@ exports[`Packages should compile index page for packages: (Output File Strategy `; exports[`Packages should compile index page for packages: (Output File Strategy "members") (Option Group "1") 4`] = ` -"**@scope/package-3** • **Documentation** +"**@scope/package-3** *** @@ -88,7 +88,7 @@ exports[`Packages should compile index page for packages: (Output File Strategy `; exports[`Packages should compile member for relative entry module package: (Output File Strategy "members") (Option Group "1") 1`] = ` -"**package-6** • **Documentation** +"**package-6** *** @@ -99,11 +99,11 @@ exports[`Packages should compile member for relative entry module package: (Outp `; exports[`Packages should compile member page for a single package: (Output File Strategy "members") (Option Group "1") 1`] = ` -"[**@scope/package-1 v1.0.0**](../README.md) • **Documentation** +"[**@scope/package-1 v1.0.0**](../README.md) *** -[@scope/package-1 v1.0.0](../packages.md) / PackageInterface +[@scope/package-1](../packages.md) / PackageInterface # Interface: PackageInterface @@ -116,7 +116,7 @@ exports[`Packages should compile member page for a single package: (Output File `; exports[`Packages should compile member page for packages: (Output File Strategy "members") (Option Group "1") 1`] = ` -"[**@scope/package-1 v1.0.0**](../index.md) • **Documentation** +"[**@scope/package-1 v1.0.0**](../index.md) *** @@ -133,11 +133,11 @@ exports[`Packages should compile member page for packages: (Output File Strategy `; exports[`Packages should compile member page for packages: (Output File Strategy "members") (Option Group "2") 1`] = ` -"[**@scope/package-1 v1.0.0**](../README.md) • **Documentation** +"[**@scope/package-1 v1.0.0**](../README.md) *** -[packages-example v0.0](../../README.md) / [@scope/package-1](../README.md) / PackageInterface +[packages-example](../../README.md) / [@scope/package-1](../README.md) / PackageInterface # Interface: PackageInterface @@ -150,7 +150,7 @@ exports[`Packages should compile member page for packages: (Output File Strategy `; exports[`Packages should compile readmes for a packages: (Output File Strategy "members") (Option Group "1") 1`] = ` -"**packages-example** • [**Documentation**](packages.md) +"**packages-example** *** @@ -167,7 +167,7 @@ Some text. `; exports[`Packages should compile readmes for a packages: (Output File Strategy "members") (Option Group "1") 2`] = ` -"**@scope/package-1 v1.0.0** • [**Documentation**](globals.md) +"**@scope/package-1 v1.0.0** *** @@ -180,7 +180,7 @@ Readme content `; exports[`Packages should compile readmes for a packages: (Output File Strategy "members") (Option Group "2") 1`] = ` -"**packages-example v0.0** • **Documentation** +"**packages-example v0.0** *** @@ -210,7 +210,7 @@ Some text. `; exports[`Packages should compile relative entry module package: (Output File Strategy "members") (Option Group "1") 1`] = ` -"**package-6** • **Documentation** +"**package-6** *** diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/readme.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/readme.spec.ts.snap index 4fb7d31e7..7cb32a681 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/readme.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/readme.spec.ts.snap @@ -1,7 +1,7 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`Readmes should get merged readme for members: (Output File Strategy "members") (Option Group "1") 1`] = ` -"**typedoc-stubs v0.0** • **Documentation** +"**typedoc-stubs v0.0** *** @@ -15,7 +15,7 @@ Some text. Some text. -Module commments +Module comments for documentation. ## Functions @@ -24,7 +24,7 @@ Module commments `; exports[`Readmes should get merged readme for modules: (Output File Strategy "modules") (Option Group "1") 1`] = ` -"**typedoc-stubs v0.0** • **Documentation** +"**typedoc-stubs v0.0** *** @@ -38,7 +38,7 @@ Some text. Some text. -Module commments +Module comments for documentation. ## Functions diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap index 2546f9a5d..83427a6dc 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.class.spec.ts.snap @@ -10,7 +10,7 @@ exports[`Class Reflection should compile abstract class: (Output File Strategy " ## Constructors -### Constructor +### new AbstractClass() > **new AbstractClass**(): [\`AbstractClass\`](AbstractClass.md) @@ -58,7 +58,7 @@ exports[`Class Reflection should compile abstract class: (Output File Strategy " ## Constructors -### Constructor +### new AbstractClass() \`\`\`ts new AbstractClass(): AbstractClass @@ -101,7 +101,7 @@ Comments for BasicClass ## Constructors -### Constructor +### new BasicClass() > **new BasicClass**(): [\`BasicClass\`](BasicClass.md) @@ -146,7 +146,7 @@ Comments for BasicClass ## Constructors -### Constructor +### new BasicClass() \`\`\`ts new BasicClass(): BasicClass @@ -187,7 +187,7 @@ exports[`Class Reflection should compile class with accessor keywords: (Output F ## Constructors -### Constructor +### new ClassWithAccessorKeywords() > **new ClassWithAccessorKeywords**(): [\`ClassWithAccessorKeywords\`](ClassWithAccessorKeywords.md) @@ -244,7 +244,7 @@ Comments for ClassWithAccessors ## Constructors -### Constructor +### new ClassWithAccessors() > **new ClassWithAccessors**(): [\`ClassWithAccessors\`](ClassWithAccessors.md) @@ -345,7 +345,7 @@ Comments for ClassWithAccessors ## Constructors -### Constructor +### new ClassWithAccessors() \`\`\`ts new ClassWithAccessors(): ClassWithAccessors @@ -450,7 +450,7 @@ Comments for ClassWithComplexProps ## Constructors -### Constructor +### new ClassWithComplexProps() > **new ClassWithComplexProps**(): [\`ClassWithComplexProps\`](ClassWithComplexProps.md) @@ -499,7 +499,7 @@ Comments for ClassWithComplexProps ## Constructors -### Constructor +### new ClassWithComplexProps() \`\`\`ts new ClassWithComplexProps(): ClassWithComplexProps @@ -526,7 +526,7 @@ Comments for ClassWithConstructorOverloads ## Constructors -### Constructor +### new ClassWithConstructorOverloads() > **new ClassWithConstructorOverloads**(\`x\`, \`y\`): [\`ClassWithConstructorOverloads\`](ClassWithConstructorOverloads.md) @@ -550,7 +550,7 @@ Comments for x number [classes.ts:1](http://source-url) -### Constructor +### new ClassWithConstructorOverloads() > **new ClassWithConstructorOverloads**(\`x\`): [\`ClassWithConstructorOverloads\`](ClassWithConstructorOverloads.md) @@ -570,7 +570,7 @@ Comments for x string [classes.ts:1](http://source-url) -### Constructor +### new ClassWithConstructorOverloads() > **new ClassWithConstructorOverloads**(\`s\`): [\`ClassWithConstructorOverloads\`](ClassWithConstructorOverloads.md) @@ -597,7 +597,7 @@ Comments for ClassWithConstructorOverloads ## Constructors -### Constructor +### new ClassWithConstructorOverloads() \`\`\`ts new ClassWithConstructorOverloads(x: number, y: string): ClassWithConstructorOverloads @@ -618,7 +618,7 @@ new ClassWithConstructorOverloads(x: number, y: string): ClassWithConstructorOve [classes.ts:1](http://source-url) -### Constructor +### new ClassWithConstructorOverloads() \`\`\`ts new ClassWithConstructorOverloads(x: string): ClassWithConstructorOverloads @@ -638,7 +638,7 @@ new ClassWithConstructorOverloads(x: string): ClassWithConstructorOverloads [classes.ts:1](http://source-url) -### Constructor +### new ClassWithConstructorOverloads() \`\`\`ts new ClassWithConstructorOverloads(s: string): ClassWithConstructorOverloads @@ -667,7 +667,7 @@ Comment for ClassWithFlags ## Constructors -### Constructor +### new ClassWithFlags() > **new ClassWithFlags**(): [\`ClassWithFlags\`](ClassWithFlags.md) @@ -740,7 +740,7 @@ Comment for ClassWithFlags ## Constructors -### Constructor +### new ClassWithFlags() \`\`\`ts new ClassWithFlags(): ClassWithFlags @@ -802,7 +802,7 @@ Comments for ClassWithModifiers ## Constructors -### Constructor +### new ClassWithModifiers() > **new ClassWithModifiers**(): [\`ClassWithModifiers\`](ClassWithModifiers.md) @@ -927,7 +927,7 @@ Comments for ClassWithModifiers ## Constructors -### Constructor +### new ClassWithModifiers() \`\`\`ts new ClassWithModifiers(): ClassWithModifiers @@ -1008,7 +1008,7 @@ exports[`Class Reflection should compile class with prop categories: (Output Fil ## Constructors -### Constructor +### new ClassWithPropCategories() > **new ClassWithPropCategories**(\`opts\`): [\`ClassWithPropCategories\`](ClassWithPropCategories.md) @@ -1089,7 +1089,7 @@ Comments for ClassWithSimpleProps ## Constructors -### Constructor +### new ClassWithSimpleProps() > **new ClassWithSimpleProps**(): [\`ClassWithSimpleProps\`](ClassWithSimpleProps.md) @@ -1167,7 +1167,7 @@ Comments for ClassWithSimpleProps ## Constructors -### Constructor +### new ClassWithSimpleProps() \`\`\`ts new ClassWithSimpleProps(): ClassWithSimpleProps @@ -1193,7 +1193,7 @@ exports[`Class Reflection should compile class with symbols: (Output File Strate ## Constructors -### Constructor +### new ClassWithSymbols() > **new ClassWithSymbols**(): [\`ClassWithSymbols\`](ClassWithSymbols.md) @@ -1256,7 +1256,7 @@ Comments for param C ## Constructors -### Constructor +### new ClassWithTypeParameters() > **new ClassWithTypeParameters**\\<\`A\`, \`B\`, \`C\`\\>(): [\`ClassWithTypeParameters\`](ClassWithTypeParameters.md)\\<\`A\`, \`B\`, \`C\`\\> @@ -1281,7 +1281,7 @@ Comments for ClassWithTypeParameters ## Constructors -### Constructor +### new ClassWithTypeParameters() \`\`\`ts new ClassWithTypeParameters(): ClassWithTypeParameters @@ -1298,7 +1298,7 @@ exports[`Class Reflection should compile class without prop categories: (Output ## Constructors -### Constructor +### new ClassWithoutPropCategories() > **new ClassWithoutPropCategories**(\`opts\`): [\`ClassWithoutPropCategories\`](ClassWithoutPropCategories.md) @@ -1383,7 +1383,7 @@ Comments for DerivedClassA ## Constructors -### Constructor +### new DerivedClassA() > **new DerivedClassA**(): [\`DerivedClassA\`](DerivedClassA.md) @@ -1468,7 +1468,7 @@ Comments for DerivedClassA ## Constructors -### Constructor +### new DerivedClassA() \`\`\`ts new DerivedClassA(): DerivedClassA @@ -1538,7 +1538,7 @@ exports[`Class Reflection should compile disposable class: (Output File Strategy ## Constructors -### Constructor +### new DisposableClass() > **new DisposableClass**(): [\`DisposableClass\`](DisposableClass.md) @@ -1576,7 +1576,7 @@ exports[`Class Reflection should compile hierarchy for BaseClass: (Output File S ## Constructors -### Constructor +### new BaseClass() > **new BaseClass**(): [\`BaseClass\`](BaseClass.md) @@ -1600,7 +1600,7 @@ exports[`Class Reflection should compile hierarchy for ChildClassA: (Output File ## Constructors -### Constructor +### new ChildClassA() > **new ChildClassA**(): [\`ChildClassA\`](ChildClassA.md) @@ -1623,7 +1623,7 @@ exports[`Class Reflection should compile hierarchy for GrandChildClassA: (Output ## Constructors -### Constructor +### new GrandChildClassA() > **new GrandChildClassA**(): [\`GrandChildClassA\`](GrandChildClassA.md) diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/text.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/text.spec.ts.snap index 2e023f8fe..36232707e 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/text.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/text.spec.ts.snap @@ -1,13 +1,13 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`Text should get translations for index page: (Output File Strategy "members") (Option Group "1") 1`] = ` -"**My API - v0.0** • **API** +"**My API - v0.0** *** # :tada: Custom Index Title -## Modules +## モジュール - [module-1](module-1/README.md) - [module-2](module-2/README.md) @@ -19,41 +19,37 @@ Copyright Test `; exports[`Text should get translations for index page: (Output File Strategy "members") (Option Group "2") 1`] = ` -"**My API - v0.0 (jp)** • **Docs (jp)** +"**typedoc-stubs v0.0** *** -# typedoc-stubs v0.0 +# :tada typedoc-stubs and version 0.0 -## モジュール +## Modules - [module-1](module-1/README.md) - [module-2](module-2/README.md) - -*** - -Copyright Test (jp) " `; exports[`Text should get translations for member page: (Output File Strategy "members") (Option Group "1") 1`] = ` -"[**My API - v0.0**](../../README.md) • **API** +"[**My API - v0.0**](../../README.md) *** -[typedoc-stubs v0.0](../../README.md) / [module-1](../README.md) / SomeInterface +[typedoc-stubs](../../README.md) / [module-1](../README.md) / SomeInterface -# CoolInterfaces: SomeInterface +# SomeInterface -## Properties +## プロパティ -| Property | Type | Description | +| プロパティ | Type (jp) | 説明 | | :------ | :------ | :------ | | \`someProp?\` | \`boolean\` | Description for prop someProp | ## Events -| Event | Type | +| イベント | Type (jp) | | :------ | :------ | | \`someEvent\` | \`MouseEvent\` | @@ -64,44 +60,40 @@ Copyright Test `; exports[`Text should get translations for member page: (Output File Strategy "members") (Option Group "2") 1`] = ` -"[**My API - v0.0 (jp)**](../../README.md) • **Docs (jp)** +"[**typedoc-stubs v0.0**](../../README.md) *** -[typedoc-stubs v0.0](../../README.md) / [module-1](../README.md) / SomeInterface +[Home](../../README.md) / [module-1](../README.md) / SomeInterface -# インターフェイス: SomeInterface +# CoolInterfaces: Interface - SomeInterface -## プロパティ +## Properties -| プロパティ | Type (jp) | 説明 | +| Property | Type | Description | | :------ | :------ | :------ | | \`someProp?\` | \`boolean\` | Description for prop someProp | ## Events -| イベント | Type (jp) | +| Event | Type | | :------ | :------ | | \`someEvent\` | \`MouseEvent\` | - -*** - -Copyright Test (jp) " `; exports[`Text should get translations for module page: (Output File Strategy "members") (Option Group "1") 1`] = ` -"[**My API - v0.0**](../README.md) • **API** +"[**My API - v0.0**](../README.md) *** -[typedoc-stubs v0.0](../README.md) / module-1 +[typedoc-stubs](../README.md) / module-1 # module-1 -## TOC +## インデックス -### CoolInterfaces +### インターフェイス - [SomeInterface](interfaces/SomeInterface.md) @@ -112,15 +104,15 @@ Copyright Test `; exports[`Text should get translations for modules page: (Output File Strategy "modules") (Option Group "1") 1`] = ` -"[**My API - v0.0**](README.md) • **API** +"[**My API - v0.0**](README.md) *** -[typedoc-stubs v0.0](README.md) / module-2 +[typedoc-stubs](README.md) / module-2 # module-2 -## CoolVars +## 変数 ### constA @@ -140,7 +132,7 @@ exports[`Text should get translations for sidebar: (Output File Strategy "member "path": "module-1/README.md", "children": [ { - "title": "CoolInterfaces", + "title": "インターフェイス", "children": [ { "title": "SomeInterface", @@ -157,7 +149,7 @@ exports[`Text should get translations for sidebar: (Output File Strategy "member "path": "module-2/README.md", "children": [ { - "title": "CoolVars", + "title": "変数", "children": [ { "title": "constA", diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/utils.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/utils.spec.ts.snap index ae30741fd..0d25a06f9 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/utils.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/utils.spec.ts.snap @@ -11,7 +11,7 @@ exports[`Utils should get class with brackets: (Output File Strategy "members") ## Constructors -### Constructor +### new ClassWithChars() > **new ClassWithChars**<\`T\`>(): [\`ClassWithChars\`](ClassWithChars.md)<\`T\`> @@ -38,7 +38,7 @@ exports[`Utils should get class with brackets: (Output File Strategy "members") ## Constructors -### Constructor +### new ClassWithChars() \`\`\`ts new ClassWithChars(): ClassWithChars diff --git a/packages/typedoc-plugin-markdown/typedoc.public.json b/packages/typedoc-plugin-markdown/typedoc.public.json index d66b4e761..bf38270c0 100644 --- a/packages/typedoc-plugin-markdown/typedoc.public.json +++ b/packages/typedoc-plugin-markdown/typedoc.public.json @@ -39,8 +39,8 @@ "leftAlignHeaders": true }, "useCodeBlocks": false, - "textContentMappings": { - "title.memberPage": "{name}" + "pageTitleTemplates": { + "member": "{name}" }, "flattenOutputFiles": true, "navigation": { diff --git a/packages/typedoc-plugin-remark/test/out/globals-notoc/README.md b/packages/typedoc-plugin-remark/test/out/globals-notoc/README.md new file mode 100644 index 000000000..1afe779a3 --- /dev/null +++ b/packages/typedoc-plugin-remark/test/out/globals-notoc/README.md @@ -0,0 +1,47 @@ +# typedoc-plugin-remark + +## Variables + +### someVariable + +> `const` **someVariable**: `true` = `true` + +## Functions + +### some\_function() + +> **some\_function**(`param`): `void` + +#### Parameters + + + + + + + + + + + + + + + +
ParameterTypeDescription
+ +`param` + + + +`string` + + + +Default text content for `@category` tag. + +
+ +#### Returns + +`void` diff --git a/packages/typedoc-plugin-remark/test/out/globals/README.md b/packages/typedoc-plugin-remark/test/out/globals/README.md new file mode 100644 index 000000000..63db0d597 --- /dev/null +++ b/packages/typedoc-plugin-remark/test/out/globals/README.md @@ -0,0 +1,54 @@ +# typedoc-plugin-remark + +## CustomTOC + +* [Variables](#variables) + * [someVariable](#somevariable) +* [Functions](#functions) + * [some\_function()](#some_function) + +## Variables + +### someVariable + +> `const` **someVariable**: `true` = `true` + +## Functions + +### some\_function() + +> **some\_function**(`param`): `void` + +#### Parameters + + + + + + + + + + + + + + + +
ParameterTypeDescription
+ +`param` + + + +`string` + + + +Default text content for `@category` tag. + +
+ +#### Returns + +`void` diff --git a/packages/typedoc-plugin-remark/test/out/members/README.md b/packages/typedoc-plugin-remark/test/out/members/README.md new file mode 100644 index 000000000..b53e19f35 --- /dev/null +++ b/packages/typedoc-plugin-remark/test/out/members/README.md @@ -0,0 +1,6 @@ +# typedoc-plugin-remark + +## Modules + +* [module-1](module-1/README.md) +* [module-2](module-2/README.md) diff --git a/packages/typedoc-plugin-remark/test/out/members/module-1/README.md b/packages/typedoc-plugin-remark/test/out/members/module-1/README.md new file mode 100644 index 000000000..222d90223 --- /dev/null +++ b/packages/typedoc-plugin-remark/test/out/members/module-1/README.md @@ -0,0 +1,23 @@ +--- +title: "test" +--- + +# module-1 + +Comments form module comments + +Thanks [**@tgrey**](https://github.com/tgrey) please see issue [#1](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/1). + +## Index + +### Classes + +* [SomeClass](classes/SomeClass.md) + +### Interfaces + +* [SomeInterface](interfaces/SomeInterface.md) + +### Functions + +* [some\_function](functions/some_function.md) diff --git a/packages/typedoc-plugin-remark/test/out/members/module-1/classes/SomeClass.md b/packages/typedoc-plugin-remark/test/out/members/module-1/classes/SomeClass.md new file mode 100644 index 000000000..9ae973f80 --- /dev/null +++ b/packages/typedoc-plugin-remark/test/out/members/module-1/classes/SomeClass.md @@ -0,0 +1,49 @@ +--- +title: "test" +--- + +# Class: SomeClass\ + +* list item 1 + +## Contents + +* [Type Parameters](#type-parameters) +* [Constructors](#constructors) + * [new SomeClass()](#new-someclass) +* [Properties](#properties) + * [someProp](#someprop) + +## Type Parameters + + + + + + + + + + + +
Type Parameter
+ +`T` + +
+ +## Constructors + +### new SomeClass() + +> **new SomeClass**\<`T`>(): [`SomeClass`](SomeClass.md)\<`T`> + +#### Returns + +[`SomeClass`](SomeClass.md)\<`T`> + +## Properties + +### someProp + +> **someProp**: `string` diff --git a/packages/typedoc-plugin-remark/test/out/members/module-1/functions/some_function.md b/packages/typedoc-plugin-remark/test/out/members/module-1/functions/some_function.md new file mode 100644 index 000000000..7d84d1972 --- /dev/null +++ b/packages/typedoc-plugin-remark/test/out/members/module-1/functions/some_function.md @@ -0,0 +1,35 @@ +--- +title: "test" +--- + +# Function: some\_function() + +> **some\_function**(`param`): `void` + +## Parameters + + + + + + + + + + + + + +
ParameterType
+ +`param` + + + +`string` | `boolean` + +
+ +## Returns + +`void` diff --git a/packages/typedoc-plugin-remark/test/out/members/module-1/interfaces/SomeInterface.md b/packages/typedoc-plugin-remark/test/out/members/module-1/interfaces/SomeInterface.md new file mode 100644 index 000000000..f1aedec98 --- /dev/null +++ b/packages/typedoc-plugin-remark/test/out/members/module-1/interfaces/SomeInterface.md @@ -0,0 +1,49 @@ +--- +title: "test" +--- + +# Interface: SomeInterface\ + +## Contents + +* [Type Parameters](#type-parameters) +* [Properties](#properties) + * [anotherProp](#anotherprop) + * [somePromise](#somepromise) + * [someProp](#someprop) + +## Type Parameters + + + + + + + + + + + +
Type Parameter
+ +`T` + +
+ +## Properties + +### anotherProp + +> **anotherProp**: `T` + +*** + +### somePromise + +> **somePromise**: `Promise`\<`T`> + +*** + +### someProp + +> **someProp**: `string` diff --git a/packages/typedoc-plugin-remark/test/out/members/module-2/README.md b/packages/typedoc-plugin-remark/test/out/members/module-2/README.md new file mode 100644 index 000000000..b7ba5add4 --- /dev/null +++ b/packages/typedoc-plugin-remark/test/out/members/module-2/README.md @@ -0,0 +1,15 @@ +--- +title: "test" +--- + +# module-2 + +## Index + +### Variables + +* [someVariable](variables/someVariable.md) + +### Functions + +* [some\_function](functions/some_function.md) diff --git a/packages/typedoc-plugin-remark/test/out/members/module-2/functions/some_function.md b/packages/typedoc-plugin-remark/test/out/members/module-2/functions/some_function.md new file mode 100644 index 000000000..c9e88d884 --- /dev/null +++ b/packages/typedoc-plugin-remark/test/out/members/module-2/functions/some_function.md @@ -0,0 +1,41 @@ +--- +title: "test" +--- + +# Function: some\_function() + +> **some\_function**(`param`): `void` + +## Parameters + + + + + + + + + + + + + + + +
ParameterTypeDescription
+ +`param` + + + +`string` + + + +Default text content for `@category` tag. + +
+ +## Returns + +`void` diff --git a/packages/typedoc-plugin-remark/test/out/members/module-2/variables/someVariable.md b/packages/typedoc-plugin-remark/test/out/members/module-2/variables/someVariable.md new file mode 100644 index 000000000..bd0c2c3e0 --- /dev/null +++ b/packages/typedoc-plugin-remark/test/out/members/module-2/variables/someVariable.md @@ -0,0 +1,7 @@ +--- +title: "test" +--- + +# Variable: someVariable + +> `const` **someVariable**: `true` = `true` diff --git a/packages/typedoc-plugin-remark/test/out/modules/README.md b/packages/typedoc-plugin-remark/test/out/modules/README.md new file mode 100644 index 000000000..b04abe931 --- /dev/null +++ b/packages/typedoc-plugin-remark/test/out/modules/README.md @@ -0,0 +1,6 @@ +# typedoc-plugin-remark + +## Modules + ++ [module-1](module-1.md) ++ [module-2](module-2.md) diff --git a/packages/typedoc-plugin-remark/test/out/modules/module-1.md b/packages/typedoc-plugin-remark/test/out/modules/module-1.md new file mode 100644 index 000000000..76c82d537 --- /dev/null +++ b/packages/typedoc-plugin-remark/test/out/modules/module-1.md @@ -0,0 +1,128 @@ +--- +title: "test" +--- + +# module-1 + +Comments form module comments + +Thanks [**@tgrey**](https://github.com/tgrey) please see issue [#1](https://github.com/typedoc2md/typedoc-plugin-markdown/issues/1). + +## Contents + ++ [Classes](#classes) + + [SomeClass\](#someclasst) ++ [Interfaces](#interfaces) + + [SomeInterface\](#someinterfacet) ++ [Functions](#functions) + + [some\_function()](#some_function) + +## Classes + +### SomeClass\ + ++ list item 1 + +#### Type Parameters + + + + + + + + + + + +
Type Parameter
+ +`T` + +
+ +#### Constructors + +##### new SomeClass() + +> **new SomeClass**\<`T`>(): [`SomeClass`](module-1.md#someclasst)\<`T`> + +###### Returns + +[`SomeClass`](module-1.md#someclasst)\<`T`> + +#### Properties + +##### someProp + +> **someProp**: `string` + +## Interfaces + +### SomeInterface\ + +#### Type Parameters + + + + + + + + + + + +
Type Parameter
+ +`T` + +
+ +#### Properties + +##### anotherProp + +> **anotherProp**: `T` + +##### somePromise + +> **somePromise**: `Promise`\<`T`> + +##### someProp + +> **someProp**: `string` + +## Functions + +### some\_function() + +> **some\_function**(`param`): `void` + +#### Parameters + + + + + + + + + + + + + +
ParameterType
+ +`param` + + + +`string` | `boolean` + +
+ +#### Returns + +`void` diff --git a/packages/typedoc-plugin-remark/test/out/modules/module-2.md b/packages/typedoc-plugin-remark/test/out/modules/module-2.md new file mode 100644 index 000000000..8c79c00b2 --- /dev/null +++ b/packages/typedoc-plugin-remark/test/out/modules/module-2.md @@ -0,0 +1,58 @@ +--- +title: "test" +--- + +# module-2 + +## Contents + ++ [Variables](#variables) + + [someVariable](#somevariable) ++ [Functions](#functions) + + [some\_function()](#some_function) + +## Variables + +### someVariable + +> `const` **someVariable**: `true` = `true` + +## Functions + +### some\_function() + +> **some\_function**(`param`): `void` + +#### Parameters + + + + + + + + + + + + + + + +
ParameterTypeDescription
+ +`param` + + + +`string` + + + +Default text content for `@category` tag. + +
+ +#### Returns + +`void` diff --git a/packages/typedoc-plugin-remark/test/specs/__snapshots__/remark.spec.ts.snap b/packages/typedoc-plugin-remark/test/specs/__snapshots__/remark.spec.ts.snap index eaa5873ff..d8f0ba006 100644 --- a/packages/typedoc-plugin-remark/test/specs/__snapshots__/remark.spec.ts.snap +++ b/packages/typedoc-plugin-remark/test/specs/__snapshots__/remark.spec.ts.snap @@ -122,7 +122,7 @@ title: "test" * [Type Parameters](#type-parameters) * [Constructors](#constructors) - * [Constructor](#constructor) + * [new SomeClass()](#new-someclass) * [Properties](#properties) * [someProp](#someprop) @@ -146,7 +146,7 @@ title: "test" ## Constructors -### Constructor +### new SomeClass() > **new SomeClass**\\<\`T\`>(): [\`SomeClass\`](SomeClass.md)\\<\`T\`> @@ -255,7 +255,7 @@ Thanks [**@tgrey**](https://github.com/tgrey) please see issue [#1](https://gith #### Constructors -##### Constructor +##### new SomeClass() > **new SomeClass**\\<\`T\`>(): [\`SomeClass\`](module-1.md#someclasst)\\<\`T\`> diff --git a/packages/typedoc-vitepress-theme/test/out/default/index.md b/packages/typedoc-vitepress-theme/test/out/default/index.md new file mode 100644 index 000000000..e43cbcfb3 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/default/index.md @@ -0,0 +1,6 @@ +# typedoc-vitepress-theme + +## Modules + +- [module-1](module-1/index.md) +- [module-2](module-2/index.md) diff --git a/packages/typedoc-vitepress-theme/test/out/default/module-1/classes/ClassA.md b/packages/typedoc-vitepress-theme/test/out/default/module-1/classes/ClassA.md new file mode 100644 index 000000000..b05380e0c --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/default/module-1/classes/ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-vitepress-theme/test/out/default/module-1/classes/ClassB.md b/packages/typedoc-vitepress-theme/test/out/default/module-1/classes/ClassB.md new file mode 100644 index 000000000..de4b002bc --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/default/module-1/classes/ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-vitepress-theme/test/out/default/module-1/index.md b/packages/typedoc-vitepress-theme/test/out/default/module-1/index.md new file mode 100644 index 000000000..f4f4ee1e7 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/default/module-1/index.md @@ -0,0 +1,13 @@ +# module-1 + +## Index + +### Classes + +- [ClassA](classes/ClassA.md) +- [ClassB](classes/ClassB.md) + +### Interfaces + +- [InterfaceA](interfaces/InterfaceA.md) +- [InterfaceB](interfaces/InterfaceB.md) diff --git a/packages/typedoc-vitepress-theme/test/out/default/module-1/interfaces/InterfaceA.md b/packages/typedoc-vitepress-theme/test/out/default/module-1/interfaces/InterfaceA.md new file mode 100644 index 000000000..c007ff56b --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/default/module-1/interfaces/InterfaceA.md @@ -0,0 +1,3 @@ +# Interface: InterfaceA + +See [InterfaceB._prop_with_underscore_](InterfaceB.md#prop-with-underscore) diff --git a/packages/typedoc-vitepress-theme/test/out/default/module-1/interfaces/InterfaceB.md b/packages/typedoc-vitepress-theme/test/out/default/module-1/interfaces/InterfaceB.md new file mode 100644 index 000000000..87cd09cc0 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/default/module-1/interfaces/InterfaceB.md @@ -0,0 +1,7 @@ +# Interface: InterfaceB + +## Properties + +### \_prop\_with\_underscore\_ + +> **\_prop\_with\_underscore\_**: `string` diff --git a/packages/typedoc-vitepress-theme/test/out/default/module-2/classes/ClassA.md b/packages/typedoc-vitepress-theme/test/out/default/module-2/classes/ClassA.md new file mode 100644 index 000000000..b05380e0c --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/default/module-2/classes/ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-vitepress-theme/test/out/default/module-2/classes/ClassB.md b/packages/typedoc-vitepress-theme/test/out/default/module-2/classes/ClassB.md new file mode 100644 index 000000000..de4b002bc --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/default/module-2/classes/ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-vitepress-theme/test/out/default/module-2/index.md b/packages/typedoc-vitepress-theme/test/out/default/module-2/index.md new file mode 100644 index 000000000..1946a6c66 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/default/module-2/index.md @@ -0,0 +1,13 @@ +# module-2 + +## Index + +### Classes + +- [ClassA](classes/ClassA.md) +- [ClassB](classes/ClassB.md) + +### Interfaces + +- [InterfaceA](interfaces/InterfaceA.md) +- [InterfaceB](interfaces/InterfaceB.md) diff --git a/packages/typedoc-vitepress-theme/test/out/default/module-2/interfaces/InterfaceA.md b/packages/typedoc-vitepress-theme/test/out/default/module-2/interfaces/InterfaceA.md new file mode 100644 index 000000000..05ebc7537 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/default/module-2/interfaces/InterfaceA.md @@ -0,0 +1 @@ +# Interface: InterfaceA diff --git a/packages/typedoc-vitepress-theme/test/out/default/module-2/interfaces/InterfaceB.md b/packages/typedoc-vitepress-theme/test/out/default/module-2/interfaces/InterfaceB.md new file mode 100644 index 000000000..635164782 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/default/module-2/interfaces/InterfaceB.md @@ -0,0 +1 @@ +# Interface: InterfaceB diff --git a/packages/typedoc-vitepress-theme/test/out/default/typedoc-sidebar.json b/packages/typedoc-vitepress-theme/test/out/default/typedoc-sidebar.json new file mode 100644 index 000000000..08fc67ad2 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/default/typedoc-sidebar.json @@ -0,0 +1 @@ +[{"text":"module-1","link":"/test/out/default/module-1/","collapsed":true,"items":[{"text":"Classes","collapsed":true,"items":[{"text":"ClassA","link":"/test/out/default/module-1/classes/ClassA.md"},{"text":"ClassB","link":"/test/out/default/module-1/classes/ClassB.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"InterfaceA","link":"/test/out/default/module-1/interfaces/InterfaceA.md"},{"text":"InterfaceB","link":"/test/out/default/module-1/interfaces/InterfaceB.md"}]}]},{"text":"module-2","link":"/test/out/default/module-2/","collapsed":true,"items":[{"text":"Classes","collapsed":true,"items":[{"text":"ClassA","link":"/test/out/default/module-2/classes/ClassA.md"},{"text":"ClassB","link":"/test/out/default/module-2/classes/ClassB.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"InterfaceA","link":"/test/out/default/module-2/interfaces/InterfaceA.md"},{"text":"InterfaceB","link":"/test/out/default/module-2/interfaces/InterfaceB.md"}]}]}] \ No newline at end of file diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/index.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/index.md new file mode 100644 index 000000000..e43cbcfb3 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/index.md @@ -0,0 +1,6 @@ +# typedoc-vitepress-theme + +## Modules + +- [module-1](module-1/index.md) +- [module-2](module-2/index.md) diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/classes/ClassA.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/classes/ClassA.md new file mode 100644 index 000000000..b05380e0c --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/classes/ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/classes/ClassB.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/classes/ClassB.md new file mode 100644 index 000000000..de4b002bc --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/classes/ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/index.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/index.md new file mode 100644 index 000000000..f4f4ee1e7 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/index.md @@ -0,0 +1,13 @@ +# module-1 + +## Index + +### Classes + +- [ClassA](classes/ClassA.md) +- [ClassB](classes/ClassB.md) + +### Interfaces + +- [InterfaceA](interfaces/InterfaceA.md) +- [InterfaceB](interfaces/InterfaceB.md) diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/interfaces/InterfaceA.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/interfaces/InterfaceA.md new file mode 100644 index 000000000..c007ff56b --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/interfaces/InterfaceA.md @@ -0,0 +1,3 @@ +# Interface: InterfaceA + +See [InterfaceB._prop_with_underscore_](InterfaceB.md#prop-with-underscore) diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/interfaces/InterfaceB.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/interfaces/InterfaceB.md new file mode 100644 index 000000000..87cd09cc0 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-1/interfaces/InterfaceB.md @@ -0,0 +1,7 @@ +# Interface: InterfaceB + +## Properties + +### \_prop\_with\_underscore\_ + +> **\_prop\_with\_underscore\_**: `string` diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/classes/ClassA.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/classes/ClassA.md new file mode 100644 index 000000000..b05380e0c --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/classes/ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/classes/ClassB.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/classes/ClassB.md new file mode 100644 index 000000000..de4b002bc --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/classes/ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/index.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/index.md new file mode 100644 index 000000000..1946a6c66 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/index.md @@ -0,0 +1,13 @@ +# module-2 + +## Index + +### Classes + +- [ClassA](classes/ClassA.md) +- [ClassB](classes/ClassB.md) + +### Interfaces + +- [InterfaceA](interfaces/InterfaceA.md) +- [InterfaceB](interfaces/InterfaceB.md) diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/interfaces/InterfaceA.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/interfaces/InterfaceA.md new file mode 100644 index 000000000..05ebc7537 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/interfaces/InterfaceA.md @@ -0,0 +1 @@ +# Interface: InterfaceA diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/interfaces/InterfaceB.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/interfaces/InterfaceB.md new file mode 100644 index 000000000..635164782 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/module-2/interfaces/InterfaceB.md @@ -0,0 +1 @@ +# Interface: InterfaceB diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/typedoc-sidebar.json b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/typedoc-sidebar.json new file mode 100644 index 000000000..18b874b7d --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options-2/typedoc-sidebar.json @@ -0,0 +1 @@ +[{"text":"module-1","link":"/module-1/","collapsed":true,"items":[{"text":"Classes","collapsed":true,"items":[{"text":"ClassA","link":"/module-1/classes/ClassA.md"},{"text":"ClassB","link":"/module-1/classes/ClassB.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"InterfaceA","link":"/module-1/interfaces/InterfaceA.md"},{"text":"InterfaceB","link":"/module-1/interfaces/InterfaceB.md"}]}]},{"text":"module-2","link":"/module-2/","collapsed":true,"items":[{"text":"Classes","collapsed":true,"items":[{"text":"ClassA","link":"/module-2/classes/ClassA.md"},{"text":"ClassB","link":"/module-2/classes/ClassB.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"InterfaceA","link":"/module-2/interfaces/InterfaceA.md"},{"text":"InterfaceB","link":"/module-2/interfaces/InterfaceB.md"}]}]}] \ No newline at end of file diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options/index.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options/index.md new file mode 100644 index 000000000..e43cbcfb3 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options/index.md @@ -0,0 +1,6 @@ +# typedoc-vitepress-theme + +## Modules + +- [module-1](module-1/index.md) +- [module-2](module-2/index.md) diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/classes/ClassA.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/classes/ClassA.md new file mode 100644 index 000000000..b05380e0c --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/classes/ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/classes/ClassB.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/classes/ClassB.md new file mode 100644 index 000000000..de4b002bc --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/classes/ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/index.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/index.md new file mode 100644 index 000000000..f4f4ee1e7 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/index.md @@ -0,0 +1,13 @@ +# module-1 + +## Index + +### Classes + +- [ClassA](classes/ClassA.md) +- [ClassB](classes/ClassB.md) + +### Interfaces + +- [InterfaceA](interfaces/InterfaceA.md) +- [InterfaceB](interfaces/InterfaceB.md) diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/interfaces/InterfaceA.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/interfaces/InterfaceA.md new file mode 100644 index 000000000..c007ff56b --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/interfaces/InterfaceA.md @@ -0,0 +1,3 @@ +# Interface: InterfaceA + +See [InterfaceB._prop_with_underscore_](InterfaceB.md#prop-with-underscore) diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/interfaces/InterfaceB.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/interfaces/InterfaceB.md new file mode 100644 index 000000000..87cd09cc0 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-1/interfaces/InterfaceB.md @@ -0,0 +1,7 @@ +# Interface: InterfaceB + +## Properties + +### \_prop\_with\_underscore\_ + +> **\_prop\_with\_underscore\_**: `string` diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/classes/ClassA.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/classes/ClassA.md new file mode 100644 index 000000000..b05380e0c --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/classes/ClassA.md @@ -0,0 +1,11 @@ +# Class: ClassA + +## Constructors + +### new ClassA() + +> **new ClassA**(): [`ClassA`](ClassA.md) + +#### Returns + +[`ClassA`](ClassA.md) diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/classes/ClassB.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/classes/ClassB.md new file mode 100644 index 000000000..de4b002bc --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/classes/ClassB.md @@ -0,0 +1,11 @@ +# Class: ClassB + +## Constructors + +### new ClassB() + +> **new ClassB**(): [`ClassB`](ClassB.md) + +#### Returns + +[`ClassB`](ClassB.md) diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/index.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/index.md new file mode 100644 index 000000000..1946a6c66 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/index.md @@ -0,0 +1,13 @@ +# module-2 + +## Index + +### Classes + +- [ClassA](classes/ClassA.md) +- [ClassB](classes/ClassB.md) + +### Interfaces + +- [InterfaceA](interfaces/InterfaceA.md) +- [InterfaceB](interfaces/InterfaceB.md) diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/interfaces/InterfaceA.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/interfaces/InterfaceA.md new file mode 100644 index 000000000..05ebc7537 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/interfaces/InterfaceA.md @@ -0,0 +1 @@ +# Interface: InterfaceA diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/interfaces/InterfaceB.md b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/interfaces/InterfaceB.md new file mode 100644 index 000000000..635164782 --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options/module-2/interfaces/InterfaceB.md @@ -0,0 +1 @@ +# Interface: InterfaceB diff --git a/packages/typedoc-vitepress-theme/test/out/sidebar-options/typedoc-sidebar.json b/packages/typedoc-vitepress-theme/test/out/sidebar-options/typedoc-sidebar.json new file mode 100644 index 000000000..09c4a11be --- /dev/null +++ b/packages/typedoc-vitepress-theme/test/out/sidebar-options/typedoc-sidebar.json @@ -0,0 +1,72 @@ +[ + { + "text": "module-1", + "link": "/sidebar-options/module-1/", + "collapsed": false, + "items": [ + { + "text": "Classes", + "collapsed": false, + "items": [ + { + "text": "ClassA", + "link": "/sidebar-options/module-1/classes/ClassA.md" + }, + { + "text": "ClassB", + "link": "/sidebar-options/module-1/classes/ClassB.md" + } + ] + }, + { + "text": "Interfaces", + "collapsed": false, + "items": [ + { + "text": "InterfaceA", + "link": "/sidebar-options/module-1/interfaces/InterfaceA.md" + }, + { + "text": "InterfaceB", + "link": "/sidebar-options/module-1/interfaces/InterfaceB.md" + } + ] + } + ] + }, + { + "text": "module-2", + "link": "/sidebar-options/module-2/", + "collapsed": false, + "items": [ + { + "text": "Classes", + "collapsed": false, + "items": [ + { + "text": "ClassA", + "link": "/sidebar-options/module-2/classes/ClassA.md" + }, + { + "text": "ClassB", + "link": "/sidebar-options/module-2/classes/ClassB.md" + } + ] + }, + { + "text": "Interfaces", + "collapsed": false, + "items": [ + { + "text": "InterfaceA", + "link": "/sidebar-options/module-2/interfaces/InterfaceA.md" + }, + { + "text": "InterfaceB", + "link": "/sidebar-options/module-2/interfaces/InterfaceB.md" + } + ] + } + ] + } +] \ No newline at end of file diff --git a/typedoc.json b/typedoc.json index e35f57284..9d92c2464 100644 --- a/typedoc.json +++ b/typedoc.json @@ -15,9 +15,9 @@ ], "plugin": [ - "./packages/typedoc-plugin-markdown/dist", - "./packages/typedoc-plugin-remark/dist", - "./devtools/typedoc-plugins/typedoc-default-values.js", + "./packages/typedoc-plugin-markdown/dist/index.js", + "./packages/typedoc-plugin-remark/dist/index.js", + "./devtools/typedoc-plugins/typedoc-default-values.mjs", "./devtools/typedoc-plugins/typedoc-symbols.mjs" ], "entryPointStrategy": "packages", @@ -39,8 +39,8 @@ "membersWithOwnFile": ["Class", "Interface", "TypeAlias", "Enum"], "hidePageHeader": true, "hideGroupHeadings": true, - "textContentMappings": { - "breadcrumbs.home": "Home" + "pageTitleTemplates": { + "index": "API Index" }, "expandObjects": false, "useCodeBlocks": false, @@ -56,7 +56,7 @@ { "tight": true, "maxDepth": 4, - "skip": "Default Value|Defined in|Example|Overrides|Parameters|Returns|See|Type declaration|Inherited from|Deprecated" + "skip": "Default Value|Defined in|Example|Overrides|Parameters|Returns|See|Type declaration|Inherited from|Deprecated|Packages|Modules" } ] ]