From 4ccbc961929b2951fca461509b30850b0ea8d3dc Mon Sep 17 00:00:00 2001
From: k7sleeper <k7sleeper@gmail.com>
Date: Mon, 20 Jun 2016 14:11:15 +0200
Subject: [PATCH] Added JSDoc

---
 z-schema/z-schema.d.ts | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/z-schema/z-schema.d.ts b/z-schema/z-schema.d.ts
index 317a92247c..763d86a4db 100644
--- a/z-schema/z-schema.d.ts
+++ b/z-schema/z-schema.d.ts
@@ -37,9 +37,30 @@ declare namespace ZSchema {
     }
 
     export class Validator {
-        public static registerFormat(name: string, validator: (value: any) => boolean): void;
+    
+        /**
+         * Register a custom format.
+         *
+         * @param name - format name of the custom format
+         * @param validatorFunction - custom format validator function.
+         *   Returns true if value matches the custom format.
+         */
+        public static registerFormat(formatName: string, validatorFunction: (value: any) => boolean): void;
+
+        /**
+         * Unregister a format.
+         *
+         * @param name - format name of the custom format
+         */
         public static unregisterFormat(name: string): void;
+        
+        /**
+         * Get the list of all registered formats.
+         *
+         * @returns {string[]} the list of all registered format names.
+         */
         public static getRegisteredFormats(): string[];
+        
         public static getDefaultOptions(): Options;
     
         constructor(options: Options);