From d5baa434baf3acbaf5bec0a342b038f920a11034 Mon Sep 17 00:00:00 2001
From: Brian Dukes <bdukes@engagesoftware.com>
Date: Fri, 9 Jan 2015 14:47:20 -0600
Subject: [PATCH] Add JSDoc to jquery.tipsy

---
 jquery.tipsy/jquery.tipsy.d.ts | 95 +++++++++++++++++++++++++++++-----
 1 file changed, 83 insertions(+), 12 deletions(-)

diff --git a/jquery.tipsy/jquery.tipsy.d.ts b/jquery.tipsy/jquery.tipsy.d.ts
index 097f7ece8..d586eefbd 100644
--- a/jquery.tipsy/jquery.tipsy.d.ts
+++ b/jquery.tipsy/jquery.tipsy.d.ts
@@ -1,36 +1,107 @@
 // Type definitions for jQuery.tipsy
 // Project: http://onehackoranother.com/projects/jquery/tipsy/
-//          https://github.com/jaz303/tipsy
 // Definitions by: Brian Dukes <https://github.com/bdukes/>
 // Definitions: https://github.com/borisyankov/DefinitelyTyped
 
 /// <reference path="../jquery/jquery.d.ts"/>
 
 interface JQuery {
+    /**
+    * initialize tipsy plugin
+    */
     tipsy: JQueryTipsy.Tipsy;
 }
 
-
-declare module JQueryTipsy {
-    interface Tipsy {
-        (options?: Options): JQuery;
-        autoNS: () => string;
-        autoWE: () => string;
-        autoSWSE: () => string;
-        autoNWNE: () => string;
-    }
-
+declare module JQueryTipsy {
     interface Options {
+        /**
+        * delay before showing tooltip (ms)
+        * 
+        * default: 0
+        */
         delayIn?: number;
+        /**
+        * delay before hiding  tooltip (ms)
+        * 
+        * default: 0
+        */
         delayOut?: number;
+        /**
+        * fade tooltips in/out?
+        * 
+        * default: false
+        */
         fade?: boolean;
+        /**
+        * fallback text to use when no tooltip text
+        * 
+        * default: ''
+        */
         fallback?: string;
+        /**
+        * gravity
+        * 
+        * default: 'n'
+        */
         gravity?: any; // string or () => string
+        /**
+        * is tooltip content HTML?
+        * 
+        * default: false
+        */
         html?: boolean;
+        /**
+        * use live event support?
+        * 
+        * default: false
+        */
         live?: boolean;
+        /**
+        * pixel offset of tooltip from element
+        * 
+        * default: 0
+        */
         offset?: number;
+        /**
+        * opacity of tooltip
+        * 
+        * default: 0.8
+        */
         opacity?: number;
+        /**
+        * attribute/callback containing tooltip text
+        * 
+        * default: 'title'
+        */
         title?: any; // string or () => string
+        /**
+        * how tooltip is triggered - hover | focus | manual
+        * 
+        * default: 'hover'
+        */
         trigger?: string;
-    }
+    }
+
+    interface Tipsy {
+        /**
+        * initialize tipsy plugin
+        */
+        (options?: Options): JQuery;
+        /**
+        * determine gravity either to North or South automatically based on the element's location in the viewport
+        */
+        autoNS: () => string;
+        /**
+        * determine gravity either to West or East automatically based on the element's location in the viewport
+        */
+        autoWE: () => string;
+        /**
+        * determine gravity either to Southwest or Southeast automatically based on the element's location in the viewport
+        */
+        autoSWSE: () => string;
+        /**
+        * determine gravity either to Northwest or Northeast automatically based on the element's location in the viewport
+        */
+        autoNWNE: () => string;
+    }
 }