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:
Marcus Andersson
@@ -0,0 +1,47 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "LogLevel"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## LogLevel enum
|
||||
|
||||
### LogLevel enum
|
||||
|
||||
Mapping of log level abbreviation to canonical log level. Supported levels are reduce to limit color variation.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare enum LogLevel
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { LogLevel } from '@grafana/data';
|
||||
```
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| alert | <code>"critical"</code> | |
|
||||
| crit | <code>"critical"</code> | |
|
||||
| critical | <code>"critical"</code> | |
|
||||
| dbug | <code>"debug"</code> | |
|
||||
| debug | <code>"debug"</code> | |
|
||||
| emerg | <code>"critical"</code> | |
|
||||
| eror | <code>"error"</code> | |
|
||||
| err | <code>"error"</code> | |
|
||||
| error | <code>"error"</code> | |
|
||||
| info | <code>"info"</code> | |
|
||||
| notice | <code>"info"</code> | |
|
||||
| trace | <code>"trace"</code> | |
|
||||
| unknown | <code>"unknown"</code> | |
|
||||
| warn | <code>"warning"</code> | |
|
||||
| warning | <code>"warning"</code> | |
|
||||
|
||||
Reference in New Issue
Block a user