From 388f566eae857f23e8a1322e3daf2d15907aebcc Mon Sep 17 00:00:00 2001
From: Martin Karkowski <m.karkowski@zema.de>
Date: Tue, 2 Aug 2022 22:33:38 +0200
Subject: [PATCH] adding comments

---
 lib/helpers/path.ts | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/lib/helpers/path.ts b/lib/helpers/path.ts
index a902c27..2d930ac 100644
--- a/lib/helpers/path.ts
+++ b/lib/helpers/path.ts
@@ -16,7 +16,13 @@ export function convertPath(path: string): string {
 }
 
 /**
+ * Returns the least common segmet of all pathes, included in the pathes array.
+ * 
+ * The Following options are available.
  *
+ * "considerSingleLevel":boolean -> allows "singlelevel"-wildcards in the segments
+ * "considerMultiLevel":boolean -> allows "multilevel"-wildcards in the segments
+ * 
  * @param pathes The Segments to compare
  * @param opts Additional Options.
  * @returns