From fbfd19bfacf0cb0ba242e2300ece0a2a69ebd135 Mon Sep 17 00:00:00 2001 From: tgreyuk Date: Wed, 27 Nov 2024 11:57:17 +0000 Subject: [PATCH] chore(all): final output tweaks --- .../links/interfaces/CommentInterface.md | 4 +- .../test/out/links/index.md | 4 +- .../__snapshots__/docusaurus.spec.ts.snap | 4 +- .../context/partials/member.declaration.ts | 6 +- .../partials/member.memberWithGroups.ts | 6 +- .../context/partials/member.signature.ts | 6 +- .../partials/member.typeParametersList.ts | 17 ++-- .../src/theme/context/resources.ts | 6 +- .../opts-1/classes/CallbacksOptions.md | 8 +- .../opts-1/classes/ClassWithTypeParameters.md | 12 +-- .../opts-1/functions/curriedFunction.md | 8 +- .../functions/functionReturningAFunction.md | 4 +- .../functions/functionWithTypeParameters.md | 6 +- .../opts-1/interfaces/CustomEventInterface.md | 4 +- .../interfaces/InterfaceWithComments.md | 8 +- .../interfaces/InterfaceWithTypeParameters.md | 4 +- .../opts-1/type-aliases/ConditionalType.md | 4 +- .../opts-1/type-aliases/PartialMappedType.md | 4 +- .../opts-1/type-aliases/ReadonlyMappedType.md | 4 +- .../TypeDeclarationWithSpecialCharacters.md | 8 +- .../opts-1/type-aliases/TypeWithTypeParams.md | 8 +- .../opts-1/classes/CallbacksOptions.md | 8 +- .../opts-1/classes/ClassWithTypeParameters.md | 12 +-- .../opts-1/functions/curriedFunction.md | 8 +- .../functions/functionReturningAFunction.md | 4 +- .../functions/functionWithTypeParameters.md | 6 +- .../opts-1/interfaces/CustomEventInterface.md | 4 +- .../interfaces/InterfaceWithComments.md | 8 +- .../interfaces/InterfaceWithTypeParameters.md | 4 +- .../opts-1/type-aliases/ConditionalType.md | 4 +- .../opts-1/type-aliases/PartialMappedType.md | 4 +- .../opts-1/type-aliases/ReadonlyMappedType.md | 4 +- .../TypeDeclarationWithSpecialCharacters.md | 8 +- .../opts-1/type-aliases/TypeWithTypeParams.md | 8 +- .../out/reflections/modules/opts-1/globals.md | 82 ++++++------------- .../reflection.class.spec.ts.snap | 12 +-- .../reflection.function.spec.ts.snap | 18 ++-- .../reflection.interface.spec.ts.snap | 12 ++- .../reflection.type-alias.spec.ts.snap | 20 ++--- 39 files changed, 100 insertions(+), 261 deletions(-) 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 index 3a97e5b5e..d4b444504 100644 --- a/packages/docusaurus-plugin-typedoc/test/out/default/links/interfaces/CommentInterface.md +++ b/packages/docusaurus-plugin-typedoc/test/out/default/links/interfaces/CommentInterface.md @@ -14,9 +14,7 @@ Links using `{@link}` inline tags. ## Type Parameters -### T - -\- +• **T** ## Properties diff --git a/packages/docusaurus-plugin-typedoc/test/out/links/index.md b/packages/docusaurus-plugin-typedoc/test/out/links/index.md index 954bfafb7..22a54a2ad 100644 --- a/packages/docusaurus-plugin-typedoc/test/out/links/index.md +++ b/packages/docusaurus-plugin-typedoc/test/out/links/index.md @@ -32,9 +32,7 @@ Links using `{@link}` inline tags. #### Type Parameters -##### T - -\- +• **T** #### Properties 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 16167ce7f..f5ceef5d9 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,9 +68,7 @@ Links using \`{@link}\` inline tags. #### Type Parameters -##### T - -\\- +• **T** #### Properties diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts index 58e2ff3eb..f1c080913 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts @@ -102,11 +102,7 @@ export function declaration( if (this.helpers.useTableFormat('parameters')) { md.push(this.partials.typeParametersTable(model.typeParameters)); } else { - md.push( - this.partials.typeParametersList(model.typeParameters, { - headingLevel: options.headingLevel, - }), - ); + md.push(this.partials.typeParametersList(model.typeParameters)); } } diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts index 9c4fb70c7..e75fccef9 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberWithGroups.ts @@ -40,11 +40,7 @@ export function memberWithGroups( if (this.helpers.useTableFormat('parameters')) { md.push(this.partials.typeParametersTable(model.typeParameters)); } else { - md.push( - this.partials.typeParametersList(model.typeParameters, { - headingLevel: options.headingLevel, - }), - ); + md.push(this.partials.typeParametersList(model.typeParameters)); } } diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts index 070838542..73a3a7258 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts @@ -76,11 +76,7 @@ export function signature( if (this.helpers.useTableFormat('parameters')) { md.push(this.partials.typeParametersTable(model.typeParameters)); } else { - md.push( - this.partials.typeParametersList(model.typeParameters, { - headingLevel: options.headingLevel, - }), - ); + md.push(this.partials.typeParametersList(model.typeParameters)); } } diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersList.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersList.ts index 0d34aaeda..cea5f90a5 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersList.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeParametersList.ts @@ -1,40 +1,33 @@ -import { heading, italic } from '@plugin/libs/markdown/index.js'; +import { bold, italic } from '@plugin/libs/markdown/index.js'; import { MarkdownThemeContext } from '@plugin/theme/index.js'; import { TypeParameterReflection } from 'typedoc'; export function typeParametersList( this: MarkdownThemeContext, model: TypeParameterReflection[], - options: { headingLevel: number }, ): string { const rows: string[] = []; model?.forEach((typeParameter) => { const row: string[] = []; - row.push(heading(options.headingLevel + 1, typeParameter.name)); - - const nameCol: string[] = []; + const nameCol: string[] = [bold(typeParameter.name)]; if (typeParameter.type) { nameCol.push( - `${italic('extends')}: ${this.partials.someType(typeParameter.type)}`, + `${italic('extends')} ${this.partials.someType(typeParameter.type)}`, ); } if (typeParameter.default) { nameCol.push( - `${this.i18n.theme_default_type()} ${this.partials.someType(typeParameter.default)}`, + `= ${this.partials.someType(typeParameter.default, { forceCollapse: true })}`, ); } - row.push(nameCol.join('')); + row.push('• ' + nameCol.join(' ')); if (typeParameter.comment) { row.push(this.partials.comment(typeParameter.comment)); - } else { - if (nameCol.join('').length === 0) { - row.push('\\-'); - } } rows.push(row.join('\n\n')); diff --git a/packages/typedoc-plugin-markdown/src/theme/context/resources.ts b/packages/typedoc-plugin-markdown/src/theme/context/resources.ts index 38c743104..ca920d798 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/resources.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/resources.ts @@ -228,10 +228,8 @@ There is no association list partial for properties as these are handled as a st options: { kind?: ReflectionKind | undefined }, ) => partials.typeDeclarationTable.apply(context, [model, options]) as string, - typeParametersList: ( - model: TypeParameterReflection[], - options: { headingLevel: number }, - ) => partials.typeParametersList.apply(context, [model, options]) as string, + typeParametersList: (model: TypeParameterReflection[]) => + partials.typeParametersList.apply(context, [model]) as string, typeParametersTable: (model: TypeParameterReflection[]) => partials.typeParametersTable.apply(context, [model]) as string, breadcrumbs: () => partials.breadcrumbs.apply(context, []) as 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 index 7d06c159b..91615c21e 100644 --- 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 @@ -2,13 +2,9 @@ ## Type Parameters -### P +• **P** = [`DisposableClass`](DisposableClass.md) -Default type [`DisposableClass`](DisposableClass.md) - -### A - -Default type [`ClassWithModifiers`](ClassWithModifiers.md) +• **A** = [`ClassWithModifiers`](ClassWithModifiers.md) ## Constructors 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 index 8bdb78021..3bad02f11 100644 --- 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 @@ -4,19 +4,13 @@ Comments for ClassWithTypeParameters ## Type Parameters -### A +• **A** -\- - -### B - -*extends*: `string` +• **B** *extends* `string` Comments for param B -### C - -Default type `boolean` +• **C** = `boolean` Comments for param C 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 index 3bfb80dac..c33874636 100644 --- 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 @@ -20,9 +20,7 @@ Comments for current function 1 #### Type Parameters -##### Value - -\- +• **Value** #### Parameters @@ -42,9 +40,7 @@ Comments for iterable arg ### Type Parameters -#### Value - -\- +• **Value** ### Parameters 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 index b36a8790f..b4599923c 100644 --- 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 @@ -10,9 +10,7 @@ Comments for function ### Type Parameters -#### T - -\- +• **T** ### Parameters 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 index c75e4fd85..f9199b996 100644 --- 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 @@ -6,13 +6,11 @@ Function with type parameters ## Type Parameters -### T +• **T** Comments for T -### Item - -Default type `string` \| `boolean` +• **Item** = `string` \| `boolean` ## Returns 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 index 4c6b1b6e0..aa8ac250b 100644 --- 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 @@ -2,9 +2,7 @@ ## Type Parameters -### T - -\- +• **T** ## Properties 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 index 991f0d6b5..5ea373f10 100644 --- 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 @@ -7,22 +7,22 @@ And some more comments ## Type Parameters -### A +• **A** This is a parameter. -### B +• **B** Comments for a parameter. This sentence is on a soft new line. -### C +• **C** This is a parameter. Documentation with a double line -### D +• **D**

These are comments with paras

These are comments with paras

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 index 85ad2de41..54e06d152 100644 --- 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 @@ -4,9 +4,7 @@ Comments for InterfaceWithTypeParameters ## Type Parameters -### A - -\- +• **A** ## Properties 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 index 98f8b1e94..5aa0db195 100644 --- 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 @@ -6,6 +6,4 @@ Comments for ConditionalType ## Type Parameters -### T - -\- +• **T** 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 index 996aaeccc..b274c8a33 100644 --- 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 @@ -6,6 +6,4 @@ Comments for PartialMappedType ## Type Parameters -### T - -\- +• **T** 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 index ed884b43e..342aa0d0d 100644 --- 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 @@ -6,6 +6,4 @@ Comments for ReadonlyMapedType ## Type Parameters -### T - -\- +• **T** 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 index 5f82ddf37..9f82d9f07 100644 --- 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 @@ -6,13 +6,9 @@ Comments for object with special characters ## Type Parameters -### T +• **T** -\- - -### U - -\- +• **U** ## Type declaration 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 index 974a4c8c4..f37623d35 100644 --- 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 @@ -6,10 +6,6 @@ Comments for TypeWithTypeParams ## Type Parameters -### T +• **T** -\- - -### R - -\- +• **R** 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 index 7d06c159b..91615c21e 100644 --- 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 @@ -2,13 +2,9 @@ ## Type Parameters -### P +• **P** = [`DisposableClass`](DisposableClass.md) -Default type [`DisposableClass`](DisposableClass.md) - -### A - -Default type [`ClassWithModifiers`](ClassWithModifiers.md) +• **A** = [`ClassWithModifiers`](ClassWithModifiers.md) ## Constructors 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 index 8bdb78021..3bad02f11 100644 --- 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 @@ -4,19 +4,13 @@ Comments for ClassWithTypeParameters ## Type Parameters -### A +• **A** -\- - -### B - -*extends*: `string` +• **B** *extends* `string` Comments for param B -### C - -Default type `boolean` +• **C** = `boolean` Comments for param C 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 index 2e8025381..39d6a0314 100644 --- 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 @@ -20,9 +20,7 @@ Comments for current function 1 #### Type Parameters -##### Value - -\- +• **Value** #### Parameters @@ -46,9 +44,7 @@ Comments for iterable arg ### Type Parameters -#### Value - -\- +• **Value** ### Parameters 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 index ac56f8c11..9bed643b2 100644 --- 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 @@ -10,9 +10,7 @@ Comments for function ### Type Parameters -#### T - -\- +• **T** ### Parameters 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 index b3d6f5866..672ad512e 100644 --- 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 @@ -6,13 +6,11 @@ Function with type parameters ## Type Parameters -### T +• **T** Comments for T -### Item - -Default type `string` \| `boolean` +• **Item** = `string` \| `boolean` ## Returns 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 index 0948a8aad..15022f8e6 100644 --- 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 @@ -2,9 +2,7 @@ ## Type Parameters -### T - -\- +• **T** ## Properties 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 index 3b0121441..19be405d7 100644 --- 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 @@ -7,22 +7,22 @@ And some more comments ## Type Parameters -### A +• **A** This is a parameter. -### B +• **B** Comments for a parameter. This sentence is on a soft new line. -### C +• **C** This is a parameter. Documentation with a double line -### D +• **D**

These are comments with paras

These are comments with paras

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 index fe288696a..d6ce53681 100644 --- 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 @@ -4,9 +4,7 @@ Comments for InterfaceWithTypeParameters ## Type Parameters -### A - -\- +• **A** ## Properties 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 index 47d935607..9872a1c4f 100644 --- 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 @@ -6,9 +6,7 @@ Comments for ConditionalType ## Type Parameters -### T - -\- +• **T** ## Source 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 index ecdf815b8..846461668 100644 --- 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 @@ -6,9 +6,7 @@ Comments for PartialMappedType ## Type Parameters -### T - -\- +• **T** ## Source 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 index 80a3e7154..5aae84c2e 100644 --- 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 @@ -6,9 +6,7 @@ Comments for ReadonlyMapedType ## Type Parameters -### T - -\- +• **T** ## Source 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 index 37ef54bd7..140739da6 100644 --- 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 @@ -6,13 +6,9 @@ Comments for object with special characters ## Type Parameters -### T +• **T** -\- - -### U - -\- +• **U** ## Type declaration 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 index 3dcc3996e..249a93910 100644 --- 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 @@ -6,13 +6,9 @@ Comments for TypeWithTypeParams ## Type Parameters -### T +• **T** -\- - -### R - -\- +• **R** ## Source 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 index d9265f2fb..e4e759ecc 100644 --- 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 @@ -170,13 +170,9 @@ Comments for method #### Type Parameters -##### P +• **P** = [`DisposableClass`](globals.md#disposableclass) -Default type [`DisposableClass`](globals.md#disposableclass) - -##### A - -Default type [`ClassWithModifiers`](globals.md#classwithmodifiers) +• **A** = [`ClassWithModifiers`](globals.md#classwithmodifiers) #### Constructors @@ -952,19 +948,13 @@ Comments for ClassWithTypeParameters #### Type Parameters -##### A - -\- +• **A** -##### B - -*extends*: `string` +• **B** *extends* `string` Comments for param B -##### C - -Default type `boolean` +• **C** = `boolean` Comments for param C @@ -1422,9 +1412,7 @@ Comments for nestedPropD #### Type Parameters -##### T - -\- +• **T** #### Properties @@ -1741,22 +1729,22 @@ And some more comments #### Type Parameters -##### A +• **A** This is a parameter. -##### B +• **B** Comments for a parameter. This sentence is on a soft new line. -##### C +• **C** This is a parameter. Documentation with a double line -##### D +• **D**

These are comments with paras

These are comments with paras

@@ -1878,9 +1866,7 @@ Comments for InterfaceWithTypeParameters #### Type Parameters -##### A - -\- +• **A** #### Properties @@ -1926,13 +1912,9 @@ Comments for object with special characters #### Type Parameters -##### T - -\- - -##### U +• **T** -\- +• **U** #### Type declaration @@ -2062,9 +2044,7 @@ Comments for ConditionalType #### Type Parameters -##### T - -\- +• **T** #### Source @@ -2292,9 +2272,7 @@ Comments for PartialMappedType #### Type Parameters -##### T - -\- +• **T** #### Source @@ -2366,9 +2344,7 @@ Comments for ReadonlyMapedType #### Type Parameters -##### T - -\- +• **T** #### Source @@ -2456,13 +2432,9 @@ Comments for TypeWithTypeParams #### Type Parameters -##### T - -\- - -##### R +• **T** -\- +• **R** #### Source @@ -2750,9 +2722,7 @@ Comments for current function 1 ###### Type Parameters -###### Value - -\- +• **Value** ###### Parameters @@ -2776,9 +2746,7 @@ Comments for iterable arg ##### Type Parameters -###### Value - -\- +• **Value** ##### Parameters @@ -2812,9 +2780,7 @@ Comments for function ##### Type Parameters -###### T - -\- +• **T** ##### Parameters @@ -3264,13 +3230,11 @@ Function with type parameters #### Type Parameters -##### T +• **T** Comments for T -##### Item - -Default type `string` \| `boolean` +• **Item** = `string` \| `boolean` #### Returns 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 83427a6dc..2c02b05c6 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 @@ -1238,19 +1238,13 @@ Comments for ClassWithTypeParameters ## Type Parameters -### A +• **A** -\\- - -### B - -*extends*: \`string\` +• **B** *extends* \`string\` Comments for param B -### C - -Default type \`boolean\` +• **C** = \`boolean\` Comments for param C diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.function.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.function.spec.ts.snap index 2560502f0..e1ffdc188 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.function.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.function.spec.ts.snap @@ -23,9 +23,7 @@ Comments for current function 1 #### Type Parameters -##### Value - -\\- +• **Value** #### Parameters @@ -49,9 +47,7 @@ Comments for iterable arg ### Type Parameters -#### Value - -\\- +• **Value** ### Parameters @@ -158,9 +154,7 @@ Comments for function ### Type Parameters -#### T - -\\- +• **T** ### Parameters @@ -1167,13 +1161,11 @@ Function with type parameters ## Type Parameters -### T +• **T** Comments for T -### Item - -Default type \`string\` \\| \`boolean\` +• **Item** = \`string\` \\| \`boolean\` ## Returns diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap index 09226a588..a1554e63e 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap @@ -641,22 +641,22 @@ And some more comments ## Type Parameters -### A +• **A** This is a parameter. -### B +• **B** Comments for a parameter. This sentence is on a soft new line. -### C +• **C** This is a parameter. Documentation with a double line -### D +• **D**

These are comments with paras

These are comments with paras

@@ -842,9 +842,7 @@ Comments for InterfaceWithTypeParameters ## Type Parameters -### A - -\\- +• **A** ## Properties diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap index 02ea350fd..695eada1f 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap @@ -37,9 +37,7 @@ Comments for ConditionalType ## Type Parameters -### T - -\\- +• **T** ## Source @@ -431,9 +429,7 @@ Comments for PartialMappedType ## Type Parameters -### T - -\\- +• **T** ## Source @@ -527,9 +523,7 @@ Comments for ReadonlyMapedType ## Type Parameters -### T - -\\- +• **T** ## Source @@ -629,13 +623,9 @@ Comments for TypeWithTypeParams ## Type Parameters -### T - -\\- - -### R +• **T** -\\- +• **R** ## Source