Added all the callabcks as events, updated the docs, demos, and depre…

…cated 'click' in favour of 'tap'
tuanha · Mar 13, 2013 · ad506d5 · ad506d5
1 parent 1440a82
commit ad506d5
Show file tree

Hide file tree

Showing 14 changed files with 218 additions and 74 deletions.
diff --git a/docs/files.html b/docs/files.html
@@ -87,7 +87,7 @@ <h1 class="classTitle">File Index</h1>
 	</div>
 	<footer class="footer">
 
-		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Jan 23 2013 17:52:44 GMT-0000 (GMT)</p>
+		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Mar 13 2013 23:05:16 GMT-0000 (GMT)</p>
 	</footer>
 	<script type="text/javascript">
 		<!--

diff --git a/docs/index.html b/docs/index.html
@@ -379,7 +379,7 @@ <h1 class="classTitle">Class Index</h1>
 		</div>
 		<footer class="footer">
 
-			<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Jan 23 2013 17:52:44 GMT-0000 (GMT)</p>
+			<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Mar 13 2013 23:05:16 GMT-0000 (GMT)</p>
 		</footer>
 	</div>
 </body>

diff --git a/docs/symbols/$.fn.html b/docs/symbols/$.fn.html
@@ -165,7 +165,7 @@ <h3>Constructor</h3>
 <!-- ============================== footer ================================= -->
 	<footer class="footer">
 
-		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Jan 23 2013 17:52:43 GMT-0000 (GMT)</p>
+		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Mar 13 2013 23:05:15 GMT-0000 (GMT)</p>
 	</footer>
 </div></body>
 </html>
diff --git a/docs/symbols/$.fn.swipe.defaults.html b/docs/symbols/$.fn.swipe.defaults.html
@@ -179,34 +179,6 @@ <h4>Instance Properties<span class="jsdoc-inherits-caption pull-right">Defined B
 
 
 
-									</div>
-								</div>
-							</div>
-
-							<div class="jsdoc-member">
-								<div class="jsdoc-member-definition">
-									<b><a id="click" href="../symbols/%24.fn.swipe.defaults.html#click">click</a></b>
-									 : function
-									<span class="jsdoc-member-default">(default = null)</span>
-
-
-
-
-									<span class="jsdoc-inherits-from pull-right"><a href="../symbols/%24.fn.swipe.defaults.html">$.fn.swipe.defaults</a></span>
-								</div>
-								<div class="jsdoc-member-description">
-									<div class="jsdoc-member-content">
-										<div class="jsdoc-member-summary">
-											A handler triggered when a user just clicks on the item, rather than swipes it. If they do not move, click is triggered, if they do move, it is not.
-											<span class="pull-right"><a href="../symbols/src/jquery.touchSwipe.js.html">code »</a></span>
-										</div>
-
-
-
-
-
-
-
 									</div>
 								</div>
 							</div>
@@ -627,6 +599,34 @@ <h4>Instance Properties<span class="jsdoc-inherits-caption pull-right">Defined B
 
 
 
+									</div>
+								</div>
+							</div>
+
+							<div class="jsdoc-member">
+								<div class="jsdoc-member-definition">
+									<b><a id="tap" href="../symbols/%24.fn.swipe.defaults.html#tap">tap</a></b>
+									 : function
+									<span class="jsdoc-member-default">(default = null)</span>
+
+
+
+
+									<span class="jsdoc-inherits-from pull-right"><a href="../symbols/%24.fn.swipe.defaults.html">$.fn.swipe.defaults</a></span>
+								</div>
+								<div class="jsdoc-member-description">
+									<div class="jsdoc-member-content">
+										<div class="jsdoc-member-summary">
+											A handler triggered when a user just taps on the item, rather than swipes it. If they do not move, tap is triggered, if they do move, it is not.
+											<span class="pull-right"><a href="../symbols/src/jquery.touchSwipe.js.html">code »</a></span>
+										</div>
+
+
+
+
+
+
+
 									</div>
 								</div>
 							</div>
@@ -736,7 +736,7 @@ <h4>Instance Properties<span class="jsdoc-inherits-caption pull-right">Defined B
 <!-- ============================== footer ================================= -->
 	<footer class="footer">
 
-		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Jan 23 2013 17:52:43 GMT-0000 (GMT)</p>
+		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Mar 13 2013 23:05:16 GMT-0000 (GMT)</p>
 	</footer>
 </div></body>
 </html>
diff --git a/docs/symbols/$.fn.swipe.directions.html b/docs/symbols/$.fn.swipe.directions.html
@@ -340,7 +340,7 @@ <h4>Instance Properties<span class="jsdoc-inherits-caption pull-right">Defined B
 <!-- ============================== footer ================================= -->
 	<footer class="footer">
 
-		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Jan 23 2013 17:52:43 GMT-0000 (GMT)</p>
+		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Mar 13 2013 23:05:16 GMT-0000 (GMT)</p>
 	</footer>
 </div></body>
 </html>
diff --git a/docs/symbols/$.fn.swipe.fingers.html b/docs/symbols/$.fn.swipe.fingers.html
@@ -285,7 +285,7 @@ <h4>Instance Properties<span class="jsdoc-inherits-caption pull-right">Defined B
 <!-- ============================== footer ================================= -->
 	<footer class="footer">
 
-		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Jan 23 2013 17:52:43 GMT-0000 (GMT)</p>
+		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Mar 13 2013 23:05:16 GMT-0000 (GMT)</p>
 	</footer>
 </div></body>
 </html>
diff --git a/docs/symbols/$.fn.swipe.html b/docs/symbols/$.fn.swipe.html
@@ -520,7 +520,7 @@ <h4>Nested namespaces<span class="jsdoc-inherits-caption pull-right">Defined By<
 					<h3>Events<span class="jsdoc-inherits-caption pull-right">Defined By</span></h3>
 					<div class="jsdoc-members">
 
-							<div class="jsdoc-member accordion-button">
+							<div class="jsdoc-member accordion-button container-jsdoc-deprecated">
 								<div class="jsdoc-member-definition">
 									<div class="jsdoc-member-content">
 										<i class="icon-jsdoc icon-jsdoc-event"></i>
@@ -537,10 +537,18 @@ <h3>Events<span class="jsdoc-inherits-caption pull-right">Defined By</span></h3>
 									<div class="jsdoc-member-content">
 										<div class="jsdoc-member-summary">
 											A click handler triggered when a user simply clicks, rather than swipes on an element.
+This is deprecated since version 1.6.2, any assignment to click will be assigned to the tap handler.
+You cannot use <code>on</code> to bind to this event as the default jQ <code>click</code> event will be triggered.
+Use the <code>tap</code> event instead.
 											<span class="pull-right"><a href="../symbols/src/jquery.touchSwipe.js.html">code »</a></span>
 										</div>
 
 
+											<div class="jsdoc-member-deprecated jsdoc-member-info">
+												<span class="label label-jsdoc label-jsdoc-deprecated">Deprecated</span>
+												since version 1.6.2, please use $.fn.swipe#tap instead
+											</div>
+
 
 
 
@@ -1074,6 +1082,52 @@ <h3>Events<span class="jsdoc-inherits-caption pull-right">Defined By</span></h3>
 								</div>
 							</div>
 
+							<div class="jsdoc-member accordion-button">
+								<div class="jsdoc-member-definition">
+									<div class="jsdoc-member-content">
+										<i class="icon-jsdoc icon-jsdoc-event"></i>
+										<b><a id="event:tap" href="../symbols/%24.fn.swipe.html#event:tap">tap</a></b>
+										<span class="signature">( <span class="jsdoc-typedesc">EventObject</span> event, <span class="jsdoc-typedesc">DomObject</span> target )</span>
+
+
+
+
+										<span class="jsdoc-inherits-from pull-right"><a href="../symbols/%24.fn.swipe.html">$.fn.swipe</a></span>
+									</div>
+								</div>
+								<div class="jsdoc-member-description">
+									<div class="jsdoc-member-content">
+										<div class="jsdoc-member-summary">
+											A click / tap handler triggered when a user simply clicks or taps, rather than swipes on an element.
+											<span class="pull-right"><a href="../symbols/src/jquery.touchSwipe.js.html">code »</a></span>
+										</div>
+
+
+
+
+
+
+
+											<div class="jsdoc-member-detail accordion-content">
+
+													<b>Parameters</b>
+													<dl>
+
+															<dt>event : <span class="jsdoc-typedesc">EventObject</span> </dt>
+															<dd>The original event object</dd>
+
+															<dt>target : <span class="jsdoc-typedesc">DomObject</span> </dt>
+															<dd>The element clicked on.</dd>
+
+													</dl>
+
+
+											</div>
+
+									</div>
+								</div>
+							</div>
+
 					</div>
 
 
@@ -1084,7 +1138,7 @@ <h3>Events<span class="jsdoc-inherits-caption pull-right">Defined By</span></h3>
 <!-- ============================== footer ================================= -->
 	<footer class="footer">
 
-		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Jan 23 2013 17:52:43 GMT-0000 (GMT)</p>
+		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Mar 13 2013 23:05:15 GMT-0000 (GMT)</p>
 	</footer>
 </div></body>
 </html>
diff --git a/docs/symbols/$.fn.swipe.pageScroll.html b/docs/symbols/$.fn.swipe.pageScroll.html
@@ -284,7 +284,7 @@ <h4>Instance Properties<span class="jsdoc-inherits-caption pull-right">Defined B
 <!-- ============================== footer ================================= -->
 	<footer class="footer">
 
-		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Jan 23 2013 17:52:43 GMT-0000 (GMT)</p>
+		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Mar 13 2013 23:05:16 GMT-0000 (GMT)</p>
 	</footer>
 </div></body>
 </html>
diff --git a/docs/symbols/$.fn.swipe.phases.html b/docs/symbols/$.fn.swipe.phases.html
@@ -284,7 +284,7 @@ <h4>Instance Properties<span class="jsdoc-inherits-caption pull-right">Defined B
 <!-- ============================== footer ================================= -->
 	<footer class="footer">
 
-		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Jan 23 2013 17:52:43 GMT-0000 (GMT)</p>
+		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Mar 13 2013 23:05:16 GMT-0000 (GMT)</p>
 	</footer>
 </div></body>
 </html>
diff --git a/docs/symbols/$.html b/docs/symbols/$.html
@@ -165,7 +165,7 @@ <h3>Constructor</h3>
 <!-- ============================== footer ================================= -->
 	<footer class="footer">
 
-		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Jan 23 2013 17:52:43 GMT-0000 (GMT)</p>
+		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Mar 13 2013 23:05:15 GMT-0000 (GMT)</p>
 	</footer>
 </div></body>
 </html>
diff --git a/docs/symbols/_global_.html b/docs/symbols/_global_.html
@@ -130,7 +130,7 @@ <h1 class="classTitle">
 <!-- ============================== footer ================================= -->
 	<footer class="footer">
 
-		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Jan 23 2013 17:52:43 GMT-0000 (GMT)</p>
+		<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Wed Mar 13 2013 23:05:16 GMT-0000 (GMT)</p>
 	</footer>
 </div></body>
 </html>