Skip to content

Commit 62cd24d

Browse files
aciccarelloaciccarello
committed
update typescript dependency to 2.7.1
classes example modified because accessing abstract properties is not allowed in the constructor closes #654 closes #655 closes #681 closes #687
1 parent b887cab commit 62cd24d

10 files changed

+36
-49
lines changed

‎examples/basic/src/classes.ts

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ export abstract class BaseClass implements INameInterface
5555
/**
5656
* This is a simple public member.
5757
*/
58-
public abstract name:string;
58+
public name:string;
5959

6060
/**
6161
* This is a simple protected member.
@@ -165,7 +165,7 @@ export abstract class BaseClass implements INameInterface
165165
/**
166166
* @see https://github.com/sebastian-lenz/typedoc/issues/42
167167
*/
168-
public static caTest(originalValues:BaseClass, newRecord:any, fieldNames:string[], mandatoryFields:string[]): string {
168+
public static caTest(originalValues:BaseClass, newRecord: any, fieldNames:string[], mandatoryFields:string[]): string {
169169
var returnval = "";
170170
var updates: string[] = [];
171171
var allFields: string[] = fieldNames;
@@ -178,7 +178,6 @@ export abstract class BaseClass implements INameInterface
178178
}
179179
}
180180

181-
182181
/**
183182
* This is an internal class, it is not exported.
184183
*/
@@ -189,7 +188,6 @@ class InternalClass<TTT extends keyof BaseClass>
189188
}
190189
}
191190

192-
193191
/**
194192
* This is a class that extends another class.
195193
*
@@ -205,15 +203,13 @@ export class SubClassA extends BaseClass implements IPrintNameInterface
205203
*/
206204
public print(value:string):void { }
207205

208-
209206
/**
210207
* @inheritdoc
211208
*/
212209
public printName():void {
213210
this.print(this.getName());
214211
}
215212

216-
217213
/**
218214
* Returns the name. See [[BaseClass.name]].
219215
*
@@ -233,7 +229,6 @@ export class SubClassA extends BaseClass implements IPrintNameInterface
233229
this.name = value;
234230
}
235231

236-
237232
/**
238233
* Returns the name. See [[BaseClass.name]].
239234
*
@@ -243,7 +238,6 @@ export class SubClassA extends BaseClass implements IPrintNameInterface
243238
return this.name;
244239
}
245240

246-
247241
/**
248242
* Sets the name. See [[BaseClass.name]].
249243
*
@@ -259,7 +253,6 @@ export class SubClassA extends BaseClass implements IPrintNameInterface
259253
}
260254
}
261255

262-
263256
/**
264257
* This is a class that extends another class.
265258
*
@@ -281,7 +274,6 @@ export class SubClassB extends BaseClass
281274
}
282275
}
283276

284-
285277
/**
286278
* This is a generic class.
287279
*
@@ -291,7 +283,6 @@ export class GenericClass<T extends BaseClass>
291283
{
292284
public value:T;
293285

294-
295286
/**
296287
* Constructor short text.
297288
*
@@ -304,25 +295,21 @@ export class GenericClass<T extends BaseClass>
304295
constructor(p1, protected p2:T, public p3:number, private p4:number, readonly p5: string) {
305296
}
306297

307-
308298
/**
309299
* @param value [[getValue]] is the counterpart.
310300
*/
311301
public setValue(value:T) {
312302
this.value = value;
313303
}
314304

315-
316305
public getValue():T {
317306
return this.value;
318307
}
319308
}
320309

321-
322310
/**
323311
* This a non generic class derived from a [[GenericClass|generic class]].
324312
*/
325-
export class NonGenericClass extends GenericClass<SubClassB>
326-
{
313+
export class NonGenericClass extends GenericClass<SubClassB> {
327314

328315
}

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
"progress": "^2.0.0",
4747
"shelljs": "^0.8.1",
4848
"typedoc-default-themes": "^0.5.0",
49-
"typescript": "2.5.3"
49+
"typescript": "2.7.1"
5050
},
5151
"devDependencies": {
5252
"@types/mocha": "2.2.48",

‎src/lib/converter/converter.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export interface ConverterResult {
1818
/**
1919
* An array containing all errors generated by the TypeScript compiler.
2020
*/
21-
errors: ts.Diagnostic[];
21+
errors: ReadonlyArray<ts.Diagnostic>;
2222

2323
/**
2424
* The resulting project reflection.
@@ -351,7 +351,7 @@ export class Converter extends ChildableComponent<Application, ConverterComponen
351351
* @param context The context object describing the current state the converter is in.
352352
* @returns An array containing all errors generated by the TypeScript compiler.
353353
*/
354-
private compile(context: Context): ts.Diagnostic[] {
354+
private compile(context: Context): ReadonlyArray<ts.Diagnostic> {
355355
const program = context.program;
356356

357357
program.getSourceFiles().forEach((sourceFile) => {

‎src/lib/utils/loggers.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ export class Logger {
116116
*
117117
* @param diagnostics The TypeScript messages that should be logged.
118118
*/
119-
public diagnostics(diagnostics: ts.Diagnostic[]) {
119+
public diagnostics(diagnostics: ReadonlyArray<ts.Diagnostic>) {
120120
diagnostics.forEach((diagnostic) => {
121121
this.diagnostic(diagnostic);
122122
});

‎src/test/renderer/specs/classes/_classes_.baseclass.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> kind</h3>
210210
</section>
211211
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
212212
<a name="name" class="tsd-anchor"></a>
213-
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> name</h3>
213+
<h3>name</h3>
214214
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
215215
<aside class="tsd-sources">
216216
<p>Implementation of <a href="../interfaces/_classes_.inameinterface.html">INameInterface</a>.<a href="../interfaces/_classes_.inameinterface.html#name">name</a></p>

‎src/test/renderer/specs/classes/_classes_.genericclass.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ <h3>constructor</h3>
144144
<li class="tsd-description">
145145
<aside class="tsd-sources">
146146
<ul>
147-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L292">classes.ts:292</a></li>
147+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L284">classes.ts:284</a></li>
148148
</ul>
149149
</aside>
150150
<div class="tsd-comment tsd-typography">
@@ -208,7 +208,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> p2</h3>
208208
<div class="tsd-signature tsd-kind-icon">p2<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</span></div>
209209
<aside class="tsd-sources">
210210
<ul>
211-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L304">classes.ts:304</a></li>
211+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L295">classes.ts:295</a></li>
212212
</ul>
213213
</aside>
214214
<div class="tsd-comment tsd-typography">
@@ -223,7 +223,7 @@ <h3>p3</h3>
223223
<div class="tsd-signature tsd-kind-icon">p3<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
224224
<aside class="tsd-sources">
225225
<ul>
226-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L304">classes.ts:304</a></li>
226+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L295">classes.ts:295</a></li>
227227
</ul>
228228
</aside>
229229
<div class="tsd-comment tsd-typography">
@@ -238,7 +238,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> p4</h3>
238238
<div class="tsd-signature tsd-kind-icon">p4<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
239239
<aside class="tsd-sources">
240240
<ul>
241-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L304">classes.ts:304</a></li>
241+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L295">classes.ts:295</a></li>
242242
</ul>
243243
</aside>
244244
<div class="tsd-comment tsd-typography">
@@ -253,7 +253,7 @@ <h3>p5</h3>
253253
<div class="tsd-signature tsd-kind-icon">p5<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
254254
<aside class="tsd-sources">
255255
<ul>
256-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L304">classes.ts:304</a></li>
256+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L295">classes.ts:295</a></li>
257257
</ul>
258258
</aside>
259259
<div class="tsd-comment tsd-typography">
@@ -268,7 +268,7 @@ <h3>value</h3>
268268
<div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</span></div>
269269
<aside class="tsd-sources">
270270
<ul>
271-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L292">classes.ts:292</a></li>
271+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L284">classes.ts:284</a></li>
272272
</ul>
273273
</aside>
274274
</section>
@@ -285,7 +285,7 @@ <h3>get<wbr>Value</h3>
285285
<li class="tsd-description">
286286
<aside class="tsd-sources">
287287
<ul>
288-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L316">classes.ts:316</a></li>
288+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L305">classes.ts:305</a></li>
289289
</ul>
290290
</aside>
291291
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
@@ -302,7 +302,7 @@ <h3>set<wbr>Value</h3>
302302
<li class="tsd-description">
303303
<aside class="tsd-sources">
304304
<ul>
305-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L311">classes.ts:311</a></li>
305+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L301">classes.ts:301</a></li>
306306
</ul>
307307
</aside>
308308
<div class="tsd-comment tsd-typography">

‎src/test/renderer/specs/classes/_classes_.internalclass.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ <h3>constructor</h3>
117117
<li class="tsd-description">
118118
<aside class="tsd-sources">
119119
<ul>
120-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L186">classes.ts:186</a></li>
120+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L185">classes.ts:185</a></li>
121121
</ul>
122122
</aside>
123123
<h4 class="tsd-parameters-title">Parameters</h4>

‎src/test/renderer/specs/classes/_classes_.nongenericclass.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ <h3>constructor</h3>
131131
<aside class="tsd-sources">
132132
<p>Inherited from <a href="_classes_.genericclass.html">GenericClass</a>.<a href="_classes_.genericclass.html#constructor">constructor</a></p>
133133
<ul>
134-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L292">classes.ts:292</a></li>
134+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L284">classes.ts:284</a></li>
135135
</ul>
136136
</aside>
137137
<div class="tsd-comment tsd-typography">
@@ -196,7 +196,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> p2</h3>
196196
<aside class="tsd-sources">
197197
<p>Inherited from <a href="_classes_.genericclass.html">GenericClass</a>.<a href="_classes_.genericclass.html#p2">p2</a></p>
198198
<ul>
199-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L304">classes.ts:304</a></li>
199+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L295">classes.ts:295</a></li>
200200
</ul>
201201
</aside>
202202
<div class="tsd-comment tsd-typography">
@@ -212,7 +212,7 @@ <h3>p3</h3>
212212
<aside class="tsd-sources">
213213
<p>Inherited from <a href="_classes_.genericclass.html">GenericClass</a>.<a href="_classes_.genericclass.html#p3">p3</a></p>
214214
<ul>
215-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L304">classes.ts:304</a></li>
215+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L295">classes.ts:295</a></li>
216216
</ul>
217217
</aside>
218218
<div class="tsd-comment tsd-typography">
@@ -228,7 +228,7 @@ <h3>p5</h3>
228228
<aside class="tsd-sources">
229229
<p>Inherited from <a href="_classes_.genericclass.html">GenericClass</a>.<a href="_classes_.genericclass.html#p5">p5</a></p>
230230
<ul>
231-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L304">classes.ts:304</a></li>
231+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L295">classes.ts:295</a></li>
232232
</ul>
233233
</aside>
234234
<div class="tsd-comment tsd-typography">
@@ -244,7 +244,7 @@ <h3>value</h3>
244244
<aside class="tsd-sources">
245245
<p>Inherited from <a href="_classes_.genericclass.html">GenericClass</a>.<a href="_classes_.genericclass.html#value">value</a></p>
246246
<ul>
247-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L292">classes.ts:292</a></li>
247+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L284">classes.ts:284</a></li>
248248
</ul>
249249
</aside>
250250
</section>
@@ -262,7 +262,7 @@ <h3>get<wbr>Value</h3>
262262
<aside class="tsd-sources">
263263
<p>Inherited from <a href="_classes_.genericclass.html">GenericClass</a>.<a href="_classes_.genericclass.html#getvalue">getValue</a></p>
264264
<ul>
265-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L316">classes.ts:316</a></li>
265+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L305">classes.ts:305</a></li>
266266
</ul>
267267
</aside>
268268
<h4 class="tsd-returns-title">Returns <a href="_classes_.subclassb.html" class="tsd-signature-type">SubClassB</a></h4>
@@ -280,7 +280,7 @@ <h3>set<wbr>Value</h3>
280280
<aside class="tsd-sources">
281281
<p>Inherited from <a href="_classes_.genericclass.html">GenericClass</a>.<a href="_classes_.genericclass.html#setvalue">setValue</a></p>
282282
<ul>
283-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L311">classes.ts:311</a></li>
283+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L301">classes.ts:301</a></li>
284284
</ul>
285285
</aside>
286286
<div class="tsd-comment tsd-typography">

‎src/test/renderer/specs/classes/_classes_.subclassa.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ <h3>name</h3>
211211
<p>Implementation of <a href="../interfaces/_classes_.iprintnameinterface.html">IPrintNameInterface</a>.<a href="../interfaces/_classes_.iprintnameinterface.html#name">name</a></p>
212212
<p>Overrides <a href="_classes_.baseclass.html">BaseClass</a>.<a href="_classes_.baseclass.html#name">name</a></p>
213213
<ul>
214-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L201">classes.ts:201</a></li>
214+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L199">classes.ts:199</a></li>
215215
</ul>
216216
</aside>
217217
</section>
@@ -257,7 +257,7 @@ <h3>name<wbr>Property</h3>
257257
<li class="tsd-description">
258258
<aside class="tsd-sources">
259259
<ul>
260-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L222">classes.ts:222</a></li>
260+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L218">classes.ts:218</a></li>
261261
</ul>
262262
</aside>
263263
<div class="tsd-comment tsd-typography">
@@ -271,7 +271,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
271271
<li class="tsd-description">
272272
<aside class="tsd-sources">
273273
<ul>
274-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L232">classes.ts:232</a></li>
274+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L228">classes.ts:228</a></li>
275275
</ul>
276276
</aside>
277277
<div class="tsd-comment tsd-typography">
@@ -305,7 +305,7 @@ <h3>read<wbr>Only<wbr>Name<wbr>Property</h3>
305305
<li class="tsd-description">
306306
<aside class="tsd-sources">
307307
<ul>
308-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L242">classes.ts:242</a></li>
308+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L237">classes.ts:237</a></li>
309309
</ul>
310310
</aside>
311311
<div class="tsd-comment tsd-typography">
@@ -328,7 +328,7 @@ <h3>write<wbr>Only<wbr>Name<wbr>Property</h3>
328328
<li class="tsd-description">
329329
<aside class="tsd-sources">
330330
<ul>
331-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L253">classes.ts:253</a></li>
331+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L247">classes.ts:247</a></li>
332332
</ul>
333333
</aside>
334334
<div class="tsd-comment tsd-typography">
@@ -366,7 +366,7 @@ <h3>abstract<wbr>Method</h3>
366366
<aside class="tsd-sources">
367367
<p>Overrides <a href="_classes_.baseclass.html">BaseClass</a>.<a href="_classes_.baseclass.html#abstractmethod">abstractMethod</a></p>
368368
<ul>
369-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L257">classes.ts:257</a></li>
369+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L251">classes.ts:251</a></li>
370370
</ul>
371371
</aside>
372372
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -453,7 +453,7 @@ <h3>print</h3>
453453
<aside class="tsd-sources">
454454
<p>Implementation of <a href="../interfaces/_classes_.iprintnameinterface.html">IPrintNameInterface</a>.<a href="../interfaces/_classes_.iprintnameinterface.html#print">print</a></p>
455455
<ul>
456-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L206">classes.ts:206</a></li>
456+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L204">classes.ts:204</a></li>
457457
</ul>
458458
</aside>
459459
<div class="tsd-comment tsd-typography">
@@ -482,7 +482,7 @@ <h3>print<wbr>Name</h3>
482482
<aside class="tsd-sources">
483483
<p>Implementation of <a href="../interfaces/_classes_.iprintnameinterface.html">IPrintNameInterface</a>.<a href="../interfaces/_classes_.iprintnameinterface.html#printname">printName</a></p>
484484
<ul>
485-
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L212">classes.ts:212</a></li>
485+
<li>Defined in <a href="https://github.com/sebastian-lenz/typedoc/blob/master/examples/basic/src/classes.ts#L209">classes.ts:209</a></li>
486486
</ul>
487487
</aside>
488488
<div class="tsd-comment tsd-typography">

0 commit comments

Comments
 (0)