Author: rgielen
Date: Sat Nov 7 16:34:04 2009
New Revision: 833708
URL: http://svn.apache.org/viewvc?rev=833708&view=rev
Log:
Documentation updates
Modified:
struts/sandbox/trunk/struts2-portlet2-plugin/src/main/java/org/apache/struts2/portlet/result/PortletResultHelperJSR286.java
Modified:
struts/sandbox/trunk/struts2-portlet2-plugin/src/main/java/org/apache/struts2/portlet/result/PortletResultHelperJSR286.java
URL:
http://svn.apache.org/viewvc/struts/sandbox/trunk/struts2-portlet2-plugin/src/main/java/org/apache/struts2/portlet/result/PortletResultHelperJSR286.java?rev=833708&r1=833707&r2=833708&view=diff
==============================================================================
---
struts/sandbox/trunk/struts2-portlet2-plugin/src/main/java/org/apache/struts2/portlet/result/PortletResultHelperJSR286.java
(original)
+++
struts/sandbox/trunk/struts2-portlet2-plugin/src/main/java/org/apache/struts2/portlet/result/PortletResultHelperJSR286.java
Sat Nov 7 16:34:04 2009
@@ -11,7 +11,8 @@
public class PortletResultHelperJSR286 implements PortletResultHelper {
/**
- * Set a render parameter, abstracted from the used Portlet API version
+ * Set a render parameter, abstracted from the used Portlet API version.
This implementation assumes that the given
+ * response is a {...@link javax.portlet.StateAwareResponse}, as JSR286
implies.
*
* @param response The response to set the parameter on.
* @param key The parameter key to set.
@@ -22,7 +23,8 @@
}
/**
- * Set a portlet mode, abstracted from the used Portlet API version
+ * Set a portlet mode, abstracted from the used Portlet API version. This
implementation assumes that the given
+ * response is a {...@link javax.portlet.StateAwareResponse}, as JSR286
implies.
*
* @param response The response to set the portlet mode on.
* @param portletMode The portlet mode to set.
@@ -32,7 +34,8 @@
}
/**
- * Call a dispatcher's include method, abstracted from the used Portlet
API version.
+ * Call a dispatcher's include method, abstracted from the used Portlet
API version. This implementation assumes
+ * that the response is a {...@link javax.portlet.MimeResponse}, as JSR286
implies.
*
* @param dispatcher The dispatcher to call the include method on.
* @param contentType The content type to set for the response.
