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,125 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataSourcePluginMeta"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## DataSourcePluginMeta interface
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export interface DataSourcePluginMeta<T extends KeyValue = {}> extends PluginMeta<T>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataSourcePluginMeta } from '@grafana/data';
|
||||
```
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [alerting](#alerting-property) | <code>boolean</code> | |
|
||||
| [annotations](#annotations-property) | <code>boolean</code> | |
|
||||
| [builtIn](#builtin-property) | <code>boolean</code> | |
|
||||
| [category](#category-property) | <code>string</code> | |
|
||||
| [hasQueryHelp](#hasqueryhelp-property) | <code>boolean</code> | |
|
||||
| [logs](#logs-property) | <code>boolean</code> | |
|
||||
| [metrics](#metrics-property) | <code>boolean</code> | |
|
||||
| [mixed](#mixed-property) | <code>boolean</code> | |
|
||||
| [queryOptions](#queryoptions-property) | <code>PluginMetaQueryOptions</code> | |
|
||||
| [sort](#sort-property) | <code>number</code> | |
|
||||
| [streaming](#streaming-property) | <code>boolean</code> | |
|
||||
|
||||
### alerting property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
alerting?: boolean;
|
||||
```
|
||||
|
||||
### annotations property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
annotations?: boolean;
|
||||
```
|
||||
|
||||
### builtIn property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
builtIn?: boolean;
|
||||
```
|
||||
|
||||
### category property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
category?: string;
|
||||
```
|
||||
|
||||
### hasQueryHelp property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
hasQueryHelp?: boolean;
|
||||
```
|
||||
|
||||
### logs property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
logs?: boolean;
|
||||
```
|
||||
|
||||
### metrics property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
metrics?: boolean;
|
||||
```
|
||||
|
||||
### mixed property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
mixed?: boolean;
|
||||
```
|
||||
|
||||
### queryOptions property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
queryOptions?: PluginMetaQueryOptions;
|
||||
```
|
||||
|
||||
### sort property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
sort?: number;
|
||||
```
|
||||
|
||||
### streaming property
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
streaming?: boolean;
|
||||
```
|
||||
Reference in New Issue
Block a user