[Scummvm-git-logs] scummvm master -> c3b2d0267d6dedf23b1aae03f545fb65a9cacb55

[sev-]

This automated email contains information about 1 new commit which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .

Summary:
c3b2d0267d JANITORIAL: Clarify comments


Commit: c3b2d0267d6dedf23b1aae03f545fb65a9cacb55
    https://github.com/scummvm/scummvm/commit/c3b2d0267d6dedf23b1aae03f545fb65a9cacb55
Author: Eugene Sandulenko (sev at scummvm.org)
Date: 2023-01-14T14:42:18+01:00

Commit Message:
JANITORIAL: Clarify comments

Changed paths:
    common/zip-set.h


diff --git a/common/zip-set.h b/common/zip-set.h
index 4bba36d99e0..4d3320b606e 100644
--- a/common/zip-set.h
+++ b/common/zip-set.h
@@ -27,18 +27,20 @@
 namespace Common {
 
 /**
- * Scan the given firectory for a set of versioned zip packs and put then
+ * Scan the given directory for a set of versioned zip packs and put them
  * into the provided SearchSet
  *
  * There are 2 types of files: defaultFile, that could potentially sit
- * in themepath or even built-in into an executable, and so called pack files
- * typically containing creation date in them.
+ * in the themepath or even be built-in into the executable; and so called
+ * pack files typically containing creation date in their names.
  *
  * These files are put in the SearchSet in a sorted way, thus, the latter
  * packs have higher priority.
  *
  * Example: gui-icons.dat, gui-icons-20211112.dat, gui-icons-20220602.dat
  *
+ * Used by: icons packs and shader packs
+ *
  * @param[out] searchSet    The SearchSet to modify
  * @param[in]  defaultFile  Name of the default file
  * @param[in]  packsMask    Mask of the pack files