summaryrefslogtreecommitdiff
path: root/lib/scripts/behaviour.js
diff options
context:
space:
mode:
authorAndreas Gohr <andi@splitbrain.org>2011-08-18 11:36:18 +0200
committerAndreas Gohr <andi@splitbrain.org>2011-08-18 11:37:51 +0200
commit20e3e8ebefec296327d39fb572b06d60c151c867 (patch)
tree65c53bbdf03fd7514846f57323493ce7e5f3898f /lib/scripts/behaviour.js
parent5b812846ce6a2e72e388adbb0dcaadbc0137b173 (diff)
downloadrpg-20e3e8ebefec296327d39fb572b06d60c151c867.tar.gz
rpg-20e3e8ebefec296327d39fb572b06d60c151c867.tar.bz2
added some function comments
Diffstat (limited to 'lib/scripts/behaviour.js')
-rw-r--r--lib/scripts/behaviour.js21
1 files changed, 19 insertions, 2 deletions
diff --git a/lib/scripts/behaviour.js b/lib/scripts/behaviour.js
index aadf74a1c..6012e5d1d 100644
--- a/lib/scripts/behaviour.js
+++ b/lib/scripts/behaviour.js
@@ -112,14 +112,31 @@ var dw_behaviour = {
};
+/**
+ * Hides elements with a slide animation
+ *
+ * @param fn optional callback to run after hiding
+ * @author Adrian Lang <mail@adrianlang.de>
+ */
jQuery.fn.dw_hide = function(fn) {
return this.slideUp('fast', fn);
};
-jQuery.fn.dw_show = function() {
- return this.slideDown('fast');
+/**
+ * Unhides elements with a slide animation
+ *
+ * @param fn optional callback to run after hiding
+ * @author Adrian Lang <mail@adrianlang.de>
+ */
+jQuery.fn.dw_show = function(fn) {
+ return this.slideDown('fast', fn);
};
+/**
+ * Toggles visibility of an element using a slide element
+ *
+ * @param bool the current state of the element (optional)
+ */
jQuery.fn.dw_toggle = function(bool) {
return this.each(function() {
var $this = jQuery(this);