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.
This commit is contained in:
@@ -0,0 +1,170 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "PluginMeta"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## PluginMeta interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface PluginMeta<T extends KeyValue = {}>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { PluginMeta } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [baseUrl](#baseurl-property) | <code>string</code> | |
|
||||
| [defaultNavUrl](#defaultnavurl-property) | <code>string</code> | |
|
||||
| [dependencies](#dependencies-property) | <code>PluginDependencies</code> | |
|
||||
| [enabled](#enabled-property) | <code>boolean</code> | |
|
||||
| [hasUpdate](#hasupdate-property) | <code>boolean</code> | |
|
||||
| [id](#id-property) | <code>string</code> | |
|
||||
| [includes](#includes-property) | <code>PluginInclude[]</code> | |
|
||||
| [info](#info-property) | <code>PluginMetaInfo</code> | |
|
||||
| [jsonData](#jsondata-property) | <code>T</code> | |
|
||||
| [latestVersion](#latestversion-property) | <code>string</code> | |
|
||||
| [module](#module-property) | <code>string</code> | |
|
||||
| [name](#name-property) | <code>string</code> | |
|
||||
| [pinned](#pinned-property) | <code>boolean</code> | |
|
||||
| [secureJsonData](#securejsondata-property) | <code>KeyValue</code> | |
|
||||
| [state](#state-property) | <code>PluginState</code> | |
|
||||
| [type](#type-property) | <code>PluginType</code> | |
|
||||
|
||||
### baseUrl property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
baseUrl: string;
|
||||
```
|
||||
|
||||
### defaultNavUrl property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
defaultNavUrl?: string;
|
||||
```
|
||||
|
||||
### dependencies property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
dependencies?: PluginDependencies;
|
||||
```
|
||||
|
||||
### enabled property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
enabled?: boolean;
|
||||
```
|
||||
|
||||
### hasUpdate property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
hasUpdate?: boolean;
|
||||
```
|
||||
|
||||
### id property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
id: string;
|
||||
```
|
||||
|
||||
### includes property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
includes?: PluginInclude[];
|
||||
```
|
||||
|
||||
### info property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
info: PluginMetaInfo;
|
||||
```
|
||||
|
||||
### jsonData property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
jsonData?: T;
|
||||
```
|
||||
|
||||
### latestVersion property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
latestVersion?: string;
|
||||
```
|
||||
|
||||
### module property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
module: string;
|
||||
```
|
||||
|
||||
### name property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
name: string;
|
||||
```
|
||||
|
||||
### pinned property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
pinned?: boolean;
|
||||
```
|
||||
|
||||
### secureJsonData property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
secureJsonData?: KeyValue;
|
||||
```
|
||||
|
||||
### state property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
state?: PluginState;
|
||||
```
|
||||
|
||||
### type property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
type: PluginType;
|
||||
```
|
||||
Reference in New Issue
Block a user