joerg 2004/04/30 17:05:45
Modified: src/blocks/portal/java/org/apache/cocoon/environment/portlet
ActionResponse.java PortletSession.java
PortletEnvironment.java
src/blocks/javaflow/java/org/apache/cocoon/forms/flow/java
FormInstance.java
src/blocks/xsp/java/org/apache/cocoon/components/language/markup
CocoonMarkupLanguage.java
AbstractMarkupLanguage.java
src/blocks/forms/java/org/apache/cocoon/forms/binding
CustomJXPathBinding.java AbstractCustomBinding.java
src/blocks/forms/java/org/apache/cocoon/forms/formmodel
AbstractContainerWidget.java AbstractWidget.java
Form.java
src/java/org/apache/cocoon/components/modules/input
JXPathHelperConfiguration.java
src/blocks/forms/java/org/apache/cocoon/forms/samples/bindings
DateWrapper.java CustomValueWrapBinding.java
Log:
javadoc fixes:
@see is no inline tag, so must not be used via [EMAIL PROTECTED] reference},
use [EMAIL PROTECTED] reference} instead
@inheritDoc is an inline tag, so must be surrounded with curly braces: [EMAIL
PROTECTED]
Revision Changes Path
1.3 +5 -5
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/environment/portlet/ActionResponse.java
Index: ActionResponse.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/environment/portlet/ActionResponse.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ActionResponse.java 5 Mar 2004 13:02:08 -0000 1.2
+++ ActionResponse.java 1 May 2004 00:05:44 -0000 1.3
@@ -44,7 +44,7 @@
/**
* Creates a ActionResponse based on a real
- * [EMAIL PROTECTED] ActionResponse} object
+ * [EMAIL PROTECTED] ActionResponse} object
*/
protected ActionResponse(javax.portlet.ActionResponse response,
PortletPreferences preferences,
@@ -108,8 +108,8 @@
*
* Redirects to self (starting with the question mark) are processed
* differently from other redirects: redirect parameters are parsed and
- * set on response using [EMAIL PROTECTED]
ActionResponse#setRenderParameter(String, String)}
- * method, [EMAIL PROTECTED] ActionResponse#sendRedirect(String)} method
is not called.
+ * set on response using [EMAIL PROTECTED]
ActionResponse#setRenderParameter(String, String)}
+ * method, [EMAIL PROTECTED] ActionResponse#sendRedirect(String)} method
is not called.
*
* @param location
* @throws IOException
@@ -162,7 +162,7 @@
// ActionResponse API methods
/**
- * Type cast portletResponse to [EMAIL PROTECTED] ActionResponse}
+ * Type cast portletResponse to [EMAIL PROTECTED] ActionResponse}
*
* @return type casted portletResponse
*/
1.3 +2 -2
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/environment/portlet/PortletSession.java
Index: PortletSession.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/environment/portlet/PortletSession.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- PortletSession.java 5 Mar 2004 13:02:08 -0000 1.2
+++ PortletSession.java 1 May 2004 00:05:44 -0000 1.3
@@ -24,7 +24,7 @@
* Provides access to the JSR-168 (Portlet) environment session.
*
* Portlet scope and application scope session attributes are differentiated
- * using attribute name prefix, [EMAIL PROTECTED]
PortletEnvironment#SESSION_APPLICATION_SCOPE}.
+ * using attribute name prefix, [EMAIL PROTECTED]
PortletEnvironment#SESSION_APPLICATION_SCOPE}.
*
* @see javax.portlet.PortletSession
* @author <a href="mailto:[EMAIL PROTECTED]">Alex Rudnev</a>
1.3 +2 -2
cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/environment/portlet/PortletEnvironment.java
Index: PortletEnvironment.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/portal/java/org/apache/cocoon/environment/portlet/PortletEnvironment.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- PortletEnvironment.java 5 Mar 2004 13:02:08 -0000 1.2
+++ PortletEnvironment.java 1 May 2004 00:05:44 -0000 1.3
@@ -202,7 +202,7 @@
}
/**
- * In portlet environment this is the same as [EMAIL PROTECTED]
#redirect(boolean, String)}
+ * In portlet environment this is the same as [EMAIL PROTECTED]
#redirect(boolean, String)}
*/
public void permanentRedirect(boolean sessionmode, String newURL) throws
IOException {
redirect(sessionmode, newURL);
1.9 +10 -10
cocoon-2.1/src/blocks/javaflow/java/org/apache/cocoon/forms/flow/java/FormInstance.java
Index: FormInstance.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/javaflow/java/org/apache/cocoon/forms/flow/java/FormInstance.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- FormInstance.java 25 Apr 2004 12:12:08 -0000 1.8
+++ FormInstance.java 1 May 2004 00:05:44 -0000 1.9
@@ -163,8 +163,8 @@
* - "isValid" : true if the form was sucessfully validated
* - "submitId" : the id of the widget that triggered the form submit
(can be null)
*
- * @parameter uri the page uri (like in cocoon.sendPageAndWait())
- * @parameter bizdata some business data for the view (like in
cocoon.sendPageAndWait()).
+ * @param uri the page uri (like in cocoon.sendPageAndWait())
+ * @param bizData some business data for the view (like in
cocoon.sendPageAndWait()).
* The "{FormsPipelineConfig.CFORMSKEY}" and "locale"
properties are added to this object.
*/
public void show(String uri, Object bizData) {
@@ -209,18 +209,18 @@
} while(!finished);
}
-
+ /*
/**
* Manages the display of a form and its validation.
- * @parameter uri the page uri (like in cocoon.sendPageAndWait())
- * @parameter fun optional function which will be executed after pipeline
+ * @param uri the page uri (like in cocoon.sendPageAndWait())
+ * @param fun optional function which will be executed after pipeline
* processing. Useful for releasing resources needed during pipeline
* processing but which should not become part of the continuation
- * @parameter ttl Time to live (in milliseconds) for the continuation
+ * @param ttl Time to live (in milliseconds) for the continuation
* created
- * @returns The web continuation associated with submitting this form
- */
-/* public showForm(String uri, Object fun, ttl) {
+ * @return The web continuation associated with submitting this form
+ *
+ public showForm(String uri, Object fun, ttl) {
if (!this.getBookmark()) {
this.setBookmark();
}
1.3 +4 -2
cocoon-2.1/src/blocks/xsp/java/org/apache/cocoon/components/language/markup/CocoonMarkupLanguage.java
Index: CocoonMarkupLanguage.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/xsp/java/org/apache/cocoon/components/language/markup/CocoonMarkupLanguage.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- CocoonMarkupLanguage.java 20 Mar 2004 13:30:48 -0000 1.2
+++ CocoonMarkupLanguage.java 1 May 2004 00:05:44 -0000 1.3
@@ -129,7 +129,9 @@
* elements for this purpose.
*
* @param location The file path of the dependent file
- * @see AbstractMarkupLanguage, ServerPagesGenerator, AbstractServerPage
+ * @see AbstractMarkupLanguage
+ * @see org.apache.cocoon.generation.ServerPagesGenerator
+ * @see org.apache.cocoon.generation.AbstractServerPage
*/
protected void addDependency(String location) {
dependencies.add(location);
1.2 +4 -2
cocoon-2.1/src/blocks/xsp/java/org/apache/cocoon/components/language/markup/AbstractMarkupLanguage.java
Index: AbstractMarkupLanguage.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/xsp/java/org/apache/cocoon/components/language/markup/AbstractMarkupLanguage.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- AbstractMarkupLanguage.java 10 Mar 2004 12:58:04 -0000 1.1
+++ AbstractMarkupLanguage.java 1 May 2004 00:05:44 -0000 1.2
@@ -294,7 +294,9 @@
* tested for change on each invocation; this information is used to
assert whether regeneration is necessary.
*
* @param location The file path of the dependent file
- * @see AbstractMarkupLanguage, ServerPagesGenerator, AbstractServerPage
+ * @see AbstractMarkupLanguage
+ * @see org.apache.cocoon.generation.ServerPagesGenerator
+ * @see org.apache.cocoon.generation.AbstractServerPage
*/
protected abstract void addDependency(String location);
1.6 +1 -1
cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/binding/CustomJXPathBinding.java
Index: CustomJXPathBinding.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/binding/CustomJXPathBinding.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- CustomJXPathBinding.java 23 Apr 2004 11:42:58 -0000 1.5
+++ CustomJXPathBinding.java 1 May 2004 00:05:44 -0000 1.6
@@ -42,7 +42,7 @@
/**
* Constructs CustomJXPathBinding
*
- * @param commonAtts common configuration attributes [EMAIL PROTECTED]
JXPathBindingBuilderBase.CommonAttributes}
+ * @param commonAtts common configuration attributes [EMAIL PROTECTED]
org.apache.cocoon.forms.binding.JXPathBindingBuilderBase.CommonAttributes}
* @param widgetId id of the widget to bind to
* @param xpath jxpath expression to narrow down the context to before
calling the wrapped Binding
* @param wrappedBinding the actual custom written Binding
implementation of [EMAIL PROTECTED] Binding}
1.3 +2 -2
cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/binding/AbstractCustomBinding.java
Index: AbstractCustomBinding.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/binding/AbstractCustomBinding.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- AbstractCustomBinding.java 14 Apr 2004 18:00:59 -0000 1.2
+++ AbstractCustomBinding.java 1 May 2004 00:05:44 -0000 1.3
@@ -43,7 +43,7 @@
/**
* Binding service method called upon loading.
* This will delegate to the overloaded version specific for this
base-class.
- * [EMAIL PROTECTED] #doLoad(Widget, JXPathContext)
+ * [EMAIL PROTECTED] #doLoad(Widget, JXPathContext)}
*
* @param frmModel
* @param objModel
@@ -56,7 +56,7 @@
/**
* Binding service method called upon saving.
* This will delegate to the overloaded version specific for this
base-class.
- * [EMAIL PROTECTED] #doSave(Widget, JXPathContext)
+ * [EMAIL PROTECTED] #doSave(Widget, JXPathContext)}
*
* @param frmModel
* @param objModel
1.11 +2 -2
cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/formmodel/AbstractContainerWidget.java
Index: AbstractContainerWidget.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/formmodel/AbstractContainerWidget.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- AbstractContainerWidget.java 30 Apr 2004 08:37:45 -0000 1.10
+++ AbstractContainerWidget.java 1 May 2004 00:05:44 -0000 1.11
@@ -100,7 +100,7 @@
* Subclass container widgets can call this
super.generateItemSaxFragment(..)
* to just insert the child-widget content wrapped in a @lt;fi:[EMAIL
PROTECTED];
*
- * @param contentHandler where the SAX is sent to via [EMAIL PROTECTED]
Widget#generateSaxFragment(ContentHandler, Locale)
+ * @param contentHandler where the SAX is sent to via [EMAIL PROTECTED]
Widget#generateSaxFragment(ContentHandler, Locale)}
* @param locale
* @throws SAXException
*/
1.16 +5 -5
cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/formmodel/AbstractWidget.java
Index: AbstractWidget.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/formmodel/AbstractWidget.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- AbstractWidget.java 30 Apr 2004 08:19:04 -0000 1.15
+++ AbstractWidget.java 1 May 2004 00:05:44 -0000 1.16
@@ -160,7 +160,7 @@
}
/**
- * @inheritDoc
+ * [EMAIL PROTECTED]
*
* Abstract implementation throws a [EMAIL PROTECTED]
UnsupportedOperationException}.
* Concrete subclass widgets need to override when supporting event
broadcasting.
@@ -222,7 +222,7 @@
}
/**
- * @inheritDoc
+ * [EMAIL PROTECTED]
*
* Delegates to the [EMAIL PROTECTED] #getDefinition()} to generate the
'label' part of
* the display-data of this widget.
@@ -302,7 +302,7 @@
}
/**
- * @inheritDoc
+ * [EMAIL PROTECTED]
*
* This will generate some standard XML consisting of a simple wrapper
* element (name provided by [EMAIL PROTECTED] #getXMLElementName()})
with attributes
@@ -311,7 +311,7 @@
* [EMAIL PROTECTED] #generateItemSaxFragment(ContentHandler, Locale)}.
*
* <pre>
- * <fi:[EMAIL PROTECTED] #getXMLElementName()} [EMAIL PROTECTED]
#getXMLElementAttributes() >
+ * <fi:[EMAIL PROTECTED] #getXMLElementName()} [EMAIL PROTECTED]
#getXMLElementAttributes()} >
* [EMAIL PROTECTED] #generateDisplayData(ContentHandler)} (i.e. help,
label, ...)
*
* [EMAIL PROTECTED] #generateItemSaxFragment(ContentHandler, Locale)}
1.14 +1 -5
cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/formmodel/Form.java
Index: Form.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/formmodel/Form.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- Form.java 30 Apr 2004 12:19:01 -0000 1.13
+++ Form.java 1 May 2004 00:05:44 -0000 1.14
@@ -297,12 +297,8 @@
return super.validate();
}
-
private static final String FORM_EL = "form";
- /**
- * @return
- */
public String getXMLElementName() {
return FORM_EL;
}
1.3 +1 -7
cocoon-2.1/src/java/org/apache/cocoon/components/modules/input/JXPathHelperConfiguration.java
Index: JXPathHelperConfiguration.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/components/modules/input/JXPathHelperConfiguration.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- JXPathHelperConfiguration.java 5 Mar 2004 13:02:48 -0000 1.2
+++ JXPathHelperConfiguration.java 1 May 2004 00:05:45 -0000 1.3
@@ -45,16 +45,10 @@
this.lenient = lenient;
}
- /**
- * @return
- */
public boolean isLenient() {
return lenient;
}
- /**
- * @return
- */
public FunctionLibrary getLibrary() {
return library;
}
1.2 +1 -3
cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/samples/bindings/DateWrapper.java
Index: DateWrapper.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/samples/bindings/DateWrapper.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DateWrapper.java 9 Apr 2004 11:03:27 -0000 1.1
+++ DateWrapper.java 1 May 2004 00:05:45 -0000 1.2
@@ -89,9 +89,7 @@
public void setYear(String year) {
split.put("year", year);
}
- /**
- * @return
- */
+
public String toString() {
return "Wrapped Date as combined='" + getCombined() + "' as split=["
+ getDay() + ", " + getMonth() + ", " + getYear() + "]";
1.2 +3 -3
cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/samples/bindings/CustomValueWrapBinding.java
Index: CustomValueWrapBinding.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/blocks/forms/java/org/apache/cocoon/forms/samples/bindings/CustomValueWrapBinding.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- CustomValueWrapBinding.java 6 Apr 2004 08:52:52 -0000 1.1
+++ CustomValueWrapBinding.java 1 May 2004 00:05:45 -0000 1.2
@@ -49,7 +49,7 @@
* This unwraps the value from the model by removing the 2 prefix and
suffix-chars
* before setting it onto the model
*
- * Method signature and semantics complies to [EMAIL PROTECTED]
AbstractCustomBinding#doLoad(Widget, JXPathContext)}
+ * Method signature and semantics complies to [EMAIL PROTECTED]
AbstractCustomBinding#doLoad(Widget, JXPathContext)}
*/
public void doLoad(Widget frmModel, JXPathContext jxpc) throws
BindingException {
String appValue = (String)jxpc.getValue(".");
@@ -67,7 +67,7 @@
* This wraps the value from the form between 2 prefix and suffix-chars
* before saving to the model
*
- * Method signature and semantics complies to [EMAIL PROTECTED]
AbstractCustomBinding#doSave(Widget, JXPathContext)}
+ * Method signature and semantics complies to [EMAIL PROTECTED]
AbstractCustomBinding#doSave(Widget, JXPathContext)}
*/
public void doSave(Widget frmModel, JXPathContext jxpc) throws
BindingException {
Object formValue = frmModel.getValue();
@@ -78,7 +78,7 @@
/**
* Builds the actual binding class based on its XML config.
*
- * @param config the [EMAIL PROTECTED] Element} holding the config for
the binding to create.
+ * @param config the [EMAIL PROTECTED] Element} holding the config for
the binding to create.
* @return the configured binding
* @throws BindingException when the creation fails
*/
