Skip to content

Commit de5a492

Browse files
committed
More feedback addressed
1 parent 6bbaa35 commit de5a492

File tree

5 files changed

+7
-8
lines changed

5 files changed

+7
-8
lines changed

apps/api-documenter/src/cli/GenerateAction.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import * as path from 'path';
66
import { ApiDocumenterCommandLine } from './ApiDocumenterCommandLine';
77
import { BaseAction } from './BaseAction';
88
import { DocumenterConfig } from '../documenters/DocumenterConfig';
9-
import { ExperimentYamlDocumenter } from '../documenters/ExperimentYamlDocumenter';
9+
import { ExperimentalYamlDocumenter } from '../documenters/ExperimentalYamlDocumenter';
1010
import { IConfigFile } from '../documenters/IConfigFile';
1111

1212
import { ApiModel } from '@microsoft/api-extractor-model';
@@ -40,7 +40,7 @@ export class GenerateAction extends BaseAction {
4040

4141
const apiModel: ApiModel = this.buildApiModel();
4242

43-
const yamlDocumenter: ExperimentYamlDocumenter = new ExperimentYamlDocumenter(apiModel, configFile);
43+
const yamlDocumenter: ExperimentalYamlDocumenter = new ExperimentalYamlDocumenter(apiModel, configFile);
4444
yamlDocumenter.generateFiles(this.outputFolder);
4545
return Promise.resolve();
4646
}

apps/api-documenter/src/documenters/DocumenterConfig.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export class DocumenterConfig {
1515
* The JSON Schema for API Extractor config file (api-extractor.schema.json).
1616
*/
1717
public static readonly jsonSchema: JsonSchema = JsonSchema.fromFile(
18-
path.join(__dirname, '../schemas/api-documenter.schema.json'));
18+
path.join(__dirname, '..', 'schemas', 'api-documenter.schema.json'));
1919

2020
/**
2121
* The config file name "api-extractor.json".

apps/api-documenter/src/documenters/ExperimentYamlDocumenter.ts renamed to apps/api-documenter/src/documenters/ExperimentalYamlDocumenter.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import { YamlDocumenter } from './YamlDocumenter';
1313
* EXPERIMENTAL - This documenter is a prototype of a new config file driven mode of operation for
1414
* API Documenter. It is not ready for general usage yet. Its design may change in the future.
1515
*/
16-
export class ExperimentYamlDocumenter extends YamlDocumenter {
16+
export class ExperimentalYamlDocumenter extends YamlDocumenter {
1717
private _config: IConfigTableOfContents;
1818
private _tocPointerMap: { [key: string]: IYamlTocItem };
1919
private _catchAllPointer: IYamlTocItem;
@@ -22,7 +22,7 @@ export class ExperimentYamlDocumenter extends YamlDocumenter {
2222
super(apiModel);
2323
this._config = configFile.tableOfContents!;
2424

25-
this._tocPointerMap = {}; // need a type?
25+
this._tocPointerMap = {};
2626

2727
this._generateTocPointersMap(this._config.tocConfig);
2828
}

build-tests/api-documenter-test/etc/markdown/api-documenter-test.docbaseclass.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@
66

77
Example base class
88

9-
109
<b>Signature:</b>
1110

1211
```typescript
13-
export declare class DocBaseClass
12+
export declare class DocBaseClass
1413
```

common/changes/@microsoft/api-documenter/FabricDocumenter_2019-05-06-23-48.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": "Adds optional config file `api-documenter.json` to allow building custom TOC for YamlDocumenter.",
5+
"comment": "Add optional config file `api-documenter.json` to allow building custom Table of Contents for YamlDocumenter.",
66
"type": "minor"
77
}
88
],

0 commit comments

Comments
 (0)