pathmath.h: clarified how matching paths work [skip ci]

danmar · Feb 15, 2025 · 2201168 · 2201168
1 parent cf72e3b
commit 2201168
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/pathmatch.h b/lib/pathmatch.h
@@ -35,6 +35,9 @@ class CPPCHECKLIB PathMatch {
 
     /**
      * The constructor.
+     *
+     * If a path is a directory it needs to end with a file separator.
+     *
      * @param paths List of masks.
      * @param caseSensitive Match the case of the characters when
      *   matching paths?
@@ -43,6 +46,9 @@ class CPPCHECKLIB PathMatch {
 
     /**
      * @brief Match path against list of masks.
+     *
+     * If you want to match a directory the given path needs to end with a path separator.
+     *
      * @param path Path to match.
      * @return true if any of the masks match the path, false otherwise.
      */