Docs: adding first version of the auto-generated packages API docs. (#22107)

* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
2020-02-26 10:03:53 +01:00
parent 89e6c45090
commit 6bc369629d
594 changed files with 30265 additions and 1 deletions
@@ -0,0 +1,120 @@
+++
+# -----------------------------------------------------------------------
+# Do not edit this file. It is automatically generated by API Documenter.
+# -----------------------------------------------------------------------
+title = "AppPlugin"
+keywords = ["grafana","documentation","sdk","@grafana/data"]
+type = "docs"
+draft = true
+++
+
+## AppPlugin class
+
+<b>Signature</b>
+
+```typescript
+export declare class AppPlugin<T = KeyValue> extends GrafanaPlugin<AppPluginMeta<T>> 
+```
+<b>Import</b>
+
+```typescript
+import { AppPlugin } from '@grafana/data';
+```
+<b>Properties</b>
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [angularPages](#angularpages-property) |  | <code>{</code><br/><code>        [component: string]: any;</code><br/><code>    }</code> |  |
+|  [root](#root-property) |  | <code>ComponentClass&lt;AppRootProps&lt;T&gt;&gt;</code> |  |
+|  [rootNav](#rootnav-property) |  | <code>NavModel</code> |  |
+
+<b>Methods</b>
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [init(meta)](#init-method) |  | Called after the module has loaded, and before the app is used. This function may be called multiple times on the same instance. The first time, <code>this.meta</code> will be undefined |
+|  [setComponentsFromLegacyExports(pluginExports)](#setcomponentsfromlegacyexports-method) |  |  |
+|  [setRootPage(root, rootNav)](#setrootpage-method) |  | Set the component displayed under: /a/$<!-- -->{<!-- -->plugin-id<!-- -->}<!-- -->/\* |
+
+### angularPages property
+
+<b>Signature</b>
+
+```typescript
+angularPages?: {
+        [component: string]: any;
+    };
+```
+
+### root property
+
+<b>Signature</b>
+
+```typescript
+root?: ComponentClass<AppRootProps<T>>;
+```
+
+### rootNav property
+
+<b>Signature</b>
+
+```typescript
+rootNav?: NavModel;
+```
+
+### init method
+
+Called after the module has loaded, and before the app is used. This function may be called multiple times on the same instance. The first time, `this.meta` will be undefined
+
+<b>Signature</b>
+
+```typescript
+init(meta: AppPluginMeta): void;
+```
+<b>Parameters</b>
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  meta | <code>AppPluginMeta</code> |  |
+
+<b>Returns:</b>
+
+`void`
+
+### setComponentsFromLegacyExports method
+
+<b>Signature</b>
+
+```typescript
+setComponentsFromLegacyExports(pluginExports: any): void;
+```
+<b>Parameters</b>
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  pluginExports | <code>any</code> |  |
+
+<b>Returns:</b>
+
+`void`
+
+### setRootPage method
+
+Set the component displayed under: /a/$<!-- -->{<!-- -->plugin-id<!-- -->}<!-- -->/\*
+
+<b>Signature</b>
+
+```typescript
+setRootPage(root: ComponentClass<AppRootProps<T>>, rootNav?: NavModel): this;
+```
+<b>Parameters</b>
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  root | <code>ComponentClass&lt;AppRootProps&lt;T&gt;&gt;</code> |  |
+|  rootNav | <code>NavModel</code> |  |
+
+<b>Returns:</b>
+
+`this`
+