Skip to content

Commit ac3df88

Browse files
committed
docs(core): add JSDoc descriptions to get-custom-properties functions
1 parent 090b2f2 commit ac3df88

1 file changed

Lines changed: 17 additions & 14 deletions

File tree

packages/@burger-editor/core/src/dom-helpers/get-custom-properties.ts

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,9 @@ interface LayerPriority {
3838

3939
/**
4040
* Get all custom properties from document
41-
* @param scope
42-
* @param containerType
41+
* @param scope - Document to scan for CSS custom properties
42+
* @param containerType - Container type to filter container-scoped properties (prefixed with `_`)
43+
* @returns Categorized map of custom properties grouped by property name
4344
*/
4445
export function getCustomProperties(
4546
scope: Document,
@@ -152,9 +153,10 @@ export function getCustomProperties(
152153
}
153154

154155
/**
155-
*
156-
* @param scope
157-
* @param property
156+
* Get a single custom property value from document
157+
* @param scope - Document to scan for CSS custom properties
158+
* @param property - Property name or pattern to match against
159+
* @returns The property value with the highest cascade priority, or `null` if not found
158160
*/
159161
export function getCustomProperty(
160162
scope: Document,
@@ -248,9 +250,9 @@ function collectGlobalTopLevelLayerOrder(scope: Document): readonly string[] {
248250
/**
249251
* Get all CSSStyleRule from CSSRule array recursively
250252
* @param rules - CSSRule array
251-
* @param layers
252-
* @param scope - Document
253-
* @param scopeRoot
253+
* @param layers - Accumulated layer priority chain from parent rules
254+
* @param scope - Document providing CSSOM constructors
255+
* @param scopeRoot - Selector from enclosing `@scope` rule, if any
254256
* @param topLevelLayerOrder - Global layer order from collectGlobalTopLevelLayerOrder (top-level calls only)
255257
* @returns CSSStyleRule array
256258
*/
@@ -348,9 +350,9 @@ function getStyleRules(
348350
}
349351

350352
/**
351-
*
352-
* @param scope
353-
* @param found
353+
* Search all stylesheets for custom properties on the block option scope selector
354+
* @param scope - Document to scan
355+
* @param found - Callback invoked for each custom property found
354356
*/
355357
function searchCustomProperty(
356358
scope: Document,
@@ -402,7 +404,8 @@ function searchCustomProperty(
402404

403405
/**
404406
* Get repeat-min-inline-size variant definitions from document
405-
* @param scope
407+
* @param scope - Document to scan for `--bge-repeat-min-inline-size` variants
408+
* @returns Category containing variant properties, or `null` if no variants found
406409
*/
407410
export function getRepeatMinInlineSizeVariants(
408411
scope: Document,
@@ -461,8 +464,8 @@ export function getRepeatMinInlineSizeVariants(
461464
* - レイヤーの数が少ないほど優先度が高い
462465
* - レイヤーの数が同じ場合は、レイヤーの優先度の値が小さいほど優先度が高い
463466
* - 全てのレイヤーの優先度が同じ場合は、bを返す
464-
* @param a
465-
* @param b
467+
* @param a - First candidate property
468+
* @param b - Second candidate property (wins on equal priority)
466469
*/
467470
function compareCustomPropertyByLayerPriority(
468471
a: CustomProperty,

0 commit comments

Comments
 (0)