Skip to content

Commit f654d61

Browse files
committed
Add JSDoc
1 parent eddf336 commit f654d61

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

src/config-utils.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -653,6 +653,11 @@ const OVERLAY_ANALYSIS_CODE_SCANNING_FEATURES: Record<Language, Feature> = {
653653
swift: Feature.OverlayAnalysisCodeScanningSwift,
654654
};
655655

656+
/**
657+
* Checks whether the overlay analysis feature is enabled for the given
658+
* languages and configuration, returning the specific reason it is disabled,
659+
* or `undefined` if it is enabled.
660+
*/
656661
async function getOverlayFeatureDisabledReason(
657662
features: FeatureEnablement,
658663
codeql: CodeQL,
@@ -756,8 +761,9 @@ async function runnerHasSufficientMemory(
756761
}
757762

758763
/**
759-
* Checks if the runner supports overlay analysis based on available disk space
760-
* and the maximum memory CodeQL will be allowed to use.
764+
* Checks if the runner has sufficient disk space and memory for overlay
765+
* analysis, returning the specific reason if not, or `undefined` if resources
766+
* are sufficient.
761767
*/
762768
async function getResourceDisabledReason(
763769
codeql: CodeQL,

0 commit comments

Comments
 (0)