Skip to content

Commit 47dfd3c

Browse files
iclantoniclanton
committed
Merge from master.
2 parents e3c6f4d + 628ecb2 commit 47dfd3c

159 files changed

Lines changed: 3878 additions & 1195 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎apps/api-documenter/CHANGELOG.json‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,44 @@
11
{
22
"name": "@microsoft/api-documenter",
33
"entries": [
4+
{
5+
"version": "7.0.10",
6+
"tag": "@microsoft/api-documenter_v7.0.10",
7+
"date": "Thu, 20 Dec 2018 17:04:08 GMT",
8+
"comments": {
9+
"dependency": [
10+
{
11+
"comment": "Updating dependency \"@microsoft/api-extractor\" from `7.0.7` to `7.0.8`"
12+
}
13+
]
14+
}
15+
},
16+
{
17+
"version": "7.0.9",
18+
"tag": "@microsoft/api-documenter_v7.0.9",
19+
"date": "Wed, 19 Dec 2018 05:57:33 GMT",
20+
"comments": {
21+
"patch": [
22+
{
23+
"comment": "Update to work with refactored ApiModel classes"
24+
}
25+
],
26+
"dependency": [
27+
{
28+
"comment": "Updating dependency \"@microsoft/api-extractor\" from `7.0.6` to `7.0.7`"
29+
},
30+
{
31+
"comment": "Updating dependency \"@microsoft/node-core-library\" from `3.8.2` to `3.8.3`"
32+
},
33+
{
34+
"comment": "Updating dependency \"@microsoft/rush-stack-compiler-3.0\" from `0.3.2` to `0.3.3`"
35+
},
36+
{
37+
"comment": "Updating dependency \"@microsoft/node-library-build\" from `6.0.21` to `6.0.22`"
38+
}
39+
]
40+
}
41+
},
442
{
543
"version": "7.0.8",
644
"tag": "@microsoft/api-documenter_v7.0.8",

‎apps/api-documenter/CHANGELOG.md‎

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

3-
This log was last generated on Fri, 14 Dec 2018 19:43:46 GMT and should not be manually modified.
3+
This log was last generated on Thu, 20 Dec 2018 17:04:08 GMT and should not be manually modified.
4+
5+
## 7.0.10
6+
Thu, 20 Dec 2018 17:04:08 GMT
7+
8+
*Version update only*
9+
10+
## 7.0.9
11+
Wed, 19 Dec 2018 05:57:33 GMT
12+
13+
### Patches
14+
15+
- Update to work with refactored ApiModel classes
416

517
## 7.0.8
618
Fri, 14 Dec 2018 19:43:46 GMT

‎apps/api-documenter/package.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@microsoft/api-documenter",
3-
"version": "7.0.8",
3+
"version": "7.0.10",
44
"description": "Read JSON files from api-extractor, generate documentation pages",
55
"repository": {
66
"type": "git",
@@ -15,16 +15,16 @@
1515
"api-documenter": "./bin/api-documenter"
1616
},
1717
"dependencies": {
18-
"@microsoft/api-extractor": "7.0.6",
19-
"@microsoft/node-core-library": "3.8.2",
18+
"@microsoft/api-extractor": "7.0.8",
19+
"@microsoft/node-core-library": "3.8.3",
2020
"@microsoft/ts-command-line": "4.2.3",
2121
"@microsoft/tsdoc": "0.12.4",
2222
"colors": "~1.2.1",
2323
"js-yaml": "~3.9.1"
2424
},
2525
"devDependencies": {
26-
"@microsoft/rush-stack-compiler-3.0": "0.3.2",
27-
"@microsoft/node-library-build": "6.0.21",
26+
"@microsoft/rush-stack-compiler-3.0": "0.3.3",
27+
"@microsoft/node-library-build": "6.0.22",
2828
"@types/js-yaml": "3.9.1",
2929
"@types/node": "8.5.8",
3030
"gulp": "~3.9.1",

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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ import {
3333
ApiDocumentedItem,
3434
ApiClass,
3535
ReleaseTag,
36-
ApiDeclarationMixin,
3736
ApiStaticMixin,
3837
ApiPropertyItem,
39-
ApiFunctionLikeMixin,
4038
ApiInterface,
4139
Excerpt,
42-
ApiMethodItem
40+
ApiParameterListMixin,
41+
ApiReturnTypeMixin,
42+
ApiDeclaredItem
4343
} from '@microsoft/api-extractor';
4444

4545
import { CustomDocNodes } from '../nodes/CustomDocNodeKind';
@@ -106,7 +106,7 @@ export class MarkdownDocumenter {
106106
output.appendNode(new DocHeading({ configuration, title: `${scopedName} namespace` }));
107107
break;
108108
case ApiItemKind.Package:
109-
const unscopedPackageName: string = PackageName.getUnscopedName(apiItem.name);
109+
const unscopedPackageName: string = PackageName.getUnscopedName(apiItem.displayName);
110110
output.appendNode(new DocHeading({ configuration, title: `${unscopedPackageName} package` }));
111111
break;
112112
case ApiItemKind.Property:
@@ -148,7 +148,7 @@ export class MarkdownDocumenter {
148148
}
149149
}
150150

151-
if (ApiDeclarationMixin.isBaseClassOf(apiItem)) {
151+
if (apiItem instanceof ApiDeclaredItem) {
152152
if (apiItem.excerpt.text.length > 0) {
153153
output.appendNode(
154154
new DocParagraph({ configuration }, [
@@ -175,7 +175,7 @@ export class MarkdownDocumenter {
175175
break;
176176
case ApiItemKind.Method:
177177
case ApiItemKind.MethodSignature:
178-
this._writeFunctionLikeTables(output, apiItem as ApiFunctionLikeMixin);
178+
this._writeParameterTables(output, apiItem as ApiParameterListMixin);
179179
break;
180180
case ApiItemKind.Namespace:
181181
break;
@@ -515,14 +515,14 @@ export class MarkdownDocumenter {
515515
/**
516516
* GENERATE PAGE: FUNCTION-LIKE
517517
*/
518-
private _writeFunctionLikeTables(output: DocSection, apiFunctionLike: ApiFunctionLikeMixin): void {
518+
private _writeParameterTables(output: DocSection, apiParameterListMixin: ApiParameterListMixin): void {
519519
const configuration: TSDocConfiguration = this._tsdocConfiguration;
520520

521521
const parametersTable: DocTable = new DocTable({ configuration,
522522
headerTitles: [ 'Parameter', 'Type', 'Description' ]
523523
});
524524

525-
for (const apiParameter of apiFunctionLike.parameters) {
525+
for (const apiParameter of apiParameterListMixin.parameters) {
526526
const parameterDescription: DocSection = new DocSection({ configuration } );
527527
if (apiParameter.tsdocParamBlock) {
528528
this._appendSection(parameterDescription, apiParameter.tsdocParamBlock.content);
@@ -550,8 +550,8 @@ export class MarkdownDocumenter {
550550
output.appendNode(parametersTable);
551551
}
552552

553-
if (apiFunctionLike instanceof ApiMethodItem) {
554-
const returnTypeExcerpt: Excerpt = apiFunctionLike.returnTypeExcerpt;
553+
if (ApiReturnTypeMixin.isBaseClassOf(apiParameterListMixin)) {
554+
const returnTypeExcerpt: Excerpt = apiParameterListMixin.returnTypeExcerpt;
555555
output.appendNode(
556556
new DocParagraph({ configuration }, [
557557
new DocEmphasisSpan({ configuration, bold: true}, [
@@ -566,9 +566,9 @@ export class MarkdownDocumenter {
566566
])
567567
);
568568

569-
if (apiFunctionLike instanceof ApiDocumentedItem) {
570-
if (apiFunctionLike.tsdocComment && apiFunctionLike.tsdocComment.returnsBlock) {
571-
this._appendSection(output, apiFunctionLike.tsdocComment.returnsBlock.content);
569+
if (apiParameterListMixin instanceof ApiDocumentedItem) {
570+
if (apiParameterListMixin.tsdocComment && apiParameterListMixin.tsdocComment.returnsBlock) {
571+
this._appendSection(output, apiParameterListMixin.tsdocComment.returnsBlock.content);
572572
}
573573
}
574574
}
@@ -672,7 +672,7 @@ export class MarkdownDocumenter {
672672
new DocLinkTag({
673673
configuration: this._tsdocConfiguration,
674674
tagName: '@link',
675-
linkText: hierarchyItem.name,
675+
linkText: hierarchyItem.displayName,
676676
urlDestination: this._getLinkFilenameForApiItem(hierarchyItem)
677677
})
678678
]);
@@ -719,8 +719,8 @@ export class MarkdownDocumenter {
719719
let baseName: string = '';
720720
for (const hierarchyItem of apiItem.getHierarchy()) {
721721
// For overloaded methods, add a suffix such as "MyClass.myMethod_2".
722-
let qualifiedName: string = hierarchyItem.name;
723-
if (ApiFunctionLikeMixin.isBaseClassOf(hierarchyItem)) {
722+
let qualifiedName: string = hierarchyItem.displayName;
723+
if (ApiParameterListMixin.isBaseClassOf(hierarchyItem)) {
724724
if (hierarchyItem.overloadIndex > 0) {
725725
qualifiedName += `_${hierarchyItem.overloadIndex}`;
726726
}
@@ -731,7 +731,7 @@ export class MarkdownDocumenter {
731731
case ApiItemKind.EntryPoint:
732732
break;
733733
case ApiItemKind.Package:
734-
baseName = PackageName.getUnscopedName(hierarchyItem.name);
734+
baseName = PackageName.getUnscopedName(hierarchyItem.displayName);
735735
break;
736736
default:
737737
baseName += '.' + qualifiedName;

0 commit comments

Comments
 (0)