Fix doc comment

bheston · bheston · commit 855069b34506 · 2025-05-09T11:41:05.000-07:00
diff --git a/packages/adaptive-ui/src/core/shadow/index.ts b/packages/adaptive-ui/src/core/shadow/index.ts
@@ -58,7 +58,7 @@ export type ShadowValue = Shadow | DesignTokenMultiValue<Shadow> | string;
 /**
  * Creates a DesignToken that can be used for Shadow value.
  *
- * @param name - The token name in `css-identifier` casing.
+ * @param name - The token name in `dotted.camelCase` casing.
  *
  * @public
  */
diff --git a/packages/adaptive-ui/src/core/token-helpers-color.ts b/packages/adaptive-ui/src/core/token-helpers-color.ts
@@ -23,7 +23,7 @@ import { InteractiveState, InteractiveTokenGroup } from "./types.js";
 /**
  * Creates a DesignToken that can be used for interactive color recipe deltas.
  *
- * @param baseName - The base token name in `css-identifier` casing.
+ * @param baseName - The base token name in `dotted.camelCase` casing.
  * @param state - The state for the recipe delta value, or a custom identifier in camelCase.
  * @param value - The value for the recipe delta.
  *
@@ -40,7 +40,7 @@ export function createTokenDelta(
 /**
  * Creates a DesignToken that can be used for color recipe minimum contrast.
  *
- * @param baseName - The base token name in `css-identifier` casing.
+ * @param baseName - The base token name in `dotted.camelCase` casing.
  * @param value - The value for the recipe minimum contrast.
  *
  * @public
@@ -55,7 +55,7 @@ export function createTokenMinContrast(
 /**
  * Creates a DesignToken that can be used for a color recipe, optionally referencing a context color.
  *
- * @param baseName - The base token name in `css-identifier` casing.
+ * @param baseName - The base token name in `dotted.camelCase` casing.
  * @param intendedFor - The style properties where this token is intended to be used.
  * @param evaluate - The function to call when the derived token needs to be evaluated.
  *
@@ -74,7 +74,7 @@ export function createTokenColorRecipe<T = Paint>(
 /**
  * Creates a DesignToken that can be used for a color recipe, referencing an interactive color set for context.
  *
- * @param baseName - The base token name in `css-identifier` casing.
+ * @param baseName - The base token name in `dotted.camelCase` casing.
  * @param intendedFor - The style properties where this token is intended to be used.
  * @param evaluate - The function to call when the derived token needs to be evaluated.
  *
@@ -94,7 +94,7 @@ export function createTokenColorRecipeBySet<T = Paint>(
  * Creates a DesignToken that can be used for a color recipe that works with different {@link Palette}s.
  * Use in conjunction with {@link createTokenColorRecipeWithPalette}.
  *
- * @param baseName - The base token name in `css-identifier` casing.
+ * @param baseName - The base token name in `dotted.camelCase` casing.
  * @param intendedFor - The style properties where this token is intended to be used.
  * @param evaluate - The function to call when the derived token needs to be evaluated.
  *
diff --git a/packages/adaptive-ui/src/core/token-helpers.ts b/packages/adaptive-ui/src/core/token-helpers.ts
@@ -24,7 +24,7 @@ export const { createTyped } = TypedCSSDesignToken;
 /**
  * Creates a DesignToken that can be used for color value.
  *
- * @param name - The token name in `css-identifier` casing.
+ * @param name - The token name in `dotted.camelCase` casing.
  * @param intendedFor - The style properties where this token is intended to be used.
  *
  * @public
@@ -36,7 +36,7 @@ export function createTokenColor(name: string, intendedFor?: StyleProperty | Sty
 /**
  * Creates a DesignToken that can be used by other DesignTokens, but not directly in styles.
  *
- * @param name - The token name in `css-identifier` casing.
+ * @param name - The token name in `dotted.camelCase` casing.
  * @param type - The allowed types for the token value.
  *
  * @public
@@ -48,7 +48,7 @@ export function createTokenNonCss<T>(name: string, type: DesignTokenType, intend
 /**
  * Creates a DesignToken that can be used for a recipe.
  *
- * @param baseName - The base token name in `css-identifier` casing.
+ * @param baseName - The base token name in `dotted.camelCase` casing.
  * @param intendedFor - The style properties where this token is intended to be used.
  * @param evaluate - The function to call when the derived token needs to be evaluated.
  *
@@ -67,7 +67,7 @@ export function createTokenRecipe<TParam, TResult>(
 /**
  * Creates a DesignToken that can be used for thickness, sizes, and other dimension values in styles.
  *
- * @param name - The token name in `css-identifier` casing.
+ * @param name - The token name in `dotted.camelCase` casing.
  * @param intendedFor - The style properties where this token is intended to be used.
  *
  * @public
@@ -79,7 +79,7 @@ export function createTokenDimension(name: string, intendedFor?: StyleProperty |
 /**
  * Creates a DesignToken that can be used for typography font family in styles.
  *
- * @param name - The token name in `css-identifier` casing.
+ * @param name - The token name in `dotted.camelCase` casing.
  *
  * @public
  */
@@ -90,7 +90,7 @@ export function createTokenFontFamily(name: string): TypedCSSDesignToken<string>
 /**
  * Creates a DesignToken that can be used for typography font size in styles.
  *
- * @param name - The token name in `css-identifier` casing.
+ * @param name - The token name in `dotted.camelCase` casing.
  *
  * @public
  */
@@ -101,7 +101,7 @@ export function createTokenFontSize(name: string): TypedCSSDesignToken<string> {
 /**
  * Creates a DesignToken that can be used for typography font style (normal, italic) in styles.
  *
- * @param name - The token name in `css-identifier` casing.
+ * @param name - The token name in `dotted.camelCase` casing.
  *
  * @public
  */
@@ -112,7 +112,7 @@ export function createTokenFontStyle(name: string): TypedCSSDesignToken<string>
 /**
  * Creates a DesignToken that can be used for typography font variations in styles.
  *
- * @param name - The token name in `css-identifier` casing.
+ * @param name - The token name in `dotted.camelCase` casing.
  *
  * @public
  */
@@ -123,7 +123,7 @@ export function createTokenFontVariations(name: string): TypedCSSDesignToken<str
 /**
  * Creates a DesignToken that can be used for typography font weight in styles.
  *
- * @param name - The token name in `css-identifier` casing.
+ * @param name - The token name in `dotted.camelCase` casing.
  *
  * @public
  */
@@ -134,7 +134,7 @@ export function createTokenFontWeight(name: string): TypedCSSDesignToken<number>
 /**
  * Creates a DesignToken that can be used for typography line height in styles.
  *
- * @param name - The token name in `css-identifier` casing.
+ * @param name - The token name in `dotted.camelCase` casing.
  *
  * @public
  */
@@ -145,7 +145,7 @@ export function createTokenLineHeight(name: string): TypedCSSDesignToken<string>
 /**
  * Creates a DesignToken that can be used for number value.
  *
- * @param name - The token name in `css-identifier` casing.
+ * @param name - The token name in `dotted.camelCase` casing.
  * @param intendedFor - The style properties where this token is intended to be used.
  *
  * @public
@@ -157,7 +157,7 @@ export function createTokenNumber(name: string, intendedFor?: StyleProperty | St
 /**
  * Creates a DesignToken for number values that can be used by other DesignTokens, but not directly in styles.
  *
- * @param name - The token name in `css-identifier` casing.
+ * @param name - The token name in `dotted.camelCase` casing.
  * @param intendedFor - The style properties where this token is intended to be used.
  *
  * @public
@@ -169,7 +169,7 @@ export function createTokenNumberNonStyling(name: string, intendedFor?: StylePro
 /**
  * Creates a DesignToken that can be used as a paint treatment (background, foreground, border, etc.) in styles.
  *
- * @param name - The token name in `css-identifier` casing.
+ * @param name - The token name in `dotted.camelCase` casing.
  * @param intendedFor - The style properties where this token is intended to be used.
  *
  * @remarks
@@ -184,7 +184,7 @@ export function createTokenPaint(name: string, intendedFor?: StyleProperty | Sty
 /**
  * Creates a DesignToken that can be used as a color in styles.
  *
- * @param name - The token name in `css-identifier` casing.
+ * @param name - The token name in `dotted.camelCase` casing.
  * @param intendedFor - The style properties where this token is intended to be used.
  *
  * @public

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ export type ShadowValue = Shadow \| DesignTokenMultiValue<Shadow> \| string;`
`58`	`58`	`/**`
`59`	`59`	`* Creates a DesignToken that can be used for Shadow value.`
`60`	`60`	`*`
`61`		- * @param name - The token name in `css-identifier` casing.
	`61`	+ * @param name - The token name in `dotted.camelCase` casing.
`62`	`62`	`*`
`63`	`63`	`* @public`
`64`	`64`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ import { InteractiveState, InteractiveTokenGroup } from "./types.js";`
`23`	`23`	`/**`
`24`	`24`	`* Creates a DesignToken that can be used for interactive color recipe deltas.`
`25`	`25`	`*`
`26`		- * @param baseName - The base token name in `css-identifier` casing.
	`26`	+ * @param baseName - The base token name in `dotted.camelCase` casing.
`27`	`27`	`* @param state - The state for the recipe delta value, or a custom identifier in camelCase.`
`28`	`28`	`* @param value - The value for the recipe delta.`
`29`	`29`	`*`
`@@ -40,7 +40,7 @@ export function createTokenDelta(`
`40`	`40`	`/**`
`41`	`41`	`* Creates a DesignToken that can be used for color recipe minimum contrast.`
`42`	`42`	`*`
`43`		- * @param baseName - The base token name in `css-identifier` casing.
	`43`	+ * @param baseName - The base token name in `dotted.camelCase` casing.
`44`	`44`	`* @param value - The value for the recipe minimum contrast.`
`45`	`45`	`*`
`46`	`46`	`* @public`
`@@ -55,7 +55,7 @@ export function createTokenMinContrast(`
`55`	`55`	`/**`
`56`	`56`	`* Creates a DesignToken that can be used for a color recipe, optionally referencing a context color.`
`57`	`57`	`*`
`58`		- * @param baseName - The base token name in `css-identifier` casing.
	`58`	+ * @param baseName - The base token name in `dotted.camelCase` casing.
`59`	`59`	`* @param intendedFor - The style properties where this token is intended to be used.`
`60`	`60`	`* @param evaluate - The function to call when the derived token needs to be evaluated.`
`61`	`61`	`*`
`@@ -74,7 +74,7 @@ export function createTokenColorRecipe<T = Paint>(`
`74`	`74`	`/**`
`75`	`75`	`* Creates a DesignToken that can be used for a color recipe, referencing an interactive color set for context.`
`76`	`76`	`*`
`77`		- * @param baseName - The base token name in `css-identifier` casing.
	`77`	+ * @param baseName - The base token name in `dotted.camelCase` casing.
`78`	`78`	`* @param intendedFor - The style properties where this token is intended to be used.`
`79`	`79`	`* @param evaluate - The function to call when the derived token needs to be evaluated.`
`80`	`80`	`*`
`@@ -94,7 +94,7 @@ export function createTokenColorRecipeBySet<T = Paint>(`
`94`	`94`	`* Creates a DesignToken that can be used for a color recipe that works with different {@link Palette}s.`
`95`	`95`	`* Use in conjunction with {@link createTokenColorRecipeWithPalette}.`
`96`	`96`	`*`
`97`		- * @param baseName - The base token name in `css-identifier` casing.
	`97`	+ * @param baseName - The base token name in `dotted.camelCase` casing.
`98`	`98`	`* @param intendedFor - The style properties where this token is intended to be used.`
`99`	`99`	`* @param evaluate - The function to call when the derived token needs to be evaluated.`
`100`	`100`	`*`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ export const { createTyped } = TypedCSSDesignToken;`
`24`	`24`	`/**`
`25`	`25`	`* Creates a DesignToken that can be used for color value.`
`26`	`26`	`*`
`27`		- * @param name - The token name in `css-identifier` casing.
	`27`	+ * @param name - The token name in `dotted.camelCase` casing.
`28`	`28`	`* @param intendedFor - The style properties where this token is intended to be used.`
`29`	`29`	`*`
`30`	`30`	`* @public`
`@@ -36,7 +36,7 @@ export function createTokenColor(name: string, intendedFor?: StyleProperty \| Sty`
`36`	`36`	`/**`
`37`	`37`	`* Creates a DesignToken that can be used by other DesignTokens, but not directly in styles.`
`38`	`38`	`*`
`39`		- * @param name - The token name in `css-identifier` casing.
	`39`	+ * @param name - The token name in `dotted.camelCase` casing.
`40`	`40`	`* @param type - The allowed types for the token value.`
`41`	`41`	`*`
`42`	`42`	`* @public`
`@@ -48,7 +48,7 @@ export function createTokenNonCss<T>(name: string, type: DesignTokenType, intend`
`48`	`48`	`/**`
`49`	`49`	`* Creates a DesignToken that can be used for a recipe.`
`50`	`50`	`*`
`51`		- * @param baseName - The base token name in `css-identifier` casing.
	`51`	+ * @param baseName - The base token name in `dotted.camelCase` casing.
`52`	`52`	`* @param intendedFor - The style properties where this token is intended to be used.`
`53`	`53`	`* @param evaluate - The function to call when the derived token needs to be evaluated.`
`54`	`54`	`*`
`@@ -67,7 +67,7 @@ export function createTokenRecipe<TParam, TResult>(`
`67`	`67`	`/**`
`68`	`68`	`* Creates a DesignToken that can be used for thickness, sizes, and other dimension values in styles.`
`69`	`69`	`*`
`70`		- * @param name - The token name in `css-identifier` casing.
	`70`	+ * @param name - The token name in `dotted.camelCase` casing.
`71`	`71`	`* @param intendedFor - The style properties where this token is intended to be used.`
`72`	`72`	`*`
`73`	`73`	`* @public`
`@@ -79,7 +79,7 @@ export function createTokenDimension(name: string, intendedFor?: StyleProperty \|`
`79`	`79`	`/**`
`80`	`80`	`* Creates a DesignToken that can be used for typography font family in styles.`
`81`	`81`	`*`
`82`		- * @param name - The token name in `css-identifier` casing.
	`82`	+ * @param name - The token name in `dotted.camelCase` casing.
`83`	`83`	`*`
`84`	`84`	`* @public`
`85`	`85`	`*/`
`@@ -90,7 +90,7 @@ export function createTokenFontFamily(name: string): TypedCSSDesignToken<string>`
`90`	`90`	`/**`
`91`	`91`	`* Creates a DesignToken that can be used for typography font size in styles.`
`92`	`92`	`*`
`93`		- * @param name - The token name in `css-identifier` casing.
	`93`	+ * @param name - The token name in `dotted.camelCase` casing.
`94`	`94`	`*`
`95`	`95`	`* @public`
`96`	`96`	`*/`
`@@ -101,7 +101,7 @@ export function createTokenFontSize(name: string): TypedCSSDesignToken<string> {`
`101`	`101`	`/**`
`102`	`102`	`* Creates a DesignToken that can be used for typography font style (normal, italic) in styles.`
`103`	`103`	`*`
`104`		- * @param name - The token name in `css-identifier` casing.
	`104`	+ * @param name - The token name in `dotted.camelCase` casing.
`105`	`105`	`*`
`106`	`106`	`* @public`
`107`	`107`	`*/`
`@@ -112,7 +112,7 @@ export function createTokenFontStyle(name: string): TypedCSSDesignToken<string>`
`112`	`112`	`/**`
`113`	`113`	`* Creates a DesignToken that can be used for typography font variations in styles.`
`114`	`114`	`*`
`115`		- * @param name - The token name in `css-identifier` casing.
	`115`	+ * @param name - The token name in `dotted.camelCase` casing.
`116`	`116`	`*`
`117`	`117`	`* @public`
`118`	`118`	`*/`
`@@ -123,7 +123,7 @@ export function createTokenFontVariations(name: string): TypedCSSDesignToken<str`
`123`	`123`	`/**`
`124`	`124`	`* Creates a DesignToken that can be used for typography font weight in styles.`
`125`	`125`	`*`
`126`		- * @param name - The token name in `css-identifier` casing.
	`126`	+ * @param name - The token name in `dotted.camelCase` casing.
`127`	`127`	`*`
`128`	`128`	`* @public`
`129`	`129`	`*/`
`@@ -134,7 +134,7 @@ export function createTokenFontWeight(name: string): TypedCSSDesignToken<number>`
`134`	`134`	`/**`
`135`	`135`	`* Creates a DesignToken that can be used for typography line height in styles.`
`136`	`136`	`*`
`137`		- * @param name - The token name in `css-identifier` casing.
	`137`	+ * @param name - The token name in `dotted.camelCase` casing.
`138`	`138`	`*`
`139`	`139`	`* @public`
`140`	`140`	`*/`
`@@ -145,7 +145,7 @@ export function createTokenLineHeight(name: string): TypedCSSDesignToken<string>`
`145`	`145`	`/**`
`146`	`146`	`* Creates a DesignToken that can be used for number value.`
`147`	`147`	`*`
`148`		- * @param name - The token name in `css-identifier` casing.
	`148`	+ * @param name - The token name in `dotted.camelCase` casing.
`149`	`149`	`* @param intendedFor - The style properties where this token is intended to be used.`
`150`	`150`	`*`
`151`	`151`	`* @public`
`@@ -157,7 +157,7 @@ export function createTokenNumber(name: string, intendedFor?: StyleProperty \| St`
`157`	`157`	`/**`
`158`	`158`	`* Creates a DesignToken for number values that can be used by other DesignTokens, but not directly in styles.`
`159`	`159`	`*`
`160`		- * @param name - The token name in `css-identifier` casing.
	`160`	+ * @param name - The token name in `dotted.camelCase` casing.
`161`	`161`	`* @param intendedFor - The style properties where this token is intended to be used.`
`162`	`162`	`*`
`163`	`163`	`* @public`
`@@ -169,7 +169,7 @@ export function createTokenNumberNonStyling(name: string, intendedFor?: StylePro`
`169`	`169`	`/**`
`170`	`170`	`* Creates a DesignToken that can be used as a paint treatment (background, foreground, border, etc.) in styles.`
`171`	`171`	`*`
`172`		- * @param name - The token name in `css-identifier` casing.
	`172`	+ * @param name - The token name in `dotted.camelCase` casing.
`173`	`173`	`* @param intendedFor - The style properties where this token is intended to be used.`
`174`	`174`	`*`
`175`	`175`	`* @remarks`
`@@ -184,7 +184,7 @@ export function createTokenPaint(name: string, intendedFor?: StyleProperty \| Sty`
`184`	`184`	`/**`
`185`	`185`	`* Creates a DesignToken that can be used as a color in styles.`
`186`	`186`	`*`
`187`		- * @param name - The token name in `css-identifier` casing.
	`187`	+ * @param name - The token name in `dotted.camelCase` casing.
`188`	`188`	`* @param intendedFor - The style properties where this token is intended to be used.`
`189`	`189`	`*`
`190`	`190`	`* @public`