Author: scottbw
Date: Thu Sep 22 18:45:04 2011
New Revision: 1174310
URL: http://svn.apache.org/viewvc?rev=1174310&view=rev
Log:
Fixed javadoc comments
Modified:
incubator/wookie/trunk/src/org/apache/wookie/helpers/AccessRequestHelper.java
incubator/wookie/trunk/src/org/apache/wookie/helpers/FlashMessage.java
incubator/wookie/trunk/src/org/apache/wookie/helpers/WhitelistHelper.java
incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetHelper.java
incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetInstanceFactory.java
incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetInstanceHelper.java
incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetKeyManager.java
incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetServiceHelper.java
Modified:
incubator/wookie/trunk/src/org/apache/wookie/helpers/AccessRequestHelper.java
URL:
http://svn.apache.org/viewvc/incubator/wookie/trunk/src/org/apache/wookie/helpers/AccessRequestHelper.java?rev=1174310&r1=1174309&r2=1174310&view=diff
==============================================================================
---
incubator/wookie/trunk/src/org/apache/wookie/helpers/AccessRequestHelper.java
(original)
+++
incubator/wookie/trunk/src/org/apache/wookie/helpers/AccessRequestHelper.java
Thu Sep 22 18:45:04 2011
@@ -25,7 +25,7 @@ public class AccessRequestHelper {
/**
* Creates an XML return document
* @param accessRequests
- * @return
+ * @return an XML representation of the set of access requests as a
String
*/
public static String createXMLAccessRequestDocument(IAccessRequest[]
accessRequests){
String document = XMLDECLARATION;
@@ -39,6 +39,11 @@ public class AccessRequestHelper {
return document;
}
+ /**
+ * Creates a JSON return document
+ * @param accessRequests
+ * @return a JSON representaiton of the accessRequests as a String
+ */
public static String createJSON(IAccessRequest[] accessRequests){
String json = "{ \"policies\":[";
if (accessRequests != null){
@@ -56,7 +61,7 @@ public class AccessRequestHelper {
/**
* Creates a HTML table with controls
* @param accessRequests
- * @return
+ * @return a HTML table representation of the accessRequests as a String
*/
public static String createAccessRequestHTMLTable(IAccessRequest[]
accessRequests){
String document = "<table width=\"500\" class=\"ui-widget
ui-widget-content\" align=\"center\">\n";
Modified: incubator/wookie/trunk/src/org/apache/wookie/helpers/FlashMessage.java
URL:
http://svn.apache.org/viewvc/incubator/wookie/trunk/src/org/apache/wookie/helpers/FlashMessage.java?rev=1174310&r1=1174309&r2=1174310&view=diff
==============================================================================
--- incubator/wookie/trunk/src/org/apache/wookie/helpers/FlashMessage.java
(original)
+++ incubator/wookie/trunk/src/org/apache/wookie/helpers/FlashMessage.java Thu
Sep 22 18:45:04 2011
@@ -153,8 +153,6 @@ public class FlashMessage {
* Utility to clear flash messages when displayed.
*
* @param session current request session
- * @param request current request
- * @return merged messages
*/
public static void clearErrorsAndMessages(HttpSession session) {
session.setAttribute("error_value", null);
Modified:
incubator/wookie/trunk/src/org/apache/wookie/helpers/WhitelistHelper.java
URL:
http://svn.apache.org/viewvc/incubator/wookie/trunk/src/org/apache/wookie/helpers/WhitelistHelper.java?rev=1174310&r1=1174309&r2=1174310&view=diff
==============================================================================
--- incubator/wookie/trunk/src/org/apache/wookie/helpers/WhitelistHelper.java
(original)
+++ incubator/wookie/trunk/src/org/apache/wookie/helpers/WhitelistHelper.java
Thu Sep 22 18:45:04 2011
@@ -21,8 +21,8 @@ public class WhitelistHelper {
/**
* Creates an XML return document
- * @param accessRequests
- * @return
+ * @param entries the set of whitelist entries to represent
+ * @return an XML representation of the set of whitelist entries as a
String
*/
public static String createXMLDocument(IWhitelist[] entries){
String document = XMLDECLARATION;
Modified: incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetHelper.java
URL:
http://svn.apache.org/viewvc/incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetHelper.java?rev=1174310&r1=1174309&r2=1174310&view=diff
==============================================================================
--- incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetHelper.java
(original)
+++ incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetHelper.java Thu
Sep 22 18:45:04 2011
@@ -41,7 +41,7 @@ public class WidgetHelper {
* Generate a Widgets representation doc in XML for a single widget
* @param widget
* @param localIconPath
- * @return
+ * @return an XML representation of the widget as a String
*/
public static String createXMLWidgetsDocument(IWidget widget, String
localIconPath, String[] locales){
IWidget[] widgets = {widget};
@@ -53,7 +53,7 @@ public class WidgetHelper {
*
* @param widgets
* @param localIconPath
- * @return
+ * @return an XML representation of the set of widgets as a String
*/
public static String createXMLWidgetsDocument(IWidget[] widgets, String
localIconPath, String[] locales){
String document = XMLDECLARATION;
Modified:
incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetInstanceFactory.java
URL:
http://svn.apache.org/viewvc/incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetInstanceFactory.java?rev=1174310&r1=1174309&r2=1174310&view=diff
==============================================================================
---
incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetInstanceFactory.java
(original)
+++
incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetInstanceFactory.java
Thu Sep 22 18:45:04 2011
@@ -50,7 +50,7 @@ public class WidgetInstanceFactory{
* Return a handle on a Widget Factory localized for the session
* @param session
* @param localizedMessages
- * @return
+ * @return the WidgetInstanceFactory
*/
public static WidgetInstanceFactory getWidgetFactory(HttpSession
session, Messages localizedMessages){
WidgetInstanceFactory factory =
(WidgetInstanceFactory)session.getAttribute(WidgetInstanceFactory.class.getName());
@@ -65,7 +65,7 @@ public class WidgetInstanceFactory{
/**
* Return the "default widget" instance
- * @return
+ * @return an IWidgetInstance for the default widget, typically the
"unsupported widget widget"
*/
public static IWidgetInstance defaultInstance(String locale){
IPersistenceManager persistenceManager =
PersistenceManagerFactory.getPersistenceManager();
@@ -79,14 +79,12 @@ public class WidgetInstanceFactory{
/**
* Create a new widget instance with the given parameters
- * @param session
* @param apiKey
* @param userId
* @param sharedDataKey
* @param serviceType
* @param widgetId
- * @param localizedMessages
- * @return
+ * @return a new WidgetInstance, or null if the instance cannot be
created
*/
public IWidgetInstance newInstance(String apiKey, String userId, String
sharedDataKey, String serviceType, String widgetId, String lang){
try {
Modified:
incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetInstanceHelper.java
URL:
http://svn.apache.org/viewvc/incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetInstanceHelper.java?rev=1174310&r1=1174309&r2=1174310&view=diff
==============================================================================
---
incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetInstanceHelper.java
(original)
+++
incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetInstanceHelper.java
Thu Sep 22 18:45:04 2011
@@ -27,12 +27,10 @@ public class WidgetInstanceHelper {
/**
* Generate a Widget Instance representation doc in XML for a single
instance of the given widget
- * @param widget the widget instantiated
- * @param token the opensocial token of the instance
- * @param key the id key of the instance
- * @param urlWidget the local URL of the widget instance
- * @param urlWidgetProxyServer the local URL of the proxy service
- * @return
+ * @param instance the widget instance
+ * @param url the URL of the widget instance
+ * @param locale the locale of the widget instance
+ * @return an XML representation of the Widget Instance as a String
*/
public static String createXMLWidgetInstanceDocument(IWidgetInstance
instance, String url, String locale){
String xml = XMLDECLARATION;
Modified:
incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetKeyManager.java
URL:
http://svn.apache.org/viewvc/incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetKeyManager.java?rev=1174310&r1=1174309&r2=1174310&view=diff
==============================================================================
--- incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetKeyManager.java
(original)
+++ incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetKeyManager.java
Thu Sep 22 18:45:04 2011
@@ -64,8 +64,9 @@ public class WidgetKeyManager{
/**
* Registers a new API key and notifies the requestor via email of the
key values.
*
- * @param key
- * @param domain
+ * @param request the request to create a new API key
+ * @param email the email address of the registering party
+ * @param localizedMessages the set of localized messages
* @throws EmailException if there is a problem sending the email
notification about this key
* @throws SystemUnavailableException if there is a problem generating
the key
*/
Modified:
incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetServiceHelper.java
URL:
http://svn.apache.org/viewvc/incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetServiceHelper.java?rev=1174310&r1=1174309&r2=1174310&view=diff
==============================================================================
---
incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetServiceHelper.java
(original)
+++
incubator/wookie/trunk/src/org/apache/wookie/helpers/WidgetServiceHelper.java
Thu Sep 22 18:45:04 2011
@@ -26,7 +26,7 @@ public class WidgetServiceHelper {
* Generate a Widget Service representation doc in XML for a single
service
* @param service
* @param localIconPath
- * @return
+ * @return an XML representation of the service as a String
*/
public static String createXMLWidgetServiceDocument(IWidgetService
service, String localIconPath, String[] locales){
return XMLDECLARATION + WidgetServiceHelper.toXml(service,
localIconPath, locales);
@@ -36,7 +36,7 @@ public class WidgetServiceHelper {
* Generate a Widget Service representation doc in XML for an array of
services
* @param services
* @param localIconPath
- * @return
+ * @return an XML representation of the set of services as a String
*/
public static String createXMLWidgetServicesDocument(IWidgetService[]
services, String localIconPath, boolean defaults, String[] locales){
String out = XMLDECLARATION;
