chore: add api extractor configuration and fix some associated problems (#6388)

* chore: add configuration for api extractor

* fix: remove extra param names

* chore: private to internal

* remove unrestricted

* chore: remove double backticks

* chore: remove fileoverview and export * as

* chore: return to returns

* chore: fix backslashes and angle brackets in tsdoc

* chore: final to sealed

* chore: ignore to internal

* chore: fix link tags

* chore: add api-extractor configuration

* chore: add unrecognized tag names

* chore: remove tsdoc-metadata

* fix: correct index.d.ts

* chore: fix connection link
This commit is contained in:
Maribeth Bottorff
2022-09-01 11:39:05 -07:00
committed by GitHub
parent 55ea12bd21
commit ec72e8bb4d
37 changed files with 1013 additions and 84 deletions

View File

@@ -77,11 +77,11 @@ export function setHsvValue(newValue: number) {
/**
* Parses a colour from a string.
* .parse('red') -> '#ff0000'
* .parse('#f00') -> '#ff0000'
* .parse('#ff0000') -> '#ff0000'
* .parse('0xff0000') -> '#ff0000'
* .parse('rgb(255, 0, 0)') -> '#ff0000'
* .parse('red') = '#ff0000'
* .parse('#f00') = '#ff0000'
* .parse('#ff0000') = '#ff0000'
* .parse('0xff0000') = '#ff0000'
* .parse('rgb(255, 0, 0)') = '#ff0000'
*
* @param str Colour in some CSS format.
* @returns A string containing a hex representation of the colour, or null if

View File

@@ -312,7 +312,7 @@ export function getFastTextWidth(
* Gets the width of a text element using a faster method than `getTextWidth`.
* This method requires that we know the text element's font family and size in
* advance. Similar to `getTextWidth`, we cache the width we compute.
* This method is similar to ``getFastTextWidth`` but expects the font size
* This method is similar to `getFastTextWidth` but expects the font size
* parameter to be a string.
*
* @param textElement An SVG 'text' element.

View File

@@ -24,14 +24,14 @@ const soup = '!#$%()*+,-./:;=?@[]^_`{|}~' +
/**
* Namespace object for internal implementations we want to be able to
* stub in tests.
* stub in tests. Do not use externally.
*
* @ignore
* @internal
*/
const internal = {
/**
* Generate a random unique ID. This should be globally unique.
* 87 characters ^ 20 length > 128 bits (better than a UUID).
* 87 characters ^ 20 length is greater than 128 bits (better than a UUID).
*
* @returns A globally unique ID string.
*/