aboutsummaryrefslogtreecommitdiffstats
path: root/src/jquery/jquery.js
diff options
context:
space:
mode:
Diffstat (limited to 'src/jquery/jquery.js')
-rw-r--r--src/jquery/jquery.js8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/jquery/jquery.js b/src/jquery/jquery.js
index 46019bf94..ddcddce06 100644
--- a/src/jquery/jquery.js
+++ b/src/jquery/jquery.js
@@ -154,10 +154,18 @@ var $ = jQuery;
* });
* @desc Executes the function when the DOM is ready to be used.
*
+ * @example jQuery(function($) {
+ * // Your code using failsafe $ alias here...
+ * });
+ * @desc Uses both the shortcut for $(document).ready() and the argument
+ * to write failsafe jQuery code using the $ alias, without relying on the
+ * global alias.
+ *
* @name $
* @param Function fn The function to execute when the DOM is ready.
* @cat Core
* @type jQuery
+ * @see ready(Function)
*/
jQuery.fn = jQuery.prototype = {