grafana/api-extractor.json

{
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
  "mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts",
  "bundledPackages": [],
  "compiler": {},
  "apiReport": {
    "enabled": false
  },
  "docModel": {
    "enabled": true,
    "apiJsonFilePath": "<projectFolder>/../../reports/docs/<unscopedPackageName>.api.json"
  },
  "dtsRollup": {
    "enabled": false
  },
  "tsdocMetadata": {},
  "messages": {
    "compilerMessageReporting": {
      "default": {
        "logLevel": "warning"
      }
    },
    "extractorMessageReporting": {
      "default": {
        "logLevel": "warning"
      },
      "ae-internal-missing-underscore": {
        "logLevel": "none",
        "addToApiReportFile": false
      }
    },
    "tsdocMessageReporting": {
      "default": {
        "logLevel": "warning"
      }
    }
  }
}
Docs: adding API reference documentation support for the packages libraries. (#21931) * 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 parameters and return values. * Fixed merge error. * 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. * lerna bootstrap. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. 2020-02-25 06:59:11 -06:00			`{`
			`"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",`
			`"mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts",`
			`"bundledPackages": [],`
			`"compiler": {},`
			`"apiReport": {`
			`"enabled": false`
			`},`
			`"docModel": {`
			`"enabled": true,`
			`"apiJsonFilePath": "<projectFolder>/../../reports/docs/<unscopedPackageName>.api.json"`
			`},`
			`"dtsRollup": {`
			`"enabled": false`
			`},`
			`"tsdocMetadata": {},`
			`"messages": {`
			`"compilerMessageReporting": {`
			`"default": {`
			`"logLevel": "warning"`
			`}`
			`},`
			`"extractorMessageReporting": {`
			`"default": {`
			`"logLevel": "warning"`
Docs: added code comments for everything in the @grafana/runtime package. (#23456) * added comments for the angular loader. * added code documentation for backendSrv. * docs for datasource_srv. * added some more docs. * added documentation for the locationsrv. * started to add docs for echo srv. * added docs for meta srv.2 * added docs for analytics. * draft documentation of the DataSourceWithBackend. * added docs for last files. * fixed all warnigns in api-extractor. * fixed some typos and captializations. 2020-04-15 03:46:51 -05:00			`},`
			`"ae-internal-missing-underscore": {`
			`"logLevel": "none",`
			`"addToApiReportFile": false`
Docs: adding API reference documentation support for the packages libraries. (#21931) * 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 parameters and return values. * Fixed merge error. * 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. * lerna bootstrap. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. 2020-02-25 06:59:11 -06:00			`}`
			`},`
			`"tsdocMessageReporting": {`
			`"default": {`
			`"logLevel": "warning"`
			`}`
			`}`
			`}`
			`}`