📝 Add docstrings to fix-processor-linter-warnings

Docstrings generation was requested by @tphakala.

* #412 (comment)

The following files were modified:

* `internal/analysis/processor/execute.go`
* `internal/analysis/processor/processor.go`

internal/analysis/processor/execute.go

@@ -150,7 +150,7 @@ func sanitizeValue(value interface{}) (string, error) {
 	return str, nil
 }
 
-// getCleanEnvironment returns a minimal set of necessary environment variables
+// getCleanEnvironment returns a minimal set of environment variables necessary for safe command execution across different operating systems. It includes essential system paths and optionally adds the SystemRoot variable for Windows systems. The returned slice contains only the required environment variables, helping to maintain a clean and secure execution context.
 func getCleanEnvironment() []string {
 	// Provide only necessary environment variables
 	env := []string{
@@ -167,7 +167,7 @@ func getCleanEnvironment() []string {
 	return env
 }
 
-// getNoteValueByName retrieves a value from a Note by field name using reflection
+// If the field is not found or cannot be interfaced, it returns nil.
 func getNoteValueByName(note *datastore.Note, paramName string) interface{} {
 	val := reflect.ValueOf(*note)
 	fieldVal := val.FieldByName(paramName)

internal/analysis/processor/processor.go

@@ -419,7 +419,7 @@ func (p *Processor) pendingDetectionsFlusher() {
 	}()
 }
 
-// Helper function to check if a slice contains a string (case-insensitive)
+// It returns true if the item is found in the slice, otherwise false.
 func contains(slice []string, item string) bool {
 	for _, s := range slice {
 		if strings.EqualFold(s, item) {
@@ -467,7 +467,7 @@ func (p *Processor) getActionsForItem(detection *Detections) []Action {
 	return p.getDefaultActions(detection)
 }
 
-// Helper function to parse command parameters
+// If a parameter is not found in the detection note, its value will be nil.
 func parseCommandParams(params []string, detection *Detections) map[string]interface{} {
 	commandParams := make(map[string]interface{})
 	for _, param := range params {