@progress/kendo-typescript-api-tasks 1.1.2-dev.3 → 1.1.2-dev.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/index.js +14 -5
  2. package/lib/class-page.js +2 -2
  3. package/lib/comment.js +16 -11
  4. package/lib/component-page.js +4 -4
  5. package/lib/generator.js +14 -10
  6. package/lib/is-constructor.js +2 -1
  7. package/lib/is-method.js +2 -1
  8. package/lib/map-constructors.js +9 -10
  9. package/lib/map-methods.js +4 -6
  10. package/lib/map-props.js +10 -9
  11. package/lib/plugins/decorators.js +43 -0
  12. package/lib/react/component-page.js +2 -2
  13. package/lib/return-type.js +11 -11
  14. package/lib/source.js +7 -0
  15. package/lib/type-utils.js +7 -6
  16. package/lib/warn.js +3 -8
  17. package/package.json +6 -5
  18. package/test/api.js +22 -15
  19. package/test/class.json +29 -9
  20. package/test/components-def.json +56 -16
  21. package/test/events-def.json +39 -8
  22. package/test/fields-def.json +62 -12
  23. package/test/fn-def.json +41 -10
  24. package/test/fn.json +62 -13
  25. package/test/inputs-def.json +27 -3
  26. package/test/interface-comments.json +84 -23
  27. package/test/intersection.json +1 -1
  28. package/test/package.json +7 -6
  29. package/test/warning.js +27 -9
package/test/api.js CHANGED
@@ -64,7 +64,7 @@ describe('API generation', () => {
64
64
  it('sets slugs for linking parameter types', () => {
65
65
  const ctr = members[1].children[0];
66
66
  const param = ctr.signatures[0].parameters[0];
67
- expect(param.type.typeSlug).toEqual('api_package-name_module1_foo');
67
+ expect(param.type.slug).toEqual('api_package-name_module1_foo');
68
68
  });
69
69
  });
70
70
 
@@ -107,7 +107,7 @@ describe('API generation', () => {
107
107
  });
108
108
 
109
109
  it('adds methods', () => {
110
- const pageContent = `## Methods\n\n<table class="api-table api-table-methods">\n<thead class="api-table-methods-head">\n<tr>\n<th>\n\n\n#### get\n\n\n</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td>\n\n\nGets the value of the specified option.\n\n\n</td>\n</tr>\n\n<tr class="nested-table">\n<td>\n<table class="api-table api-table-returns">\n<thead class="api-table-returns-head">\n<tr>\n<th class="th-type">Returns</th>\n<th class="th-desc"></th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td type>\n\n\n<code>\n\n\nany\n\n\n</code>\n\n\n</td>\n<td>\n\n\nThe current option value.\n\n\n</td>\n</tr>\n</tbody>\n</table>\n</td>\n</tr>\n</tbody>\n</table>`;
110
+ const pageContent = `## Methods\n\n<table class="api-table api-table-methods">\n<thead class="api-table-methods-head">\n<tr>\n<th>\n\n\n#### get\n\n\n</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td>\n\n\nGets the value of the specified option.\n\n\n\n\n\n</td>\n</tr>\n\n<tr class="nested-table">\n<td>\n<table class="api-table api-table-returns">\n<thead class="api-table-returns-head">\n<tr>\n<th class="th-type">Returns</th>\n<th class="th-desc"></th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td type>\n\n\n<code>\n\n\nany\n\n\n</code>\n\n\n</td>\n<td>\n\n\nThe current option value.\n\n\n</td>\n</tr>\n</tbody>\n</table>\n</td>\n</tr>\n</tbody>\n</table>`;
111
111
  expect(page).toContain(pageContent);
112
112
  });
113
113
 
@@ -121,10 +121,15 @@ describe('API generation', () => {
121
121
  "isPublic": true
122
122
  },
123
123
  "comment": {
124
- "tags": [
124
+ "blockTags": [
125
125
  {
126
- "tag": "default",
127
- "text": "42\n"
126
+ "tag": "@default",
127
+ "content": [
128
+ {
129
+ "kind": "text",
130
+ "text": "42\n"
131
+ }
132
+ ]
128
133
  }
129
134
  ]
130
135
  }
@@ -203,10 +208,15 @@ describe('API generation', () => {
203
208
  "isPublic": true
204
209
  },
205
210
  "comment": {
206
- "tags": [
211
+ "blockTags": [
207
212
  {
208
- "tag": "default",
209
- "text": "42\n"
213
+ "tag": "@default",
214
+ "content": [
215
+ {
216
+ "kind": "text",
217
+ "text": "42\n"
218
+ }
219
+ ]
210
220
  }
211
221
  ]
212
222
  }
@@ -224,23 +234,20 @@ describe('API generation', () => {
224
234
  const fieldsData = require('./fields-def.json');
225
235
 
226
236
  it('does not render fields without comment', () => {
227
-
228
237
  const page = componentPage(fieldsData.withoutComment, packageInfo);
229
238
 
230
239
  expect(page).not.toContain('Fields');
231
240
  });
232
241
 
233
242
  it('render fields without decorators, but with comment', () => {
234
-
235
243
  const page = componentPage(fieldsData.withComment, packageInfo);
236
- const pageContent = `## Fields\n\n<table class="api-table api-table-fields">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### bar\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nQueryList&lt;string&gt;\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n\n\n</td>\n<td class="table-cell-comment">\n\n\nsome comment\n\nlong text\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
244
+ const pageContent = `## Fields\n\n<table class="api-table api-table-fields">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### bar\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nQueryList&lt;string&gt;\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n\n\n</td>\n<td class="table-cell-comment">\n\n\nsome comment\nlong text\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
237
245
  expect(page).toContain(pageContent);
238
246
  });
239
247
 
240
248
  it('render fields with decorators and comment', () => {
241
-
242
249
  const page = componentPage(fieldsData.withCommentAndDecorator, packageInfo);
243
- const pageContent = `## Fields\n\n<table class="api-table api-table-fields">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### bar\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nQueryList&lt;string&gt;\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n\n\n</td>\n<td class="table-cell-comment">\n\n\nsome comment\n\nlong text\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
250
+ const pageContent = `## Fields\n\n<table class="api-table api-table-fields">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### bar\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nQueryList&lt;string&gt;\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n\n\n</td>\n<td class="table-cell-comment">\n\n\nsome comment\nlong text\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
244
251
  expect(page).toContain(pageContent);
245
252
  });
246
253
  });
@@ -251,14 +258,14 @@ describe('API generation', () => {
251
258
  it('render inputs name and type', () => {
252
259
 
253
260
  const page = componentPage(inputsData.withoutNameMapping, packageInfo);
254
- const pageContent = `## Inputs\n\n<table class="api-table api-table-inputs">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### bar\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nboolean\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n\n\n</td>\n<td class="table-cell-comment">\n\n\n\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
261
+ const pageContent = `## Inputs\n\n<table class="api-table api-table-inputs">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### bar\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nboolean\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n<code>\n\n\nfalse\n\n\n</code>\n\n\n</td>\n<td class="table-cell-comment">\n\n\n\n\n\n\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
255
262
  expect(page).toContain(pageContent);
256
263
  });
257
264
 
258
265
  it('render fields with mapped name', () => {
259
266
 
260
267
  const page = componentPage(inputsData.withNameMapping, packageInfo);
261
- const pageContent = `## Inputs\n\n<table class="api-table api-table-inputs">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### foo\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nboolean\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n\n\n</td>\n<td class="table-cell-comment">\n\n\n\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
268
+ const pageContent = `## Inputs\n\n<table class="api-table api-table-inputs">\n<thead>\n<tr>\n<th class="th-name">Name</th>\n<th class="th-type">Type</th>\n<th class="th-default">Default</th>\n<th class="th-desc">Description</th>\n</tr>\n</thead>\n<tbody class="api-table-body">\n<tr>\n<td class="table-cell-name">\n\n\n#### foo\n\n\n</td>\n<td type class="table-cell-type">\n\n\n<code>\n\n\nboolean\n\n\n</code>\n\n\n</td>\n<td class="table-cell-default">\n\n\n<code>\n\n\nfalse\n\n\n</code>\n\n\n</td>\n<td class="table-cell-comment">\n\n\n\n\n\n\n\n\n</td>\n</tr>\n</tbody>\n</table>`;
262
269
  expect(page).toContain(pageContent);
263
270
  });
264
271
  });
package/test/class.json CHANGED
@@ -1,19 +1,19 @@
1
1
  {
2
2
  "name": "Shape",
3
- "kindString": "Class",
3
+ "kind": 128,
4
4
  "comment": {
5
5
  "shortText": "Represents a drawing element that can be filled and stroked"
6
6
  },
7
7
  "typeParameter": [
8
8
  {
9
9
  "name": "T",
10
- "kindString": "Type parameter"
10
+ "kind": 131072
11
11
  }
12
12
  ],
13
13
  "children": [
14
14
  {
15
15
  "name": "constructor",
16
- "kindString": "Constructor",
16
+ "kind": 512,
17
17
  "flags": {
18
18
  "isExported": true
19
19
  },
@@ -27,12 +27,17 @@
27
27
  "parameters": [
28
28
  {
29
29
  "name": "options",
30
- "kindString": "Parameter",
30
+ "kind": 32768,
31
31
  "flags": {
32
32
  "isOptional": true
33
33
  },
34
34
  "comment": {
35
- "shortText": "The initial values of all options.\n"
35
+ "summary": [
36
+ {
37
+ "kind": "text",
38
+ "text": "The initial values of all options.\n"
39
+ }
40
+ ]
36
41
  },
37
42
  "type": {
38
43
  "type": "instrinct",
@@ -49,18 +54,33 @@
49
54
  },
50
55
  {
51
56
  "name": "get",
52
- "kindString": "Method",
57
+ "kind": 2048,
53
58
  "flags": {
54
59
  "isExported": true
55
60
  },
56
61
  "signatures": [
57
62
  {
58
63
  "name": "get",
59
- "kindString": "Call signature",
64
+ "kind": 4096,
60
65
  "flags": {},
61
66
  "comment": {
62
- "shortText": "Gets the value of the specified option.",
63
- "returns": "The current option value."
67
+ "summary": [
68
+ {
69
+ "kind": "text",
70
+ "text": "Gets the value of the specified option."
71
+ }
72
+ ],
73
+ "blockTags": [
74
+ {
75
+ "tag": "@returns",
76
+ "content": [
77
+ {
78
+ "kind": "text",
79
+ "text": "The current option value."
80
+ }
81
+ ]
82
+ }
83
+ ]
64
84
  },
65
85
  "type": {
66
86
  "type": "instrinct",
package/test/components-def.json CHANGED
@@ -2,11 +2,21 @@
2
2
  "directive": {
3
3
  "name": "MyDirective",
4
4
  "comment": {
5
- "shortText": "Represents the Kendo UI Grid component for Angular.",
6
- "tags": [
5
+ "summary": [
7
6
  {
8
- "tag": "example",
9
- "text": "\n```ts-preview\n@@Component({\n selector: 'my-app',\n template: `\n <kendo-grid [data]=\"gridData\">\n </kendo-grid>\n `\n})\nclass AppComponent {\n private gridData: any[] = products;\n}\n\nconst products = [{\n \"ProductID\": 1,\n \"ProductName\": \"Chai\",\n \"UnitPrice\": 18.0000,\n \"Discontinued\": true\n }, {\n \"ProductID\": 2,\n \"ProductName\": \"Chang\",\n \"UnitPrice\": 19.0000,\n \"Discontinued\": false\n }\n];\n```\n"
7
+ "kind": "text",
8
+ "text": "Represents the Kendo UI Grid component for Angular."
9
+ }
10
+ ],
11
+ "blockTags": [
12
+ {
13
+ "tag": "@example",
14
+ "content": [
15
+ {
16
+ "kind": "code",
17
+ "text": "\n```ts-preview\n@@Component({\n selector: 'my-app',\n template: `\n <kendo-grid [data]=\"gridData\">\n </kendo-grid>\n `\n})\nclass AppComponent {\n private gridData: any[] = products;\n}\n\nconst products = [{\n \"ProductID\": 1,\n \"ProductName\": \"Chai\",\n \"UnitPrice\": 18.0000,\n \"Discontinued\": true\n }, {\n \"ProductID\": 2,\n \"ProductName\": \"Chang\",\n \"UnitPrice\": 19.0000,\n \"Discontinued\": false\n }\n];\n```\n"
18
+ }
19
+ ]
10
20
  }
11
21
  ]
12
22
  },
@@ -26,11 +36,21 @@
26
36
  "exportedDirective": {
27
37
  "name": "ExportedDirective",
28
38
  "comment": {
29
- "shortText": "Represents the Kendo UI Grid component for Angular.",
30
- "tags": [
39
+ "summary": [
40
+ {
41
+ "kind": "text",
42
+ "text": "Represents the Kendo UI Grid component for Angular."
43
+ }
44
+ ],
45
+ "blockTags": [
31
46
  {
32
- "tag": "example",
33
- "text": "\n```ts-preview\n@@Component({\n selector: 'my-app',\n template: `\n <kendo-grid [data]=\"gridData\">\n </kendo-grid>\n `\n})\nclass AppComponent {\n private gridData: any[] = products;\n}\n\nconst products = [{\n \"ProductID\": 1,\n \"ProductName\": \"Chai\",\n \"UnitPrice\": 18.0000,\n \"Discontinued\": true\n }, {\n \"ProductID\": 2,\n \"ProductName\": \"Chang\",\n \"UnitPrice\": 19.0000,\n \"Discontinued\": false\n }\n];\n```\n"
47
+ "tag": "@example",
48
+ "content": [
49
+ {
50
+ "kind": "code",
51
+ "text": "\n```ts-preview\n@@Component({\n selector: 'my-app',\n template: `\n <kendo-grid [data]=\"gridData\">\n </kendo-grid>\n `\n})\nclass AppComponent {\n private gridData: any[] = products;\n}\n\nconst products = [{\n \"ProductID\": 1,\n \"ProductName\": \"Chai\",\n \"UnitPrice\": 18.0000,\n \"Discontinued\": true\n }, {\n \"ProductID\": 2,\n \"ProductName\": \"Chang\",\n \"UnitPrice\": 19.0000,\n \"Discontinued\": false\n }\n];\n```\n"
52
+ }
53
+ ]
34
54
  }
35
55
  ]
36
56
  },
@@ -50,11 +70,21 @@
50
70
  "component": {
51
71
  "name": "MyComponent",
52
72
  "comment": {
53
- "shortText": "Represents the Kendo UI Grid component for Angular.",
54
- "tags": [
73
+ "summary": [
55
74
  {
56
- "tag": "example",
57
- "text": "\n```ts-preview\n@@Component({\n selector: 'my-app',\n template: `\n <kendo-grid [data]=\"gridData\">\n </kendo-grid>\n `\n})\nclass AppComponent {\n private gridData: any[] = products;\n}\n\nconst products = [{\n \"ProductID\": 1,\n \"ProductName\": \"Chai\",\n \"UnitPrice\": 18.0000,\n \"Discontinued\": true\n }, {\n \"ProductID\": 2,\n \"ProductName\": \"Chang\",\n \"UnitPrice\": 19.0000,\n \"Discontinued\": false\n }\n];\n```\n"
75
+ "kind": "text",
76
+ "text": "Represents the Kendo UI Grid component for Angular."
77
+ }
78
+ ],
79
+ "blockTags": [
80
+ {
81
+ "tag": "@example",
82
+ "content": [
83
+ {
84
+ "kind": "code",
85
+ "text": "\n```ts-preview\n@@Component({\n selector: 'my-app',\n template: `\n <kendo-grid [data]=\"gridData\">\n </kendo-grid>\n `\n})\nclass AppComponent {\n private gridData: any[] = products;\n}\n\nconst products = [{\n \"ProductID\": 1,\n \"ProductName\": \"Chai\",\n \"UnitPrice\": 18.0000,\n \"Discontinued\": true\n }, {\n \"ProductID\": 2,\n \"ProductName\": \"Chang\",\n \"UnitPrice\": 19.0000,\n \"Discontinued\": false\n }\n];\n```\n"
86
+ }
87
+ ]
58
88
  }
59
89
  ]
60
90
  },
@@ -74,11 +104,21 @@
74
104
  "exportedComponent": {
75
105
  "name": "ExportedComponent",
76
106
  "comment": {
77
- "shortText": "Represents the Kendo UI Grid component for Angular.",
78
- "tags": [
107
+ "summary": [
108
+ {
109
+ "kind": "text",
110
+ "text": "Represents the Kendo UI Grid component for Angular."
111
+ }
112
+ ],
113
+ "blockTags": [
79
114
  {
80
- "tag": "example",
81
- "text": "\n```ts-preview\n@@Component({\n selector: 'my-app',\n template: `\n <kendo-grid [data]=\"gridData\">\n </kendo-grid>\n `\n})\nclass AppComponent {\n private gridData: any[] = products;\n}\n\nconst products = [{\n \"ProductID\": 1,\n \"ProductName\": \"Chai\",\n \"UnitPrice\": 18.0000,\n \"Discontinued\": true\n }, {\n \"ProductID\": 2,\n \"ProductName\": \"Chang\",\n \"UnitPrice\": 19.0000,\n \"Discontinued\": false\n }\n];\n```\n"
115
+ "tag": "@example",
116
+ "content": [
117
+ {
118
+ "kind": "code",
119
+ "text": "\n```ts-preview\n@@Component({\n selector: 'my-app',\n template: `\n <kendo-grid [data]=\"gridData\">\n </kendo-grid>\n `\n})\nclass AppComponent {\n private gridData: any[] = products;\n}\n\nconst products = [{\n \"ProductID\": 1,\n \"ProductName\": \"Chai\",\n \"UnitPrice\": 18.0000,\n \"Discontinued\": true\n }, {\n \"ProductID\": 2,\n \"ProductName\": \"Chang\",\n \"UnitPrice\": 19.0000,\n \"Discontinued\": false\n }\n];\n```\n"
120
+ }
121
+ ]
82
122
  }
83
123
  ]
84
124
  },
package/test/events-def.json CHANGED
@@ -5,8 +5,16 @@
5
5
  "isExported": true
6
6
  },
7
7
  "comment": {
8
- "shortText": "Short text",
9
- "text": "Long text"
8
+ "summary": [
9
+ {
10
+ "kind": "text",
11
+ "text": "Short text"
12
+ },
13
+ {
14
+ "kind": "text",
15
+ "text": "Long text"
16
+ }
17
+ ]
10
18
  },
11
19
  "decorators": [
12
20
  {
@@ -29,7 +37,12 @@
29
37
  "isPublic": true
30
38
  },
31
39
  "comment": {
32
- "shortText": "Fires each time the user selects a new value."
40
+ "summary": [
41
+ {
42
+ "kind": "text",
43
+ "text": "Fires each time the user selects a new value."
44
+ }
45
+ ]
33
46
  },
34
47
  "decorators": [
35
48
  {
@@ -85,7 +98,12 @@
85
98
  "isPublic": true
86
99
  },
87
100
  "comment": {
88
- "shortText": "Fires each time the user focuses the input element."
101
+ "summary": [
102
+ {
103
+ "kind": "text",
104
+ "text": "Fires each time the user focuses the input element."
105
+ }
106
+ ]
89
107
  },
90
108
  "decorators": [
91
109
  {
@@ -95,7 +113,7 @@
95
113
  "name": "Output"
96
114
  },
97
115
  "arguments": {
98
- "bindingPropertyName": "'focus'"
116
+ "obj": "'focus'"
99
117
  }
100
118
  }
101
119
  ],
@@ -120,8 +138,16 @@
120
138
  "isExported": true
121
139
  },
122
140
  "comment": {
123
- "shortText": "Short text",
124
- "text": "Long text"
141
+ "summary": [
142
+ {
143
+ "kind": "text",
144
+ "text": "Short text"
145
+ },
146
+ {
147
+ "kind": "text",
148
+ "text": "Long text"
149
+ }
150
+ ]
125
151
  },
126
152
  "decorators": [
127
153
  {
@@ -144,7 +170,12 @@
144
170
  "isPublic": true
145
171
  },
146
172
  "comment": {
147
- "shortText": "Fires each time the user selects a new value."
173
+ "summary": [
174
+ {
175
+ "kind": "text",
176
+ "text": "Fires each time the user selects a new value."
177
+ }
178
+ ]
148
179
  },
149
180
  "type": {
150
181
  "type": "reference",
package/test/fields-def.json CHANGED
@@ -1,12 +1,22 @@
1
1
  {
2
2
  "withoutComment": {
3
3
  "name": "AddCommandDirective",
4
+ "variant": "declaration",
5
+ "kind": 128,
4
6
  "flags": {
5
7
  "isExported": true
6
8
  },
7
9
  "comment": {
8
- "shortText": "Short text",
9
- "text": "Long text"
10
+ "summary": [
11
+ {
12
+ "kind": "text",
13
+ "text": "Short text\n"
14
+ },
15
+ {
16
+ "kind": "text",
17
+ "text": "Long text"
18
+ }
19
+ ]
10
20
  },
11
21
  "decorators": [
12
22
  {
@@ -50,8 +60,16 @@
50
60
  "isExported": true
51
61
  },
52
62
  "comment": {
53
- "shortText": "Short text",
54
- "text": "Long text"
63
+ "summary": [
64
+ {
65
+ "kind": "text",
66
+ "text": "Short text\n"
67
+ },
68
+ {
69
+ "kind": "text",
70
+ "text": "Long text"
71
+ }
72
+ ]
55
73
  },
56
74
  "decorators": [
57
75
  {
@@ -74,8 +92,16 @@
74
92
  "isPublic": true
75
93
  },
76
94
  "comment": {
77
- "shortText": "some comment",
78
- "text": "long text"
95
+ "summary": [
96
+ {
97
+ "kind": "text",
98
+ "text": "some comment\n"
99
+ },
100
+ {
101
+ "kind": "text",
102
+ "text": "long text"
103
+ }
104
+ ]
79
105
  },
80
106
  "type": {
81
107
  "type": "reference",
@@ -98,8 +124,16 @@
98
124
  "isExported": true
99
125
  },
100
126
  "comment": {
101
- "shortText": "Short text",
102
- "text": "Long text"
127
+ "summary": [
128
+ {
129
+ "kind": "text",
130
+ "text": "Short text\n"
131
+ },
132
+ {
133
+ "kind": "text",
134
+ "text": "Long text"
135
+ }
136
+ ]
103
137
  },
104
138
  "decorators": [
105
139
  {
@@ -122,8 +156,16 @@
122
156
  "isPublic": true
123
157
  },
124
158
  "comment": {
125
- "shortText": "some comment",
126
- "text": "long text"
159
+ "summary": [
160
+ {
161
+ "kind": "text",
162
+ "text": "some comment\n"
163
+ },
164
+ {
165
+ "kind": "text",
166
+ "text": "long text"
167
+ }
168
+ ]
127
169
  },
128
170
  "decorators": [
129
171
  {
@@ -157,8 +199,16 @@
157
199
  "isExported": true
158
200
  },
159
201
  "comment": {
160
- "shortText": "Short text",
161
- "text": "Long text"
202
+ "summary": [
203
+ {
204
+ "kind": "text",
205
+ "text": "Short text\n"
206
+ },
207
+ {
208
+ "kind": "text",
209
+ "text": "Long text"
210
+ }
211
+ ]
162
212
  },
163
213
  "decorators": [
164
214
  {
package/test/fn-def.json CHANGED
@@ -14,13 +14,34 @@
14
14
  "kindString": "Call signature",
15
15
  "flags": {},
16
16
  "comment": {
17
- "shortText": "SIG_DESC",
18
- "text": "SIG_TEXT",
19
- "returns": "SIG_RETURNS",
20
- "tags": [
17
+ "summary": [
21
18
  {
22
- "tag": "example",
23
- "text": "SIG_EXAMPLE"
19
+ "kind": "text",
20
+ "text": "SIG_DESC"
21
+ },
22
+ {
23
+ "kind": "text",
24
+ "text": "SIG_TEXT"
25
+ }
26
+ ],
27
+ "blockTags": [
28
+ {
29
+ "tag": "@returns",
30
+ "content": [
31
+ {
32
+ "kind": "code",
33
+ "text": "SIG_RETURN"
34
+ }
35
+ ]
36
+ },
37
+ {
38
+ "tag": "@example",
39
+ "content": [
40
+ {
41
+ "kind": "code",
42
+ "text": "SIG_EXAMPLE"
43
+ }
44
+ ]
24
45
  }
25
46
  ]
26
47
  },
@@ -38,13 +59,18 @@
38
59
  "kindString": "Parameter",
39
60
  "flags": {},
40
61
  "comment": {
41
- "text": "PARAM1_DESC"
62
+ "summary": [
63
+ {
64
+ "kind": "text",
65
+ "text": "PARAM1_DESC"
66
+ }
67
+ ]
42
68
  },
43
69
  "type": {
44
70
  "type": "reference",
45
71
  "isArray": true,
46
72
  "name": "PARAM1_TYPE",
47
- "id": 795
73
+ "target": 795
48
74
  }
49
75
  },
50
76
  {
@@ -54,12 +80,17 @@
54
80
  "kindString": "Parameter",
55
81
  "flags": {},
56
82
  "comment": {
57
- "text": "PARAM2_DESC"
83
+ "summary": [
84
+ {
85
+ "kind": "text",
86
+ "text": "PARAM1_DESC"
87
+ }
88
+ ]
58
89
  },
59
90
  "type": {
60
91
  "type": "reference",
61
92
  "name": "PARAM2_TYPE",
62
- "id": 254
93
+ "target": 254
63
94
  }
64
95
  }
65
96
  ],