joerg 2003/07/14 14:05:48
Modified:
src/blocks/jxforms/java/org/apache/cocoon/components/jxforms/xmlform
FormListener.java Form.java
src/blocks/jxforms/java/org/apache/cocoon/components/jxforms/validation
Schema.java
src/blocks/jxforms/java/org/apache/cocoon/components/jxforms/validation/schematron
SchematronFactory.java
Log:
fixed javadoc warnings (empty @return)
Revision Changes Path
1.2 +5 -6
cocoon-2.1/src/blocks/jxforms/java/org/apache/cocoon/components/jxforms/xmlform/FormListener.java
Index: FormListener.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/jxforms/java/org/apache/cocoon/components/jxforms/xmlform/FormListener.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- FormListener.java 12 Jul 2003 19:22:30 -0000 1.1
+++ FormListener.java 14 Jul 2003 21:05:48 -0000 1.2
@@ -72,18 +72,17 @@
* This method does nothing by default
* Subclasses should override it to implement custom logic
*
- * @param form
+ * @param form
*/
void reset(Form form);
/**
- * Filters custom request parameter
- * not refering to the model.
+ * Filters custom request parameter not refering to the model.
*
- * @param form
+ * @param form
* @param parameterName
*
- * @return
+ * @return boolean
*/
boolean filterRequestParameter(Form form, String parameterName);
}
1.2 +12 -15
cocoon-2.1/src/blocks/jxforms/java/org/apache/cocoon/components/jxforms/xmlform/Form.java
Index: Form.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/jxforms/java/org/apache/cocoon/components/jxforms/xmlform/Form.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Form.java 12 Jul 2003 19:22:30 -0000 1.1
+++ Form.java 14 Jul 2003 21:05:48 -0000 1.2
@@ -309,10 +309,9 @@
}
/**
- * Performs complete validation
- * of the form model.
+ * Performs complete validation of the form model.
*
- * @return
+ * @return boolean
*/
public boolean validate() {
return validate(null);
@@ -535,13 +534,12 @@
/**
* Filters custom request parameter not refering to the model.
*
- * TODO: implement default filtering
- * for standard Cocoon parameters
- * like cocoon-action[-suffix]
+ * TODO: implement default filtering for standard Cocoon parameters like
+ * cocoon-action[-suffix]
*
* @param name
*
- * @return
+ * @return boolean
*/
protected boolean filterRequestParameter(String name) {
// filter standard cocoon-* parameters
@@ -577,7 +575,7 @@
*
* @param paramName
*
- * @return
+ * @return boolean
*/
protected boolean filterDefaultRequestParameter(String paramName) {
if (paramName.startsWith(Constants.ACTION_PARAM_PREFIX) ||
@@ -592,12 +590,11 @@
}
/**
- * Try to extract from the request
- * and return the current form view
+ * Try to extract from the request and return the current form view.
*
* @param sitemapObjectModel
*
- * @return
+ * @return String
*/
public String getFormView(Map sitemapObjectModel) {
return
getRequest(sitemapObjectModel).getParameter(Form.FORM_VIEW_PARAM);
@@ -632,12 +629,12 @@
}
/**
- * Loads a form from the request or session
+ * Loads a form from the request or session.
*
* @param sitemapObjectModel
* @param id the form id
*
- * @return
+ * @return the form if found in request or session or null.
*/
public static Form lookup(Map sitemapObjectModel, String id) {
Request request = getRequest(sitemapObjectModel);
@@ -782,7 +779,7 @@
*
* @param viewName
*
- * @return
+ * @return FormViewState
*/
protected FormViewState getFormViewState(String viewName) {
FormViewState formViewState = (FormViewState)
viewStateMap_.get(viewName);
1.2 +2 -2
cocoon-2.1/src/blocks/jxforms/java/org/apache/cocoon/components/jxforms/validation/Schema.java
Index: Schema.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/jxforms/java/org/apache/cocoon/components/jxforms/validation/Schema.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Schema.java 12 Jul 2003 19:22:29 -0000 1.1
+++ Schema.java 14 Jul 2003 21:05:48 -0000 1.2
@@ -60,7 +60,7 @@
/**
*
*
- * @return
+ * @return org.apache.cocoon.components.jxforms.validation.Validator
*/
Validator newValidator() throws InstantiationException;
1.2 +2 -2
cocoon-2.1/src/blocks/jxforms/java/org/apache/cocoon/components/jxforms/validation/schematron/SchematronFactory.java
Index: SchematronFactory.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/jxforms/java/org/apache/cocoon/components/jxforms/validation/schematron/SchematronFactory.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- SchematronFactory.java 12 Jul 2003 19:22:30 -0000 1.1
+++ SchematronFactory.java 14 Jul 2003 21:05:48 -0000 1.2
@@ -425,7 +425,7 @@
*
* @param path
*
- * @return
+ * @return java.lang.String
*/
protected String fixns(String path) {
// Ironicly, at the time I am writing this
