Skip to content

Commit 04b5380

Browse files
iclantoniclanton
committed
Merge branch 'master' into ianc/bump-cyclics
2 parents 1b6c0c5 + 0497bbb commit 04b5380

File tree

26 files changed

+310
-153
lines changed

26 files changed

+310
-153
lines changed

‎apps/api-documenter/CHANGELOG.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,26 @@
11
{
22
"name": "@microsoft/api-documenter",
33
"entries": [
4+
{
5+
"version": "7.0.21",
6+
"tag": "@microsoft/api-documenter_v7.0.21",
7+
"date": "Thu, 31 Jan 2019 17:03:49 GMT",
8+
"comments": {
9+
"patch": [
10+
{
11+
"comment": "Fix issue where docs were not generated for function parameters and return types (GitHub #1055)"
12+
},
13+
{
14+
"comment": "Upgrade to TSDoc 0.12.5"
15+
}
16+
],
17+
"dependency": [
18+
{
19+
"comment": "Updating dependency \"@microsoft/api-extractor\" from `7.0.13` to `7.0.14`"
20+
}
21+
]
22+
}
23+
},
424
{
525
"version": "7.0.20",
626
"tag": "@microsoft/api-documenter_v7.0.20",

‎apps/api-documenter/CHANGELOG.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# Change Log - @microsoft/api-documenter
22

3-
This log was last generated on Wed, 30 Jan 2019 20:49:11 GMT and should not be manually modified.
3+
This log was last generated on Thu, 31 Jan 2019 17:03:49 GMT and should not be manually modified.
4+
5+
## 7.0.21
6+
Thu, 31 Jan 2019 17:03:49 GMT
7+
8+
### Patches
9+
10+
- Fix issue where docs were not generated for function parameters and return types (GitHub #1055)
11+
- Upgrade to TSDoc 0.12.5
412

513
## 7.0.20
614
Wed, 30 Jan 2019 20:49:11 GMT

‎apps/api-documenter/package.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@microsoft/api-documenter",
3-
"version": "7.0.20",
3+
"version": "7.0.21",
44
"description": "Read JSON files from api-extractor, generate documentation pages",
55
"repository": {
66
"type": "git",
@@ -15,10 +15,10 @@
1515
"api-documenter": "./bin/api-documenter"
1616
},
1717
"dependencies": {
18-
"@microsoft/api-extractor": "7.0.13",
18+
"@microsoft/api-extractor": "7.0.14",
1919
"@microsoft/node-core-library": "3.9.0",
2020
"@microsoft/ts-command-line": "4.2.3",
21-
"@microsoft/tsdoc": "0.12.4",
21+
"@microsoft/tsdoc": "0.12.5",
2222
"colors": "~1.2.1",
2323
"js-yaml": "~3.9.1"
2424
},

‎apps/api-documenter/src/documenters/MarkdownDocumenter.ts‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,9 +184,8 @@ export class MarkdownDocumenter {
184184
break;
185185
case ApiItemKind.Method:
186186
case ApiItemKind.MethodSignature:
187-
this._writeParameterTables(output, apiItem as ApiParameterListMixin);
188-
break;
189187
case ApiItemKind.Function:
188+
this._writeParameterTables(output, apiItem as ApiParameterListMixin);
190189
break;
191190
case ApiItemKind.Namespace:
192191
this._writePackageOrNamespaceTables(output, apiItem as ApiNamespace);

‎apps/api-extractor/CHANGELOG.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,24 @@
11
{
22
"name": "@microsoft/api-extractor",
33
"entries": [
4+
{
5+
"version": "7.0.14",
6+
"tag": "@microsoft/api-extractor_v7.0.14",
7+
"date": "Thu, 31 Jan 2019 17:03:49 GMT",
8+
"comments": {
9+
"patch": [
10+
{
11+
"comment": "Upgrade to TSDoc 0.12.5, which allows `$` in `@param` names"
12+
},
13+
{
14+
"comment": "Add \"testMode\" option in api-extractor.json to eliminate spurious diffs in test files when the version number gets bumped"
15+
},
16+
{
17+
"comment": "Normalize newlines for excerpt strings in the .api.json file"
18+
}
19+
]
20+
}
21+
},
422
{
523
"version": "7.0.13",
624
"tag": "@microsoft/api-extractor_v7.0.13",

‎apps/api-extractor/CHANGELOG.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
# Change Log - @microsoft/api-extractor
22

3-
This log was last generated on Sat, 19 Jan 2019 03:47:47 GMT and should not be manually modified.
3+
This log was last generated on Thu, 31 Jan 2019 17:03:49 GMT and should not be manually modified.
4+
5+
## 7.0.14
6+
Thu, 31 Jan 2019 17:03:49 GMT
7+
8+
### Patches
9+
10+
- Upgrade to TSDoc 0.12.5, which allows `$` in `@param` names
11+
- Add "testMode" option in api-extractor.json to eliminate spurious diffs in test files when the version number gets bumped
12+
- Normalize newlines for excerpt strings in the .api.json file
413

514
## 7.0.13
615
Sat, 19 Jan 2019 03:47:47 GMT

‎apps/api-extractor/package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@microsoft/api-extractor",
3-
"version": "7.0.13",
3+
"version": "7.0.14",
44
"description": "Validate, document, and review the exported API for a TypeScript library",
55
"keywords": [
66
"typescript",
@@ -33,7 +33,7 @@
3333
"dependencies": {
3434
"@microsoft/node-core-library": "3.9.0",
3535
"@microsoft/ts-command-line": "4.2.3",
36-
"@microsoft/tsdoc": "0.12.4",
36+
"@microsoft/tsdoc": "0.12.5",
3737
"@types/node": "8.5.8",
3838
"@types/z-schema": "3.16.31",
3939
"colors": "~1.2.1",

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,14 @@ An exported function
99
```typescript
1010
export declare function globalFunction(x: number): number;
1111
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| x | `number` | |
18+
19+
<b>Returns:</b>
20+
21+
`number`
22+

‎build-tests/api-documenter-test/etc/markdown/api-documenter-test.outernamespace.innernamespace.nestedfunction.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,14 @@ A function inside a namespace
99
```typescript
1010
function nestedFunction(x: number): number;
1111
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| x | `number` | |
18+
19+
<b>Returns:</b>
20+
21+
`number`
22+

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
"build": "node build.js"
1010
},
1111
"dependencies": {
12-
"@microsoft/api-extractor": "7.0.13",
13-
"@microsoft/api-documenter": "7.0.20",
12+
"@microsoft/api-extractor": "7.0.14",
13+
"@microsoft/api-documenter": "7.0.21",
1414
"@types/jest": "23.3.11",
1515
"@types/node": "8.5.8",
1616
"fs-extra": "~7.0.1",

0 commit comments

Comments
 (0)