mirror of
https://github.com/hanzoai/tsgo.git
synced 2026-10-30 19:37:15 +00:00
178 lines
4.5 KiB
Plaintext
178 lines
4.5 KiB
Plaintext
// === QuickInfo ===
|
|
=== /quickInfoInheritDoc.ts ===
|
|
// abstract class BaseClass {
|
|
// /**
|
|
// * Useful description always applicable
|
|
// *
|
|
// * @returns {string} Useful description of return value always applicable.
|
|
// */
|
|
// public static doSomethingUseful(stuff?: any): string {
|
|
// throw new Error('Must be implemented by subclass');
|
|
// }
|
|
//
|
|
// /**
|
|
// * BaseClass.func1
|
|
// * @param {any} stuff1 BaseClass.func1.stuff1
|
|
// * @returns {void} BaseClass.func1.returns
|
|
// */
|
|
// public static func1(stuff1: any): void {
|
|
// }
|
|
//
|
|
// /**
|
|
// * Applicable description always.
|
|
// */
|
|
// public static readonly someProperty: string = 'general value';
|
|
// }
|
|
//
|
|
//
|
|
//
|
|
//
|
|
// class SubClass extends BaseClass {
|
|
//
|
|
// /**
|
|
// * @inheritDoc
|
|
// *
|
|
// * @param {{ tiger: string; lion: string; }} [mySpecificStuff] Description of my specific parameter.
|
|
// */
|
|
// public static doSomethingUseful(mySpecificStuff?: { tiger: string; lion: string; }): string {
|
|
// ^^^^^^^^^^^^^^^^^
|
|
// | ----------------------------------------------------------------------
|
|
// | ```typescript
|
|
// | (method) SubClass.doSomethingUseful(mySpecificStuff?: {
|
|
// | tiger: string;
|
|
// | lion: string;
|
|
// | }): string
|
|
// | ```
|
|
// |
|
|
// |
|
|
// | *@inheritDoc*
|
|
// |
|
|
// | *@param* `mySpecificStuff` — Description of my specific parameter.
|
|
// | ----------------------------------------------------------------------
|
|
// let useful = '';
|
|
//
|
|
// // do something useful to useful
|
|
//
|
|
// return useful;
|
|
// }
|
|
//
|
|
// /**
|
|
// * @inheritDoc
|
|
// * @param {any} stuff1 SubClass.func1.stuff1
|
|
// * @returns {void} SubClass.func1.returns
|
|
// */
|
|
// public static func1(stuff1: any): void {
|
|
// ^^^^^
|
|
// | ----------------------------------------------------------------------
|
|
// | ```typescript
|
|
// | (method) SubClass.func1(stuff1: any): void
|
|
// | ```
|
|
// |
|
|
// |
|
|
// | *@inheritDoc*
|
|
// |
|
|
// | *@param* `stuff1` — SubClass.func1.stuff1
|
|
// |
|
|
// | *@returns* — SubClass.func1.returns
|
|
// | ----------------------------------------------------------------------
|
|
// }
|
|
//
|
|
// /**
|
|
// * text over tag
|
|
// * @inheritDoc
|
|
// * text after tag
|
|
// */
|
|
// public static readonly someProperty: string = 'specific to this class value'
|
|
// ^^^^^^^^^^^^
|
|
// | ----------------------------------------------------------------------
|
|
// | ```typescript
|
|
// | (property) SubClass.someProperty: string
|
|
// | ```
|
|
// | text over tag
|
|
// |
|
|
// | *@inheritDoc* — text after tag
|
|
// | ----------------------------------------------------------------------
|
|
// }
|
|
[
|
|
{
|
|
"marker": {
|
|
"Position": 817,
|
|
"LSPosition": {
|
|
"line": 34,
|
|
"character": 18
|
|
},
|
|
"Name": "1",
|
|
"Data": {}
|
|
},
|
|
"item": {
|
|
"contents": {
|
|
"kind": "markdown",
|
|
"value": "```typescript\n(method) SubClass.doSomethingUseful(mySpecificStuff?: {\n tiger: string;\n lion: string;\n}): string\n```\n\n\n*@inheritDoc*\n\n*@param* `mySpecificStuff` — Description of my specific parameter."
|
|
},
|
|
"range": {
|
|
"start": {
|
|
"line": 34,
|
|
"character": 18
|
|
},
|
|
"end": {
|
|
"line": 34,
|
|
"character": 35
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"marker": {
|
|
"Position": 1143,
|
|
"LSPosition": {
|
|
"line": 47,
|
|
"character": 18
|
|
},
|
|
"Name": "2",
|
|
"Data": {}
|
|
},
|
|
"item": {
|
|
"contents": {
|
|
"kind": "markdown",
|
|
"value": "```typescript\n(method) SubClass.func1(stuff1: any): void\n```\n\n\n*@inheritDoc*\n\n*@param* `stuff1` — SubClass.func1.stuff1\n\n*@returns* — SubClass.func1.returns"
|
|
},
|
|
"range": {
|
|
"start": {
|
|
"line": 47,
|
|
"character": 18
|
|
},
|
|
"end": {
|
|
"line": 47,
|
|
"character": 23
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"marker": {
|
|
"Position": 1282,
|
|
"LSPosition": {
|
|
"line": 55,
|
|
"character": 27
|
|
},
|
|
"Name": "3",
|
|
"Data": {}
|
|
},
|
|
"item": {
|
|
"contents": {
|
|
"kind": "markdown",
|
|
"value": "```typescript\n(property) SubClass.someProperty: string\n```\ntext over tag\n\n*@inheritDoc* — text after tag"
|
|
},
|
|
"range": {
|
|
"start": {
|
|
"line": 55,
|
|
"character": 27
|
|
},
|
|
"end": {
|
|
"line": 55,
|
|
"character": 39
|
|
}
|
|
}
|
|
}
|
|
}
|
|
] |