From f654d61146ed01541285d09285501f51ac5b6c15 Mon Sep 17 00:00:00 2001 From: Henry Mercer Date: Tue, 3 Mar 2026 17:24:47 +0100 Subject: [PATCH] Add JSDoc --- src/config-utils.ts | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/config-utils.ts b/src/config-utils.ts index 9f3aaa9e8..e9d9db6f7 100644 --- a/src/config-utils.ts +++ b/src/config-utils.ts @@ -653,6 +653,11 @@ const OVERLAY_ANALYSIS_CODE_SCANNING_FEATURES: Record = { swift: Feature.OverlayAnalysisCodeScanningSwift, }; +/** + * Checks whether the overlay analysis feature is enabled for the given + * languages and configuration, returning the specific reason it is disabled, + * or `undefined` if it is enabled. + */ async function getOverlayFeatureDisabledReason( features: FeatureEnablement, codeql: CodeQL, @@ -756,8 +761,9 @@ async function runnerHasSufficientMemory( } /** - * Checks if the runner supports overlay analysis based on available disk space - * and the maximum memory CodeQL will be allowed to use. + * Checks if the runner has sufficient disk space and memory for overlay + * analysis, returning the specific reason if not, or `undefined` if resources + * are sufficient. */ async function getResourceDisabledReason( codeql: CodeQL,