Author: scottbw
Date: Thu Sep 22 18:54:12 2011
New Revision: 1174312
URL: http://svn.apache.org/viewvc?rev=1174312&view=rev
Log:
Fixed more javadoc tags
Modified:
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/W3CWidgetFactory.java
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/impl/AbstractLocalizedEntity.java
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/ContentTypeUtils.java
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/LocalizationUtils.java
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/WidgetOutputter.java
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/WidgetPackageUtils.java
Modified:
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/W3CWidgetFactory.java
URL:
http://svn.apache.org/viewvc/incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/W3CWidgetFactory.java?rev=1174312&r1=1174311&r2=1174312&view=diff
==============================================================================
---
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/W3CWidgetFactory.java
(original)
+++
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/W3CWidgetFactory.java
Thu Sep 22 18:54:12 2011
@@ -174,7 +174,7 @@ public class W3CWidgetFactory {
* Parse a widget at a given URL and return a W3CWidget object
representing the processed information in the package.
* The widget will be saved in the outputFolder.
* @param url
- * @return
+ * @return the widget model
* @throws BadWidgetZipFileException if there is a problem with the zip
package
* @throws BadManifestException if there is a problem with the
config.xml manifest file in the package
* @throws InvalidContentTypeException if the widget has an invalid
content type
@@ -190,7 +190,7 @@ public class W3CWidgetFactory {
* The widget will be saved in the outputFolder.
* @param url
* @param ignoreContentType set to true to instruct the parser to
ignore invalid content type exceptions
- * @return
+ * @return the widget model
* @throws BadWidgetZipFileException if there is a problem with the zip
package
* @throws BadManifestException if there is a problem with the
config.xml manifest file in the package
* @throws InvalidContentTypeException if the widget has an invalid
content type
@@ -207,7 +207,7 @@ public class W3CWidgetFactory {
* @param url
* @param ignoreContentType set to true to instruct the parser to
ignore invalid content type exceptions
* @param defaultIdentifier an identifier to use if the downloaded
widget has no identifier - for example when updating a widget
- * @return
+ * @return the widget model
* @throws BadWidgetZipFileException if there is a problem with the zip
package
* @throws BadManifestException if there is a problem with the
config.xml manifest file in the package
* @throws InvalidContentTypeException if the widget has an invalid
content type
Modified:
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/impl/AbstractLocalizedEntity.java
URL:
http://svn.apache.org/viewvc/incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/impl/AbstractLocalizedEntity.java?rev=1174312&r1=1174311&r2=1174312&view=diff
==============================================================================
---
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/impl/AbstractLocalizedEntity.java
(original)
+++
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/impl/AbstractLocalizedEntity.java
Thu Sep 22 18:54:12 2011
@@ -45,7 +45,7 @@ public abstract class AbstractLocalizedE
/**
* Set the language tag for the object
- * @param language the language tag to set; this should be a valid
BCP-47 language tag
+ * @param lang the language tag to set; this should be a valid BCP-47
language tag
*/
public void setLang(String lang) {
this.lang = lang;
Modified:
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/ContentTypeUtils.java
URL:
http://svn.apache.org/viewvc/incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/ContentTypeUtils.java?rev=1174312&r1=1174311&r2=1174312&view=diff
==============================================================================
---
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/ContentTypeUtils.java
(original)
+++
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/ContentTypeUtils.java
Thu Sep 22 18:54:12 2011
@@ -67,7 +67,7 @@ public class ContentTypeUtils {
/**
* Sniffs the content type for images and other common types
- * @param the file to sniff
+ * @param file the file to sniff
* @return the content type of the file if it matches a known
signature, otherwise Null
* @throws IOException
*/
Modified:
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/LocalizationUtils.java
URL:
http://svn.apache.org/viewvc/incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/LocalizationUtils.java?rev=1174312&r1=1174311&r2=1174312&view=diff
==============================================================================
---
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/LocalizationUtils.java
(original)
+++
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/LocalizationUtils.java
Thu Sep 22 18:54:12 2011
@@ -110,7 +110,7 @@ public class LocalizationUtils {
/**
* Sorts an array of localized elements using default locales (*). This
places
* any localized elements first, then any unlocalized elements
- * @return
+ * @return the sorted list of elements
*/
public static ILocalizedElement[]
processElementsByDefaultLocales(ILocalizedElement[] elements){
if (elements == null) return null;
@@ -185,7 +185,7 @@ public class LocalizationUtils {
* rules. For example "en-us-posix" will be returned as a List
* containing the ULocales for "en-us-posix", "en-us", and "en".
* @param locales
- * @return
+ * @return the sorted list of ULocale instances
*/
@SuppressWarnings("unchecked")
public static List<ULocale> getProcessedLocaleList(String[] locales){
@@ -214,7 +214,7 @@ public class LocalizationUtils {
/**
* Gets the default locales list
- * @return
+ * @return a list of ULocale instances for the default locale
*/
@SuppressWarnings("unchecked")
protected static List<ULocale> getDefaultLocaleList(){
Modified:
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/WidgetOutputter.java
URL:
http://svn.apache.org/viewvc/incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/WidgetOutputter.java?rev=1174312&r1=1174311&r2=1174312&view=diff
==============================================================================
---
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/WidgetOutputter.java
(original)
+++
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/WidgetOutputter.java
Thu Sep 22 18:54:12 2011
@@ -64,7 +64,7 @@ public class WidgetOutputter {
/**
* Output config.xml as a String
* @param widget
- * @return
+ * @return the config.xml as a String
*/
public String outputXMLString(W3CWidget widget){
Document doc = createWidgetDocument(widget);
Modified:
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/WidgetPackageUtils.java
URL:
http://svn.apache.org/viewvc/incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/WidgetPackageUtils.java?rev=1174312&r1=1174311&r2=1174312&view=diff
==============================================================================
---
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/WidgetPackageUtils.java
(original)
+++
incubator/wookie/trunk/parser/java/src/org/apache/wookie/w3c/util/WidgetPackageUtils.java
Thu Sep 22 18:54:12 2011
@@ -47,7 +47,7 @@ public class WidgetPackageUtils {
* @param path
* @param locales the supported locales, in list of preference
* @param zip
- * @return
+ * @return the path to the file as a String
* @throws Exception
*/
public static String locateFilePath(String path, String[] locales,
ZipFile zip) throws Exception{
@@ -62,7 +62,7 @@ public class WidgetPackageUtils {
* @param path
* @param locales
* @param zip
- * @return
+ * @return an array of paths for the resource
* @throws Exception
*/
public static String[] locateFilePaths(String path, String[] locales,
ZipFile zip) throws Exception{
@@ -89,7 +89,7 @@ public class WidgetPackageUtils {
/**
* Return the language tag for a given path
* @param path
- * @return
+ * @return the language tag for the path
*/
public static String languageTagForPath(String path){
if (path == null) return null;
@@ -107,7 +107,7 @@ public class WidgetPackageUtils {
* @param zip
* @param locales
* @param defaults
- * @return
+ * @return an array of file paths as Strings
*/
public static String[] getDefaults(ZipFile zip, String[] locales,
String[] defaults){
ArrayList<String> content = new ArrayList<String>();
@@ -143,7 +143,7 @@ public class WidgetPackageUtils {
* @param widgetFolder the folder that contains unpacked widgets
* @param id the widget identifier URI
* @param file a file in the widget package; use "" to obtain the root
of the widget folder
- * @return
+ * @return the URL for the widget as a String
*/
public static String getURLForWidget(String widgetFolder, String id,
String file){
String folder = convertIdToFolderName(id);
