| 4 | * Common props for elements with descriptions. |
| 5 | */ |
| 6 | export interface WithDescription { |
| 7 | /** |
| 8 | * An optional long description, typically shown in the extended doc popup |
| 9 | * shown on hovers and code completions. |
| 10 | */ |
| 11 | longDescription?: string; |
| 12 | /** |
| 13 | * A short description, typically shown in the code completion box. |
| 14 | */ |
| 15 | shortDescription: string; |
| 16 | |
| 17 | /** |
| 18 | * If defined, the element is deprecated. |
| 19 | */ |
| 20 | deprecated?: string; |
| 21 | |
| 22 | /** |
| 23 | * Additional remarks relevant for this item. |
| 24 | */ |
| 25 | remarks?: string; |
| 26 | } |
| 27 | |
| 28 | /** |
| 29 | * Describes an individual value for a specific parameter. |
nothing calls this directly
no outgoing calls
no test coverage detected