Title: [waffle-scm] [750] trunk/waffle-resources/src/main/resources/js/waffle/action.js: Updated docs.
Revision
750
Author
mauro
Date
2008-06-21 05:20:20 -0500 (Sat, 21 Jun 2008)

Log Message

Updated docs.

Modified Paths


Diff

Modified: trunk/waffle-resources/src/main/resources/js/waffle/action.js (749 => 750)

--- trunk/waffle-resources/src/main/resources/js/waffle/action.js	2008-06-21 08:34:36 UTC (rev 749)
+++ trunk/waffle-resources/src/main/resources/js/waffle/action.js	2008-06-21 10:20:20 UTC (rev 750)
@@ -1,12 +1,20 @@
-/*****************************************************************************
- * Copyright (C) 2005,2006 Michael Ward                                      *
- * All rights reserved.                                                      *
- * ------------------------------------------------------------------------- *
- * The software in this package is published under the terms of the BSD      *
- * style license a copy of which has been included with this distribution in *
- * the LICENSE.txt file.                                                     *
- *****************************************************************************/
+/*
+ * Copyright (c) terms as published in http://waffle.codehaus.org/license.html
+ */
 
+/**
+ * _javascript_ functions for Waffle web applications
+ *
+ * @author Michael Ward
+ * @author Mauro Talevi
+ */
+
+/**
+ * Returns a document form by id or the first one in the document if id is null.
+ * 
+ * @param formId the id of the form
+ * @return The document form
+ */
 function findForm(formId) {
   if(formId == null) {
     return document.forms[0];
@@ -16,7 +24,9 @@
 }
 
 /**
- * @param methodName
+ * Fires action method for given method name and form id
+ *
+ * @param methodName the method name
  * @param formId reference to the form id (optional)
  */
 function fireActionMethod(methodName, formId) {
@@ -25,7 +35,9 @@
 }
 
 /**
- * @param methodName
+ * Fires action method with multipart encoding for given method name and form id
+ *
+ * @param methodName the method name
  * @param formId reference to the form id (optional)
  */
 function fireMultipartActionMethod(methodName, formId) {
@@ -35,6 +47,12 @@
   submitInputMethod(form, methodName);
 }
 
+/**
+ * Submits hidden input form with action method name as attribute
+ *
+ * @param form the document form to submit
+ * @param methodName the method name
+ */
 function submitInputMethod(form, methodName) {
   var method = document.createElement("input");
   method.setAttribute("type", "hidden");


To unsubscribe from this list please visit:

http://xircles.codehaus.org/manage_email

Reply via email to