From 3e3240f7ed52c035f3f68d50836f089bd2d03409 Mon Sep 17 00:00:00 2001
From: =?utf8?q?J=C3=B6rn=20Zaefferer?= <joern.zaefferer@gmail.com>
Date: Mon, 11 Dec 2006 09:38:03 +0000
Subject: [PATCH] Fixed docs for #134

---
 src/event/event.js |   16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

diff --git a/src/event/event.js b/src/event/event.js
index b480857..9f90321 100644
--- a/src/event/event.js
+++ b/src/event/event.js
@@ -228,9 +228,11 @@ new function(){
 		/**
 		 * Bind a function to the submit event of each matched element.
 		 *
-		 * @example $("p").submit( function() { alert("Hello"); } );
-		 * @before <p>Hello</p>
-		 * @result <p onsubmit="alert('Hello');">Hello</p>
+		 * @example $("#myform").submit( function() {
+		 *   return $("input", this).val().length > 0;
+		 * } );
+		 * @before <form id="myform"><input /></form>
+		 * @desc Prevents the form submission when the input has no value entered.
 		 *
 		 * @name submit
 		 * @type jQuery
@@ -242,9 +244,11 @@ new function(){
 		 * Trigger the submit event of each matched element. This causes all of the functions
 		 * that have been bound to thet submit event to be executed.
 		 *
-		 * @example $("p").submit();
-		 * @before <p onsubmit="alert('Hello');">Hello</p>
-		 * @result alert('Hello');
+		 * Note: This does not execute the submit method of the form element! If you need to
+		 * submit the form via code, you have to use the DOM method, eg. $("form")[0].submit();
+		 *
+		 * @example $("form").submit();
+		 * @desc Triggers all submit events registered for forms, but does not submit the form
 		 *
 		 * @name submit
 		 * @type jQuery
-- 
1.7.10.4