Skip to content

Commit 37e3d66

Browse files
Vitalius1Vitalius1
committed
Feedback
1 parent c0234fc commit 37e3d66

6 files changed

Lines changed: 30 additions & 30 deletions

File tree

‎build-tests/api-documenter-test/etc/api-documenter-test.api.json‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1205,12 +1205,12 @@
12051205
"members": [
12061206
{
12071207
"kind": "PropertySignature",
1208-
"canonicalReference": "string",
1209-
"docComment": "/**\n * string property\n */\n",
1208+
"canonicalReference": "regularProperty",
1209+
"docComment": "/**\n * Property of type string that does something\n */\n",
12101210
"excerptTokens": [
12111211
{
12121212
"kind": "Reference",
1213-
"text": "string"
1213+
"text": "regularProperty"
12141214
},
12151215
{
12161216
"kind": "Content",
@@ -1226,7 +1226,7 @@
12261226
}
12271227
],
12281228
"releaseTag": "Public",
1229-
"name": "string",
1229+
"name": "regularProperty",
12301230
"propertyTypeTokenRange": {
12311231
"startIndex": 2,
12321232
"endIndex": 3
@@ -1238,7 +1238,7 @@
12381238
{
12391239
"kind": "Interface",
12401240
"canonicalReference": "(IDocInterface6:interface)",
1241-
"docComment": "/**\n * Interface without inline tag to test custom TOC\n *\n * @public\n */\n",
1241+
"docComment": "/**\n * Interface without inline tag to test custom TOC with injection\n *\n * @public\n */\n",
12421242
"excerptTokens": [
12431243
{
12441244
"kind": "Content",
@@ -1258,12 +1258,12 @@
12581258
"members": [
12591259
{
12601260
"kind": "PropertySignature",
1261-
"canonicalReference": "number",
1262-
"docComment": "/**\n * number property\n */\n",
1261+
"canonicalReference": "regularProperty",
1262+
"docComment": "/**\n * Property of type number that does something\n */\n",
12631263
"excerptTokens": [
12641264
{
12651265
"kind": "Reference",
1266-
"text": "number"
1266+
"text": "regularProperty"
12671267
},
12681268
{
12691269
"kind": "Content",
@@ -1279,7 +1279,7 @@
12791279
}
12801280
],
12811281
"releaseTag": "Public",
1282-
"name": "number",
1282+
"name": "regularProperty",
12831283
"propertyTypeTokenRange": {
12841284
"startIndex": 2,
12851285
"endIndex": 3

‎build-tests/api-documenter-test/etc/api-documenter-test.api.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,12 @@ export interface IDocInterface4 {
7878

7979
// @public
8080
export interface IDocInterface5 {
81-
string: string;
81+
regularProperty: string;
8282
}
8383

8484
// @public
8585
export interface IDocInterface6 {
86-
number: number;
86+
regularProperty: number;
8787
}
8888

8989
// @public

‎build-tests/api-documenter-test/etc/yaml/api-documenter-test/idocinterface5.yml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,16 @@ items:
99
type: interface
1010
package: api-documenter-test
1111
children:
12-
- api-documenter-test.IDocInterface5.string
13-
- uid: api-documenter-test.IDocInterface5.string
14-
summary: string property
15-
name: string
16-
fullName: string
12+
- api-documenter-test.IDocInterface5.regularProperty
13+
- uid: api-documenter-test.IDocInterface5.regularProperty
14+
summary: Property of type string that does something
15+
name: regularProperty
16+
fullName: regularProperty
1717
langs:
1818
- typeScript
1919
type: property
2020
syntax:
21-
content: 'string: string;'
21+
content: 'regularProperty: string;'
2222
return:
2323
type:
2424
- string

‎build-tests/api-documenter-test/etc/yaml/api-documenter-test/idocinterface6.yml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
### YamlMime:UniversalReference
22
items:
33
- uid: api-documenter-test.IDocInterface6
4-
summary: Interface without inline tag to test custom TOC
4+
summary: Interface without inline tag to test custom TOC with injection
55
name: IDocInterface6
66
fullName: IDocInterface6
77
langs:
88
- typeScript
99
type: interface
1010
package: api-documenter-test
1111
children:
12-
- api-documenter-test.IDocInterface6.number
13-
- uid: api-documenter-test.IDocInterface6.number
14-
summary: number property
15-
name: number
16-
fullName: number
12+
- api-documenter-test.IDocInterface6.regularProperty
13+
- uid: api-documenter-test.IDocInterface6.regularProperty
14+
summary: Property of type number that does something
15+
name: regularProperty
16+
fullName: regularProperty
1717
langs:
1818
- typeScript
1919
type: property
2020
syntax:
21-
content: 'number: number;'
21+
content: 'regularProperty: number;'
2222
return:
2323
type:
2424
- number

‎build-tests/api-documenter-test/src/DocClass1.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -223,18 +223,18 @@ export class DocClass1 extends DocBaseClass implements IDocInterface1, IDocInter
223223
*/
224224
export interface IDocInterface5 {
225225
/**
226-
* string property
226+
* Property of type string that does something
227227
*/
228-
string: string;
228+
regularProperty: string;
229229
}
230230

231231
/**
232-
* Interface without inline tag to test custom TOC
232+
* Interface without inline tag to test custom TOC with injection
233233
* @public
234234
*/
235235
export interface IDocInterface6 {
236236
/**
237-
* number property
237+
* Property of type number that does something
238238
*/
239-
number: number;
239+
regularProperty: number;
240240
}

‎common/changes/@microsoft/api-documenter/vibraga-experimentalDocumenter_adjustments_2019-05-24-22-43.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"changes": [
33
{
44
"packageName": "@microsoft/api-documenter",
5-
"comment": "Add new `nonEmptyCategoryNodeNames` config option to the ExperimentalYamlDocumenter. Refactor filter logic. Add documentation and modify the test package.",
5+
"comment": "Improved the experimental api-documenter generate command.",
66
"type": "minor"
77
}
88
],

0 commit comments

Comments
 (0)