From 92d39c5abcb3089f291e3902992c8cb9ca5260ca Mon Sep 17 00:00:00 2001 From: cbrom Date: Thu, 23 Nov 2023 22:33:10 +0300 Subject: [PATCH] added a generated docstring for CalculateFixed function Signed-off-by: cbrom --- core/pkg/containerscan/datastructures.go | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/core/pkg/containerscan/datastructures.go b/core/pkg/containerscan/datastructures.go index af4e4e1c..758c6105 100644 --- a/core/pkg/containerscan/datastructures.go +++ b/core/pkg/containerscan/datastructures.go @@ -27,6 +27,30 @@ var KnownSeverities = map[string]bool{ CriticalSeverity: true, } +// CalculateFixed calculates the number of fixes in a given list of FixedIn objects. +// +// Example Usage: +// +// fixes := []FixedIn{ +// {Version: "None"}, +// {Version: "1.2.3"}, +// {Version: ""}, +// } +// +// result := CalculateFixed(fixes) +// fmt.Println(result) // Output: 1 +// +// Inputs: +// - Fixes: a slice of FixedIn objects representing the fixes for a vulnerability. +// +// Flow: +// 1. Iterate over each FixedIn object in the Fixes slice. +// 2. Check if the Version field of the current FixedIn object is not equal to "None" and not empty. +// 3. If the condition is true for any FixedIn object, return 1. +// 4. If the loop completes without returning, return 0. +// +// Outputs: +// - An integer representing the number of fixes found in the Fixes slice. func CalculateFixed(Fixes []FixedIn) int { for _, fix := range Fixes { if fix.Version != "None" && fix.Version != "" {