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,104 @@
+++
+# -----------------------------------------------------------------------
+# Do not edit this file. It is automatically generated by API Documenter.
+# -----------------------------------------------------------------------
+title = "PluginMetaInfo"
+keywords = ["grafana","documentation","sdk","@grafana/data"]
+type = "docs"
+draft = true
+++
+
+## PluginMetaInfo interface
+
+<b>Signature</b>
+
+```typescript
+export interface PluginMetaInfo 
+```
+<b>Import</b>
+
+```typescript
+import { PluginMetaInfo } from '@grafana/data';
+```
+<b>Properties</b>
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [author](#author-property) | <code>{</code><br/><code>        name: string;</code><br/><code>        url?: string;</code><br/><code>    }</code> |  |
+|  [build](#build-property) | <code>PluginBuildInfo</code> |  |
+|  [description](#description-property) | <code>string</code> |  |
+|  [links](#links-property) | <code>PluginMetaInfoLink[]</code> |  |
+|  [logos](#logos-property) | <code>{</code><br/><code>        large: string;</code><br/><code>        small: string;</code><br/><code>    }</code> |  |
+|  [screenshots](#screenshots-property) | <code>ScreenshotInfo[]</code> |  |
+|  [updated](#updated-property) | <code>string</code> |  |
+|  [version](#version-property) | <code>string</code> |  |
+
+### author property
+
+<b>Signature</b>
+
+```typescript
+author: {
+        name: string;
+        url?: string;
+    };
+```
+
+### build property
+
+<b>Signature</b>
+
+```typescript
+build?: PluginBuildInfo;
+```
+
+### description property
+
+<b>Signature</b>
+
+```typescript
+description: string;
+```
+
+### links property
+
+<b>Signature</b>
+
+```typescript
+links: PluginMetaInfoLink[];
+```
+
+### logos property
+
+<b>Signature</b>
+
+```typescript
+logos: {
+        large: string;
+        small: string;
+    };
+```
+
+### screenshots property
+
+<b>Signature</b>
+
+```typescript
+screenshots: ScreenshotInfo[];
+```
+
+### updated property
+
+<b>Signature</b>
+
+```typescript
+updated: string;
+```
+
+### version property
+
+<b>Signature</b>
+
+```typescript
+version: string;
+```