Add comment to convertGlobToRegExp

Author: sophiebremer

lib/JSON.d.ts

@@ -24,6 +24,16 @@ export declare namespace JSON {
         (this: T, key: string, value: T[keyof T]): any;
     }
     type Type = (Array | Object | Primitive);
+    /**
+     * Converts simple glob patterns to RegExp patterns that can be used in the
+     * {@link extractWithPatterns} function.
+     *
+     * @param glob
+     * Glob pattern to convert.
+     *
+     * @return
+     * Converted RegExp pattern out of the glob pattern.
+     */
     function convertGlobToRegExp(glob: string): RegExp;
     /**
      * Extracts a path in a JSON object and returns the found portion.

lib/JSON.js

@@ -10,30 +10,36 @@
 
 \*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*i*/
 
+
 /* *
  *
  *  Declarations
  *
  * */
 
+
 export type ESArray<T> = Array<T>;
 
 export type JSON = ( JSON.Array | JSON.Object );
 
+
 /* *
  *
  *  Namespace
  *
  * */
 
+
 export namespace JSON {
 
+
     /* *
      *
      *  Declarations
      *
      * */
 
+
     export interface Array extends ESArray<Type>, Record<number, Type> {
         // nothing to add
     }
@@ -61,12 +67,24 @@ export namespace JSON {
     }
     export type Type = ( Array | Object | Primitive );
 
+
     /* *
      *
      *  Functions
      *
      * */
 
+
+    /**
+     * Converts simple glob patterns to RegExp patterns that can be used in the
+     * {@link extractWithPatterns} function.
+     *
+     * @param glob
+     * Glob pattern to convert.
+     *
+     * @return
+     * Converted RegExp pattern out of the glob pattern.
+     */
     export function convertGlobToRegExp (
         glob: string
     ): RegExp {