[preprocessor/folder] add function comment

preprocessor/folder/file.go

@@ -84,6 +84,8 @@ func getFileMetadata(filePath string, mediaType string) (map[string]any, error)
 	}, nil
 }
 
+// checkFileType checks if the file is a zip based special file type
+// that we will handle differently
 func checkFileType(filePath string) (string, string, error) {
 	fileType := "generic" // default is generic
 	file, err := os.Open(filePath)

util/proofmode.go

@@ -56,6 +56,7 @@ func validateAndParseProofModeFileSignatures(fileMap map[string]*zip.File, fileN
 	if err != nil {
 		return nil, err
 	}
+	// TODO: check key against db https://github.com/starlinglab/integrity-v2/issues/25
 	keyRing, err := openpgp.ReadArmoredKeyRing(bytes.NewReader(keyFileBytes))
 	if err != nil {
 		return nil, err
@@ -178,6 +179,8 @@ func validateAndParseProofModeFileSignatures(fileMap map[string]*zip.File, fileN
 	return &fileData, nil
 }
 
+// parseProofModeBundleAssetInfo reads the files in the zip
+// and returns a map of files and the json metadata files
 func parseProofModeBundleAssetInfo(zipReader *zip.ReadCloser) (map[string]*zip.File, [][]byte, error) {
 	var jsonFilesBytes [][]byte
 	fileMap := map[string]*zip.File{}
@@ -200,6 +203,7 @@ func parseProofModeBundleAssetInfo(zipReader *zip.ReadCloser) (map[string]*zip.F
 	return fileMap, jsonFilesBytes, nil
 }
 
+// CheckIsProofModeFile checks if the file is a proofmode file
 func CheckIsProofModeFile(filePath string) bool {
 	if filepath.Ext(filePath) != ".zip" {
 		return false