From 22011681aa3ec2f5442de164a38b3709aebf847c Mon Sep 17 00:00:00 2001
From: firewave <firewave@users.noreply.github.com>
Date: Sat, 15 Feb 2025 07:54:06 +0100
Subject: [PATCH] pathmath.h: clarified how matching paths work [skip ci]

---
 lib/pathmatch.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/lib/pathmatch.h b/lib/pathmatch.h
index 4ee7eea6c15..f0ace4fbc94 100644
--- 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.
      */