| Package | +Description | +
|---|---|
| test-suite-a | +Test package | +
| test-suite-b | ++ |
Test package
++
This remarks block includes a bulleted list!
+- Bullet 1
+- Bullet 2
+And an ordered list for good measure!
+1. List item 1
+2. List item 2
+3. List item 3
+Also, here is a link test, including a bad link, because we should have some reasonable support if this happens:
+- Good link (no alias): TestClass
+- Good link (with alias): function alias text
+- Bad link (no alias): InvalidItem
+- Bad link (with alias): even though I link to an invalid item, I would still like this text to be rendered
+ ++
A test example
const foo = bar;
+
+ | Interface | +Description | +
|---|---|
| TestEmptyInterface | +An empty interface | +
| TestInterface | +Test interface | +
| TestInterfaceExtendingOtherInterfaces | +Test interface that extends other interfaces | +
| TestInterfaceWithIndexSignature | +An interface with an index signature. | +
| TestInterfaceWithTypeParameter | +Test interface with generic type parameter | +
| Class | +Description | +
|---|---|
| TestAbstractClass | +A test abstract class. | +
| TestClass | +Test class | +
| Enum | +Description | +
|---|---|
| TestEnum | +Test Enum | +
| TypeAlias | +Description | +
|---|---|
| TestMappedType | +Test Mapped Type, using TestEnum | +
| TypeAlias | +Test Type-Alias | +
| Function | +Alerts | +Return Type | +Description | +
|---|---|---|---|
| testFunction(testParameter, testOptionalParameter) | +Alpha |
+ TTypeParameter | +Test function | +
| testFunctionReturningInlineType() | ++ | { foo: number; bar: TestEnum; } | +Test function that returns an inline type | +
| testFunctionReturningIntersectionType() | +Deprecated |
+ TestEmptyInterface & TestInterfaceWithTypeParameter<number> | +Test function that returns an inline type | +
| testFunctionReturningUnionType() | ++ | string | TestInterface | +Test function that returns an inline type | +
| Variable | +Alerts | +Modifiers | +Type | +Description | +
|---|---|---|---|---|
| testConst | +Beta |
+ readonly |
+ + | Test Constant | +
| testConstWithEmptyDeprecatedBlock | +Deprecated |
+ readonly |
+ string | +I have a @deprecated tag with an empty comment block. |
+
| Namespace | +Description | +
|---|---|
| TestModule | ++ |
| TestNamespace | +Test Namespace | +
Packages > test-suite-a > TestAbstractClass > (constructor)(privateProperty, protectedProperty)
+This is a {@customTag constructor}.
+protected constructor(privateProperty: number, protectedProperty: TestEnum);
+ | Parameter | +Type | +Description | +
|---|---|---|
| privateProperty | +number | ++ |
| protectedProperty | +TestEnum | ++ |
Packages > test-suite-a > TestAbstractClass > abstractPropertyGetter
+A test abstract getter property.
+abstract get abstractPropertyGetter(): TestMappedType;
+ Type: TestMappedType
+A test abstract class.
+export declare abstract class TestAbstractClass
+ | Constructor | +Description | +
|---|---|
| (constructor)(privateProperty, protectedProperty) | +This is a {@customTag constructor}. | +
| Property | +Modifiers | +Type | +Description | +
|---|---|---|---|
| abstractPropertyGetter | +readonly |
+ TestMappedType | +A test abstract getter property. | +
| protectedProperty | +readonly |
+ TestEnum | +A test protected property. | +
| Method | +Modifiers | +Return Type | +Description | +
|---|---|---|---|
| publicAbstractMethod() | ++ | void | +A test public abstract method. | +
| sealedMethod() | +sealed |
+ string | +A test @sealed method. |
+
| virtualMethod() | +virtual |
+ number | +A test @virtual method. |
+
Packages > test-suite-a > TestAbstractClass > protectedProperty
+A test protected property.
+protected readonly protectedProperty: TestEnum;
+ Type: TestEnum
+Packages > test-suite-a > TestAbstractClass > publicAbstractMethod()
+A test public abstract method.
+abstract publicAbstractMethod(): void;
+ Packages > test-suite-a > TestAbstractClass > sealedMethod()
+A test @sealed method.
/** @sealed */
protected sealedMethod(): string;
+ A string!
+Return type: string
+Packages > test-suite-a > TestAbstractClass > virtualMethod()
+A test @virtual method.
/** @virtual */
protected virtualMethod(): number;
+ A number!
+Return type: number
+Packages > test-suite-a > TestClass > (constructor)(privateProperty, protectedProperty, testClassProperty, testClassEventProperty)
+Test class constructor
+constructor(privateProperty: number, protectedProperty: TestEnum, testClassProperty: TTypeParameterB, testClassEventProperty: () => void);
+ Here are some remarks about the constructor
+| Parameter | +Type | +Description | +
|---|---|---|
| privateProperty | +number | +See TestAbstractClass's constructor. | +
| protectedProperty | +TestEnum | +
+ Some notes about the parameter. +See protectedProperty. + |
+
| testClassProperty | +TTypeParameterB | +See testClassProperty. | +
| testClassEventProperty | +() => void | +See testClassEventProperty. | +
Packages > test-suite-a > TestClass > abstractPropertyGetter
+A test abstract getter property.
+get abstractPropertyGetter(): TestMappedType;
+ Type: TestMappedType
+Test class
+export declare class TestClass<TTypeParameterA, TTypeParameterB> extends TestAbstractClass
+ +
Extends: TestAbstractClass
+
+ Type Parameters
+
+
+
+
+
+
+
+ Parameter
+ Description
+
+
+ TTypeParameterA
+ A type parameter
+
+
+
+ TTypeParameterB
+ Another type parameter
+
Here are some remarks about the class
+| Constructor | +Description | +
|---|---|
| (constructor)(privateProperty, protectedProperty, testClassProperty, testClassEventProperty) | +Test class constructor | +
| Property | +Type | +Description | +
|---|---|---|
| testClassStaticProperty | +(foo: number) => string | +Test static class property | +
| Method | +Return Type | +Description | +
|---|---|---|
| testClassStaticMethod(foo) | +string | +Test class static method | +
| Property | +Modifiers | +Type | +Description | +
|---|---|---|---|
| testClassEventProperty | +readonly |
+ () => void | +Test class event property | +
| Property | +Modifiers | +Type | +Description | +
|---|---|---|---|
| abstractPropertyGetter | +readonly |
+ TestMappedType | +A test abstract getter property. | +
| testClassGetterProperty | +virtual |
+ number | +Test class property with both a getter and a setter. | +
| testClassProperty | +readonly |
+ TTypeParameterB | +Test class property | +
| Method | +Modifiers | +Return Type | +Description | +
|---|---|---|---|
| publicAbstractMethod() | ++ | void | +A test public abstract method. | +
| testClassMethod(input) | +sealed |
+ TTypeParameterA | +Test class method | +
| virtualMethod() | ++ | number | +Overrides virtualMethod(). | +
Packages > test-suite-a > TestClass > publicAbstractMethod()
+A test public abstract method.
+publicAbstractMethod(): void;
+ Packages > test-suite-a > TestClass > testClassEventProperty
+Test class event property
+readonly testClassEventProperty: () => void;
+ Type: () => void
+Here are some remarks about the property
+Packages > test-suite-a > TestClass > testClassGetterProperty
+Test class property with both a getter and a setter.
+/** @virtual */
get testClassGetterProperty(): number;
set testClassGetterProperty(newValue: number);
+ Type: number
+Here are some remarks about the getter-only property
+Packages > test-suite-a > TestClass > testClassMethod(input)
+Test class method
+/** @sealed */
testClassMethod(input: TTypeParameterA): TTypeParameterA;
+ Here are some remarks about the method
+| Parameter | +Type | +Description | +
|---|---|---|
| input | +TTypeParameterA | ++ |
Return type: TTypeParameterA
+Some sort of error in 1 case.
+Some other sort of error in another case. For example, a case where some thing happens.
+Test class property
+readonly testClassProperty: TTypeParameterB;
+ Type: TTypeParameterB
+Here are some remarks about the property
+Packages > test-suite-a > TestClass > testClassStaticMethod(foo)
+Test class static method
+static testClassStaticMethod(foo: number): string;
+ | Parameter | +Type | +Description | +
|---|---|---|
| foo | +number | +Some number | +
- Some string
+Return type: string
+Packages > test-suite-a > TestClass > testClassStaticProperty
+Test static class property
+static testClassStaticProperty: (foo: number) => string;
+ Type: (foo: number) => string
+Overrides virtualMethod().
+/** @override */
protected virtualMethod(): number;
+ Return type: number
+Test Constant
+testConst = 42
+ Here are some remarks about the variable
+I have a @deprecated tag with an empty comment block.
WARNING: This API is deprecated and will be removed in a future release.
testConstWithEmptyDeprecatedBlock: string
+ Type: string
+An empty interface
+export interface TestEmptyInterface
+ Test Enum
+export declare enum TestEnum
+ Here are some remarks about the enum
++
Some example
const foo = TestEnum.TestEnumValue1
+
+ +
Another example
const bar = TestEnum.TestEnumValue2
+
+ | Flag | +Description | +
|---|---|
| TestEnumValue1 | +Test enum value 1 (string) | +
| TestEnumValue2 | +Test enum value 2 (number) | +
| TestEnumValue3 | +Test enum value 3 (default) | +
Test enum value 1 (string)
+TestEnumValue1 = "test-enum-value-1"
+ Here are some remarks about the enum value
+Test enum value 2 (number)
+TestEnumValue2 = 3
+ Here are some remarks about the enum value
+Test enum value 3 (default)
+TestEnumValue3 = 4
+ Here are some remarks about the enum value
+Test enum value 1 (string)
+TestEnumValue1 = "test-enum-value-1"
+ Here are some remarks about the enum value
+Test enum value 2 (number)
+TestEnumValue2 = 3
+ Here are some remarks about the enum value
+Test enum value 3 (default)
+TestEnumValue3 = 4
+ Here are some remarks about the enum value
+Packages > test-suite-a > testFunction(testParameter, testOptionalParameter)
+Test function
+export declare function testFunction<TTypeParameter extends TestInterface = TestInterface>(testParameter: TTypeParameter, testOptionalParameter?: TTypeParameter): TTypeParameter;
+
+ Type Parameters
+
+
+
+
+
+
+
+ Parameter
+ Constraint
+ Default
+ Description
+
+
+
+ TTypeParameter
+ TestInterface
+ TestInterface
+ A test type parameter
+
This is a test link to another API member
+| Parameter | +Modifiers | +Type | +Description | +
|---|---|---|---|
| testParameter | ++ | TTypeParameter | +A test parameter | +
| testOptionalParameter | +optional | +TTypeParameter | ++ |
The provided parameter
+Return type: TTypeParameter
+An Error when something bad happens.
+Test function that returns an inline type
+export declare function testFunctionReturningInlineType(): {
foo: number;
bar: TestEnum;
};
+ An inline type
+Return type: { foo: number; bar: TestEnum; }
+Packages > test-suite-a > testFunctionReturningIntersectionType()
+Test function that returns an inline type
+WARNING: This API is deprecated and will be removed in a future release. This is a test deprecation notice. Here is a link to something else!
export declare function testFunctionReturningIntersectionType(): TestEmptyInterface & TestInterfaceWithTypeParameter<number>;
+ an intersection type
+Return type: TestEmptyInterface & TestInterfaceWithTypeParameter<number>
+Test function that returns an inline type
+export declare function testFunctionReturningUnionType(): string | TestInterface;
+ A union type
+Return type: string | TestInterface
+Packages > test-suite-a > TestInterface > (event: 'testCallSignature', listener: (input: unknown) => void): any
+Test interface event call signature
+(event: 'testCallSignature', listener: (input: unknown) => void): any;
+ Here are some remarks about the event call signature
+Packages > test-suite-a > TestInterface > (event: 'anotherTestCallSignature', listener: (input: number) => string): number
+Another example call signature
+(event: 'anotherTestCallSignature', listener: (input: number) => string): number;
+ Here are some remarks about the event call signature
+Packages > test-suite-a > TestInterface > new (): TestInterface
+Test construct signature.
+new (): TestInterface;
+ Return type: TestInterface
+A test getter-only interface property.
+get getterProperty(): boolean;
+ Type: boolean
+Test interface
+export interface TestInterface
+ Here are some remarks about the interface
+| ConstructSignature | +Return Type | +Description | +
|---|---|---|
| new (): TestInterface | +TestInterface | +Test construct signature. | +
| Property | +Modifiers | +Type | +Description | +
|---|---|---|---|
| testClassEventProperty | +readonly |
+ () => void | +Test interface event property | +
| Property | +Modifiers | +Default Value | +Type | +Description | +
|---|---|---|---|---|
| getterProperty | +readonly |
+ + | boolean | +A test getter-only interface property. | +
| propertyWithBadInheritDocTarget | ++ | + | boolean | ++ |
| setterProperty | ++ | + | boolean | +A test property with a getter and a setter. | +
| testInterfaceProperty | ++ | + | number | +Test interface property | +
| testOptionalInterfaceProperty | +optional |
+ 0 | +number | +Test optional property | +
| Method | +Return Type | +Description | +
|---|---|---|
| testInterfaceMethod() | +void | +Test interface method | +
| CallSignature | +Description | +
|---|---|
| (event: 'testCallSignature', listener: (input: unknown) => void): any | +Test interface event call signature | +
| (event: 'anotherTestCallSignature', listener: (input: number) => string): number | +Another example call signature | +
Packages > test-suite-a > TestInterface > propertyWithBadInheritDocTarget
+propertyWithBadInheritDocTarget: boolean;
+ Type: boolean
+A test property with a getter and a setter.
+get setterProperty(): boolean;
set setterProperty(newValue: boolean);
+ Type: boolean
+Packages > test-suite-a > TestInterface > testClassEventProperty
+Test interface event property
+readonly testClassEventProperty: () => void;
+ Type: () => void
+Here are some remarks about the event property
+Packages > test-suite-a > TestInterface > testInterfaceMethod()
+Test interface method
+testInterfaceMethod(): void;
+ Here are some remarks about the method
+Packages > test-suite-a > TestInterface > testInterfaceProperty
+Test interface property
+testInterfaceProperty: number;
+ Type: number
+Here are some remarks about the property
+Packages > test-suite-a > TestInterface > testOptionalInterfaceProperty
+Test optional property
+testOptionalInterfaceProperty?: number;
+ Type: number
+Packages > test-suite-a > TestInterfaceExtendingOtherInterfaces
+Test interface that extends other interfaces
+export interface TestInterfaceExtendingOtherInterfaces extends TestInterface, TestMappedType, TestInterfaceWithTypeParameter<number>
+ Extends: TestInterface, TestMappedType, TestInterfaceWithTypeParameter<number>
+Here are some remarks about the interface
+| Method | +Return Type | +Description | +
|---|---|---|
| testMethod(input) | +number | +Test interface method accepting a string and returning a number. | +
+
+ + + +Packages > test-suite-a > TestInterfaceExtendingOtherInterfaces > testMethod(input)
+Test interface method accepting a string and returning a number.
+testMethod(input: string): number;
+ Here are some remarks about the method
+| Parameter | +Type | +Description | +
|---|---|---|
| input | +string | +A string | +
A number
+Return type: number
+Packages > test-suite-a > TestInterfaceWithIndexSignature > [foo: number]: { bar: string; }
+Test index signature.
+[foo: number]: {
bar: string;
};
+ An interface with an index signature.
+export interface TestInterfaceWithIndexSignature
+ | IndexSignature | +Description | +
|---|---|
| [foo: number]: { bar: string; } | +Test index signature. | +
Test interface with generic type parameter
+export interface TestInterfaceWithTypeParameter<T>
+
+ Type Parameters
+
+
+
+
+
+
+
+ Parameter
+ Description
+
+
+
+ T
+ A type parameter
+
Here are some remarks about the interface
+| Property | +Type | +Description | +
|---|---|---|
| testProperty | +T | +A test interface property using generic type parameter | +
Packages > test-suite-a > TestInterfaceWithTypeParameter > testProperty
+A test interface property using generic type parameter
+testProperty: T;
+ Type: T
+Here are some remarks about the property
+Test Mapped Type, using TestEnum
+export type TestMappedType = {
[K in TestEnum]: boolean;
};
+ Here are some remarks about the mapped type
+Packages > test-suite-a > TestModule > foo
+Test constant in module.
+foo = 2
+ | Variable | +Modifiers | +Type | +Description | +
|---|---|---|---|
| foo | +readonly |
+ + | Test constant in module. | +
Test Namespace
+export declare namespace TestNamespace
+ Here are some remarks about the namespace
++
const foo: Foo = {
bar: "Hello world!";
baz = 42;
};
+
+ +
const foo = {
bar: "Hello world!";
baz = 42;
};
+
+ | Interface | +Alerts | +Description | +
|---|---|---|
| TestInterface | +Alpha |
+ Test interface | +
| Class | +Description | +
|---|---|
| TestClass | +Test class | +
| Enum | +Description | +
|---|---|
| TestEnum | +Test Enum | +
| TypeAlias | +Description | +
|---|---|
| TestTypeAlias | +Test Type-Alias | +
| Function | +Return Type | +Description | +
|---|---|---|
| testFunction(testParameter) | +number | +Test function | +
| Variable | +Alerts | +Modifiers | +Type | +Description | +
|---|---|---|---|---|
| TestConst | +Beta |
+ readonly |
+ + | Test Constant | +
| Namespace | +Description | +
|---|---|
| TestSubNamespace | +Test sub-namespace | +
Packages > test-suite-a > TestNamespace > TestClass > (constructor)(testClassProperty)
+Test class constructor
+constructor(testClassProperty: string);
+ | Parameter | +Type | +Description | +
|---|---|---|
| testClassProperty | +string | +See testClassProperty | +
Test class
+class TestClass
+ | Constructor | +Description | +
|---|---|
| (constructor)(testClassProperty) | +Test class constructor | +
| Property | +Modifiers | +Type | +Description | +
|---|---|---|---|
| testClassProperty | +readonly |
+ string | +Test interface property | +
| Method | +Return Type | +Description | +
|---|---|---|
| testClassMethod(testParameter) | +Promise<string> | +Test class method | +
Packages > test-suite-a > TestNamespace > TestClass > testClassMethod(testParameter)
+Test class method
+testClassMethod(testParameter: string): Promise<string>;
+ | Parameter | +Type | +Description | +
|---|---|---|
| testParameter | +string | +A string | +
A Promise
+Return type: Promise<string>
+An Error when something happens for which an error should be thrown. Except in the cases where another kind of error is thrown. We don't throw this error in those cases.
++
A different kind of error when a thing happens, but not when the first kind of error is thrown instead.
+😁
+ +Packages > test-suite-a > TestNamespace > TestClass > testClassProperty
+Test interface property
+readonly testClassProperty: string;
+ Type: string
+Test Constant
+TestConst = "Hello world!"
+ Test Enum
+enum TestEnum
+ | Flag | +Description | +
|---|---|
| TestEnumValue1 | +Test enum value 1 | +
| TestEnumValue2 | +Test enum value 2 | +
Test enum value 1
+TestEnumValue1 = 0
+ Test enum value 2
+TestEnumValue2 = 1
+ Packages > test-suite-a > TestNamespace > TestEnum > TestEnumValue1
+Test enum value 1
+TestEnumValue1 = 0
+ Packages > test-suite-a > TestNamespace > TestEnum > TestEnumValue2
+Test enum value 2
+TestEnumValue2 = 1
+ Packages > test-suite-a > TestNamespace > testFunction(testParameter)
+Test function
+function testFunction(testParameter: number): number;
+ | Parameter | +Type | +Description | +
|---|---|---|
| testParameter | +number | ++ |
A number
+Return type: number
+An Error
+Test interface
+interface TestInterface extends TestInterfaceWithTypeParameter<TestEnum>
+ Extends: TestInterfaceWithTypeParameter<TestEnum>
+| Property | +Alerts | +Type | +Description | +
|---|---|---|---|
| testInterfaceProperty | +Alpha |
+ boolean | +Test interface property | +
| Method | +Alerts | +Return Type | +Description | +
|---|---|---|---|
| testInterfaceMethod() | +Alpha |
+ void | +Test interface method | +
Packages > test-suite-a > TestNamespace > TestInterface > testInterfaceMethod()
+Test interface method
+testInterfaceMethod(): void;
+ Packages > test-suite-a > TestNamespace > TestInterface > testInterfaceProperty
+Test interface property
+testInterfaceProperty: boolean;
+ Type: boolean
+Test sub-namespace
+namespace TestSubNamespace
+ Test Type-Alias
+type TestTypeAlias = boolean;
+ Test Type-Alias
+export type TypeAlias = string;
+ Here are some remarks about the type alias
+Packages > test-suite-b > Foo > bar
+Test Enum
+bar: TestEnum;
+ Type: TestEnum
+Here are some remarks about the enum
+Packages > test-suite-b > Foo
+Bar
+export interface Foo
+ | Property | +Type | +Description | +
|---|---|---|
| bar | +TestEnum | +Test Enum | +
| Interface | +Description | +
|---|---|
| Foo | +Bar | +
Some notes about the parameter.
See protectedProperty.
| +| testClassProperty | TTypeParameterB | See [testClassProperty](/test-suite-a/testclass-class/testclassproperty-property). | +| testClassEventProperty | () => void | See [testClassEventProperty](/test-suite-a/testclass-class/testclasseventproperty-property). | diff --git a/tools/api-markdown-documenter/src/test/snapshots/markdown/simple-suite-test/deep-config/test-suite-a/testclass-class/abstractpropertygetter-property.md b/tools/api-markdown-documenter/src/test/snapshots/markdown/simple-suite-test/deep-config/test-suite-a/testclass-class/abstractpropertygetter-property.md new file mode 100644 index 000000000000..837bb16dc32d --- /dev/null +++ b/tools/api-markdown-documenter/src/test/snapshots/markdown/simple-suite-test/deep-config/test-suite-a/testclass-class/abstractpropertygetter-property.md @@ -0,0 +1,13 @@ +# abstractPropertyGetter + +[Packages](/) > [test-suite-a](/test-suite-a/) > [TestClass](/test-suite-a/testclass-class/) > [abstractPropertyGetter](/test-suite-a/testclass-class/abstractpropertygetter-property) + +A test abstract getter property. + +## Signature {#abstractpropertygetter-signature} + +```typescript +get abstractPropertyGetter(): TestMappedType; +``` + +**Type:** [TestMappedType](/test-suite-a/testmappedtype-typealias/) diff --git a/tools/api-markdown-documenter/src/test/snapshots/markdown/simple-suite-test/deep-config/test-suite-a/testclass-class/index.md b/tools/api-markdown-documenter/src/test/snapshots/markdown/simple-suite-test/deep-config/test-suite-a/testclass-class/index.md new file mode 100644 index 000000000000..3acc2358a5f1 --- /dev/null +++ b/tools/api-markdown-documenter/src/test/snapshots/markdown/simple-suite-test/deep-config/test-suite-a/testclass-class/index.md @@ -0,0 +1,68 @@ +# TestClass + +[Packages](/) > [test-suite-a](/test-suite-a/) > [TestClass](/test-suite-a/testclass-class/) + +Test class + +## Signature {#testclass-signature} + +```typescript +export declare class TestClass