Skip to content

Commit bc72499

Browse files
committed
Updated examples
1 parent ccb97b1 commit bc72499

18 files changed

+130
-265
lines changed

examples/out/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
### External modules
77

88
* ["classes"](modules/_classes_.md)
9-
* ["doc-comments"](modules/_doc_comments_.md)
109
* ["enumerations"](modules/_enumerations_.md)
1110
* ["functions"](modules/_functions_.md)
1211
* ["variables"](modules/_variables_.md)

examples/out/classes/_classes_.baseclass.md

Lines changed: 20 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,13 @@ This is a simple example on how to use BaseClass.
5151

5252
<a id="constructor"></a>
5353

54-
### **new BaseClass**(name: *`string`*): [BaseClass](_classes_.baseclass.md)
54+
### constructor
5555

56-
### **new BaseClass**(source: *[BaseClass](_classes_.baseclass.md)*): [BaseClass](_classes_.baseclass.md)
56+
**new BaseClass**(name: *`string`*): [BaseClass](_classes_.baseclass.md)
5757

58-
*Defined in classes.ts:78*
58+
**new BaseClass**(source: *[BaseClass](_classes_.baseclass.md)*): [BaseClass](_classes_.baseclass.md)
59+
60+
*Defined in [classes.ts:78](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L78)*
5961

6062
**Parameters:**
6163

@@ -65,7 +67,7 @@ This is a simple example on how to use BaseClass.
6567

6668
**Returns:** [BaseClass](_classes_.baseclass.md)
6769

68-
*Defined in classes.ts:81*
70+
*Defined in [classes.ts:81](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L81)*
6971

7072
**Parameters:**
7173

@@ -75,7 +77,7 @@ This is a simple example on how to use BaseClass.
7577

7678
**Returns:** [BaseClass](_classes_.baseclass.md)
7779

78-
---
80+
___
7981

8082
## Properties
8183

@@ -85,24 +87,22 @@ This is a simple example on how to use BaseClass.
8587

8688
**● internalClass**: *[InternalClass](_classes_.internalclass.md)<`keyof BaseClass`>*
8789

88-
*Defined in classes.ts:78*
90+
*Defined in [classes.ts:78](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L78)*
8991

9092
This is an instance member of an internal class.
9193

9294
___
93-
9495
<a id="kind"></a>
9596

9697
### `<Protected>` kind
9798

9899
**● kind**: *`number`*
99100

100-
*Defined in classes.ts:65*
101+
*Defined in [classes.ts:65](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L65)*
101102

102103
This is a simple protected member.
103104

104105
___
105-
106106
<a id="name"></a>
107107

108108
### name
@@ -111,33 +111,31 @@ ___
111111

112112
*Implementation of [INameInterface](../interfaces/_classes_.inameinterface.md).[name](../interfaces/_classes_.inameinterface.md#name)*
113113

114-
*Defined in classes.ts:60*
114+
*Defined in [classes.ts:60](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L60)*
115115

116116
This is a simple public member.
117117

118118
___
119-
120119
<a id="instance"></a>
121120

122121
### `<Static>` instance
123122

124123
**● instance**: *[BaseClass](_classes_.baseclass.md)*
125124

126-
*Defined in classes.ts:72*
125+
*Defined in [classes.ts:72](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L72)*
127126

128127
This is a static member.
129128

130129
Static members should not be inherited.
131130

132131
___
133-
134132
<a id="instances"></a>
135133

136134
### `<Static>` instances
137135

138136
**● instances**: *[BaseClass](_classes_.baseclass.md)[]*
139137

140-
*Defined in classes.ts:73*
138+
*Defined in [classes.ts:73](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L73)*
141139

142140
___
143141

@@ -149,19 +147,18 @@ ___
149147

150148
**abstractMethod**(): `void`
151149

152-
*Defined in classes.ts:95*
150+
*Defined in [classes.ts:95](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L95)*
153151

154152
**Returns:** `void`
155153

156154
___
157-
158155
<a id="arrowfunction"></a>
159156

160157
### arrowFunction
161158

162159
**arrowFunction**(param2: *`string`*, param1: *`number`*): `void`
163160

164-
*Defined in classes.ts:143*
161+
*Defined in [classes.ts:143](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L143)*
165162

166163
This is a simple fat arrow function.
167164

@@ -175,21 +172,19 @@ This is a simple fat arrow function.
175172
**Returns:** `void`
176173

177174
___
178-
179175
<a id="checkname"></a>
180176

181177
### `<Private>` checkName
182178

183179
**checkName**(): `boolean`
184180

185-
*Defined in classes.ts:150*
181+
*Defined in [classes.ts:150](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L150)*
186182

187183
This is a private function.
188184

189185
**Returns:** `boolean`
190186

191187
___
192-
193188
<a id="getname"></a>
194189

195190
### getName
@@ -198,7 +193,7 @@ ___
198193

199194
*Implementation of [INameInterface](../interfaces/_classes_.inameinterface.md).[getName](../interfaces/_classes_.inameinterface.md#getname)*
200195

201-
*Defined in classes.ts:105*
196+
*Defined in [classes.ts:105](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L105)*
202197

203198
This is a simple member function.
204199

@@ -208,14 +203,13 @@ It should be inherited by all subclasses. This class has a static member with th
208203
Return the name.
209204

210205
___
211-
212206
<a id="setname"></a>
213207

214208
### setName
215209

216210
**setName**(name: *`string`*): `void`
217211

218-
*Defined in classes.ts:130*
212+
*Defined in [classes.ts:130](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L130)*
219213

220214
This is a simple member function.
221215

@@ -230,14 +224,13 @@ It should be inherited by all subclasses.
230224
**Returns:** `void`
231225

232226
___
233-
234227
<a id="catest"></a>
235228

236229
### `<Static>` caTest
237230

238231
**caTest**(originalValues: *[BaseClass](_classes_.baseclass.md)*, newRecord: *`any`*, fieldNames: *`string`[]*, mandatoryFields: *`string`[]*): `string`
239232

240-
*Defined in classes.ts:170*
233+
*Defined in [classes.ts:170](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L170)*
241234

242235
*__see__*: [https://github.com/sebastian-lenz/typedoc/issues/42](https://github.com/sebastian-lenz/typedoc/issues/42)
243236

@@ -253,14 +246,13 @@ ___
253246
**Returns:** `string`
254247

255248
___
256-
257249
<a id="getinstance"></a>
258250

259251
### `<Static>` getInstance
260252

261253
**getInstance**(): [BaseClass](_classes_.baseclass.md)
262254

263-
*Defined in classes.ts:162*
255+
*Defined in [classes.ts:162](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L162)*
264256

265257
This is a static function.
266258

@@ -270,14 +262,13 @@ Static functions should not be inherited.
270262
An instance of BaseClass.
271263

272264
___
273-
274265
<a id="getname-1"></a>
275266

276267
### `<Static>` getName
277268

278269
**getName**(): `string`
279270

280-
*Defined in classes.ts:118*
271+
*Defined in [classes.ts:118](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L118)*
281272

282273
This is a simple static member function.
283274

examples/out/classes/_classes_.genericclass.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,11 @@ This a type parameter.
4040

4141
<a id="constructor"></a>
4242

43-
### **new GenericClass**(p1: *`any`*, p2: *`T`*, p3: *`number`*, p4: *`number`*, p5: *`string`*): [GenericClass](_classes_.genericclass.md)
43+
### constructor
4444

45-
*Defined in classes.ts:284*
45+
**new GenericClass**(p1: *`any`*, p2: *`T`*, p3: *`number`*, p4: *`number`*, p5: *`string`*): [GenericClass](_classes_.genericclass.md)
46+
47+
*Defined in [classes.ts:284](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L284)*
4648

4749
Constructor short text.
4850

@@ -58,7 +60,7 @@ Constructor short text.
5860

5961
**Returns:** [GenericClass](_classes_.genericclass.md)
6062

61-
---
63+
___
6264

6365
## Properties
6466

@@ -68,55 +70,51 @@ Constructor short text.
6870

6971
**● p2**: *`T`*
7072

71-
*Defined in classes.ts:295*
73+
*Defined in [classes.ts:295](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L295)*
7274

7375
Private string property
7476

7577
___
76-
7778
<a id="p3"></a>
7879

7980
### p3
8081

8182
**● p3**: *`number`*
8283

83-
*Defined in classes.ts:295*
84+
*Defined in [classes.ts:295](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L295)*
8485

8586
Public number property
8687

8788
___
88-
8989
<a id="p4"></a>
9090

9191
### `<Private>` p4
9292

9393
**● p4**: *`number`*
9494

95-
*Defined in classes.ts:295*
95+
*Defined in [classes.ts:295](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L295)*
9696

9797
Public implicit any property
9898

9999
___
100-
101100
<a id="p5"></a>
102101

103102
### p5
104103

105104
**● p5**: *`string`*
106105

107-
*Defined in classes.ts:295*
106+
*Defined in [classes.ts:295](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L295)*
108107

109108
Readonly property
110109

111110
___
112-
113111
<a id="value"></a>
114112

115113
### value
116114

117115
**● value**: *`T`*
118116

119-
*Defined in classes.ts:284*
117+
*Defined in [classes.ts:284](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L284)*
120118

121119
___
122120

@@ -128,19 +126,18 @@ ___
128126

129127
**getValue**(): `T`
130128

131-
*Defined in classes.ts:305*
129+
*Defined in [classes.ts:305](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L305)*
132130

133131
**Returns:** `T`
134132

135133
___
136-
137134
<a id="setvalue"></a>
138135

139136
### setValue
140137

141138
**setValue**(value: *`T`*): `void`
142139

143-
*Defined in classes.ts:301*
140+
*Defined in [classes.ts:301](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L301)*
144141

145142
**Parameters:**
146143

examples/out/classes/_classes_.internalclass.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,11 @@ This is an internal class, it is not exported.
2222

2323
<a id="constructor"></a>
2424

25-
### **new InternalClass**(options: *`object`*): [InternalClass](_classes_.internalclass.md)
25+
### constructor
2626

27-
*Defined in classes.ts:187*
27+
**new InternalClass**(options: *`object`*): [InternalClass](_classes_.internalclass.md)
28+
29+
*Defined in [classes.ts:187](https://github.com/tgreyjs/typedoc-plugin-markdown/blob/master/examples/src/classes.ts#L187)*
2830

2931
**Parameters:**
3032

@@ -34,5 +36,5 @@ This is an internal class, it is not exported.
3436

3537
**Returns:** [InternalClass](_classes_.internalclass.md)
3638

37-
---
39+
___
3840

0 commit comments

Comments
 (0)