Skip to content

Commit 44d92f5

Browse files
committed
docs: update API documentation
1 parent 57e9419 commit 44d92f5

2,553 files changed

Lines changed: 136920 additions & 15612 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.

websites/api.rushstack.io/data/api_nav.json

Lines changed: 9593 additions & 3877 deletions
Large diffs are not rendered by default.

websites/api.rushstack.io/docs/pages/api-documenter.iapidocumenterpluginmanifest.md

Lines changed: 60 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,64 @@ export const apiDocumenterPluginManifest: IApiDocumenterPluginManifest = {
4545

4646
## Properties
4747

48-
| Property | Modifiers | Type | Description |
49-
| --- | --- | --- | --- |
50-
| [features](./api-documenter.iapidocumenterpluginmanifest.features.md) | | [IFeatureDefinition](./api-documenter.ifeaturedefinition.md)<></>\[\] | The list of features provided by this plugin. |
51-
| [manifestVersion](./api-documenter.iapidocumenterpluginmanifest.manifestversion.md) | | 1000 | The manifest version number. For now, this must always be <code>1000</code>. |
48+
<table><thead><tr><th>
49+
50+
Property
51+
52+
53+
</th><th>
54+
55+
Modifiers
56+
57+
58+
</th><th>
59+
60+
Type
61+
62+
63+
</th><th>
64+
65+
Description
66+
67+
68+
</th></tr></thead>
69+
<tbody><tr><td>
70+
71+
[features](./api-documenter.iapidocumenterpluginmanifest.features.md)
72+
73+
74+
</td><td>
75+
76+
77+
</td><td>
78+
79+
[IFeatureDefinition](./api-documenter.ifeaturedefinition.md)<></>\[\]
80+
81+
82+
</td><td>
83+
84+
The list of features provided by this plugin.
85+
86+
87+
</td></tr>
88+
<tr><td>
89+
90+
[manifestVersion](./api-documenter.iapidocumenterpluginmanifest.manifestversion.md)
91+
92+
93+
</td><td>
94+
95+
96+
</td><td>
97+
98+
1000
99+
100+
101+
</td><td>
102+
103+
The manifest version number. For now, this must always be `1000`<></>.
104+
105+
106+
</td></tr>
107+
</tbody></table>
52108

websites/api.rushstack.io/docs/pages/api-documenter.ifeaturedefinition.md

Lines changed: 81 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,85 @@ export interface IFeatureDefinition
2020

2121
## Properties
2222

23-
| Property | Modifiers | Type | Description |
24-
| --- | --- | --- | --- |
25-
| [featureName](./api-documenter.ifeaturedefinition.featurename.md) | | string | <p>The name of this feature, as it will appear in the config file.</p><p>The name should consist of one or more words separated by hyphens. Each word should consist of lower case letters and numbers. Example: <code>my-feature</code></p> |
26-
| [kind](./api-documenter.ifeaturedefinition.kind.md) | | 'MarkdownDocumenterFeature' | Determines the kind of feature. The specified value is the name of the base class that <code>subclass</code> inherits from. |
27-
| [subclass](./api-documenter.ifeaturedefinition.subclass.md) | | { new (initialization: [PluginFeatureInitialization](./api-documenter.pluginfeatureinitialization.md)<></>): [MarkdownDocumenterFeature](./api-documenter.markdowndocumenterfeature.md)<></>; } | Your subclass that extends from the base class. |
23+
<table><thead><tr><th>
24+
25+
Property
26+
27+
28+
</th><th>
29+
30+
Modifiers
31+
32+
33+
</th><th>
34+
35+
Type
36+
37+
38+
</th><th>
39+
40+
Description
41+
42+
43+
</th></tr></thead>
44+
<tbody><tr><td>
45+
46+
[featureName](./api-documenter.ifeaturedefinition.featurename.md)
47+
48+
49+
</td><td>
50+
51+
52+
</td><td>
53+
54+
string
55+
56+
57+
</td><td>
58+
59+
The name of this feature, as it will appear in the config file.
60+
61+
The name should consist of one or more words separated by hyphens. Each word should consist of lower case letters and numbers. Example: `my-feature`
62+
63+
64+
</td></tr>
65+
<tr><td>
66+
67+
[kind](./api-documenter.ifeaturedefinition.kind.md)
68+
69+
70+
</td><td>
71+
72+
73+
</td><td>
74+
75+
'MarkdownDocumenterFeature'
76+
77+
78+
</td><td>
79+
80+
Determines the kind of feature. The specified value is the name of the base class that `subclass` inherits from.
81+
82+
83+
</td></tr>
84+
<tr><td>
85+
86+
[subclass](./api-documenter.ifeaturedefinition.subclass.md)
87+
88+
89+
</td><td>
90+
91+
92+
</td><td>
93+
94+
{ new (initialization: [PluginFeatureInitialization](./api-documenter.pluginfeatureinitialization.md)<></>): [MarkdownDocumenterFeature](./api-documenter.markdowndocumenterfeature.md)<></>; }
95+
96+
97+
</td><td>
98+
99+
Your subclass that extends from the base class.
100+
101+
102+
</td></tr>
103+
</tbody></table>
28104

websites/api.rushstack.io/docs/pages/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.md

Lines changed: 83 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,87 @@ export interface IMarkdownDocumenterFeatureOnBeforeWritePageArgs
2020

2121
## Properties
2222

23-
| Property | Modifiers | Type | Description |
24-
| --- | --- | --- | --- |
25-
| [apiItem](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.apiitem.md) | <code>readonly</code> | [ApiItem](./api-extractor-model.apiitem.md) | The API item corresponding to this page. |
26-
| [outputFilename](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.outputfilename.md) | <code>readonly</code> | string | The filename where the output will be written. |
27-
| [pageContent](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.pagecontent.md) | | string | The page content. The [MarkdownDocumenterFeature.onBeforeWritePage()](./api-documenter.markdowndocumenterfeature.onbeforewritepage.md) handler can reassign this string to customize the page appearance. |
23+
<table><thead><tr><th>
24+
25+
Property
26+
27+
28+
</th><th>
29+
30+
Modifiers
31+
32+
33+
</th><th>
34+
35+
Type
36+
37+
38+
</th><th>
39+
40+
Description
41+
42+
43+
</th></tr></thead>
44+
<tbody><tr><td>
45+
46+
[apiItem](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.apiitem.md)
47+
48+
49+
</td><td>
50+
51+
`readonly`
52+
53+
54+
</td><td>
55+
56+
[ApiItem](./api-extractor-model.apiitem.md)
57+
58+
59+
</td><td>
60+
61+
The API item corresponding to this page.
62+
63+
64+
</td></tr>
65+
<tr><td>
66+
67+
[outputFilename](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.outputfilename.md)
68+
69+
70+
</td><td>
71+
72+
`readonly`
73+
74+
75+
</td><td>
76+
77+
string
78+
79+
80+
</td><td>
81+
82+
The filename where the output will be written.
83+
84+
85+
</td></tr>
86+
<tr><td>
87+
88+
[pageContent](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.pagecontent.md)
89+
90+
91+
</td><td>
92+
93+
94+
</td><td>
95+
96+
string
97+
98+
99+
</td><td>
100+
101+
The page content. The [MarkdownDocumenterFeature.onBeforeWritePage()](./api-documenter.markdowndocumenterfeature.onbeforewritepage.md) handler can reassign this string to customize the page appearance.
102+
103+
104+
</td></tr>
105+
</tbody></table>
28106

websites/api.rushstack.io/docs/pages/api-documenter.markdowndocumenteraccessor.getlinkforapiitem.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,37 @@ getLinkForApiItem(apiItem: ApiItem): string | undefined;
2020

2121
## Parameters
2222

23-
| Parameter | Type | Description |
24-
| --- | --- | --- |
25-
| apiItem | [ApiItem](./api-extractor-model.apiitem.md) | |
23+
<table><thead><tr><th>
24+
25+
Parameter
26+
27+
28+
</th><th>
29+
30+
Type
31+
32+
33+
</th><th>
34+
35+
Description
36+
37+
38+
</th></tr></thead>
39+
<tbody><tr><td>
40+
41+
apiItem
42+
43+
44+
</td><td>
45+
46+
[ApiItem](./api-extractor-model.apiitem.md)
47+
48+
49+
</td><td>
50+
51+
52+
</td></tr>
53+
</tbody></table>
2654

2755
**Returns:**
2856

websites/api.rushstack.io/docs/pages/api-documenter.markdowndocumenteraccessor.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,35 @@ The constructor for this class is marked as internal. Third-party code should no
2424

2525
## Methods
2626

27-
| Method | Modifiers | Description |
28-
| --- | --- | --- |
29-
| [getLinkForApiItem(apiItem)](./api-documenter.markdowndocumenteraccessor.getlinkforapiitem.md) | | For a given <code>ApiItem</code>, return its markdown hyperlink. |
27+
<table><thead><tr><th>
28+
29+
Method
30+
31+
32+
</th><th>
33+
34+
Modifiers
35+
36+
37+
</th><th>
38+
39+
Description
40+
41+
42+
</th></tr></thead>
43+
<tbody><tr><td>
44+
45+
[getLinkForApiItem(apiItem)](./api-documenter.markdowndocumenteraccessor.getlinkforapiitem.md)
46+
47+
48+
</td><td>
49+
50+
51+
</td><td>
52+
53+
For a given `ApiItem`<></>, return its markdown hyperlink.
54+
55+
56+
</td></tr>
57+
</tbody></table>
3058

websites/api.rushstack.io/docs/pages/api-documenter.markdowndocumenterfeature._symbol.hasinstance_.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,37 @@ static [Symbol.hasInstance](instance: object): boolean;
1818

1919
## Parameters
2020

21-
| Parameter | Type | Description |
22-
| --- | --- | --- |
23-
| instance | object | |
21+
<table><thead><tr><th>
22+
23+
Parameter
24+
25+
26+
</th><th>
27+
28+
Type
29+
30+
31+
</th><th>
32+
33+
Description
34+
35+
36+
</th></tr></thead>
37+
<tbody><tr><td>
38+
39+
instance
40+
41+
42+
</td><td>
43+
44+
object
45+
46+
47+
</td><td>
48+
49+
50+
</td></tr>
51+
</tbody></table>
2452

2553
**Returns:**
2654

0 commit comments

Comments
 (0)