svn commit: r1126708 - in /ofbiz/trunk/framework: base/src/org/ofbiz/base/util/ base/src/org/ofbiz/base/util/template/ birt/src/org/ofbiz/birt/email/ birt/src/org/ofbiz/birt/report/service/ birt/src/org/ofbiz/birt/widget/ common/src/org/ofbiz/common/ c...

[mrisaliti]

Author: mrisaliti
Date: Mon May 23 20:11:12 2011
New Revision: 1126708

URL: http://svn.apache.org/viewvc?rev=1126708&view=rev
Log:
Removed some javadoc warning (wrong param/return) into framework components no functional changes

Modified:
    ofbiz/trunk/framework/base/src/org/ofbiz/base/util/CompilerMatcher.java
    ofbiz/trunk/framework/base/src/org/ofbiz/base/util/template/FreeMarkerWorker.java
    ofbiz/trunk/framework/birt/src/org/ofbiz/birt/email/BirtEmailServices.java
    ofbiz/trunk/framework/birt/src/org/ofbiz/birt/report/service/OFBizBirtViewerReportService.java
    ofbiz/trunk/framework/birt/src/org/ofbiz/birt/widget/BirtFactory.java
    ofbiz/trunk/framework/common/src/org/ofbiz/common/CommonServices.java
    ofbiz/trunk/framework/common/src/org/ofbiz/common/FindServices.java
    ofbiz/trunk/framework/common/src/org/ofbiz/common/authentication/AuthenticationComparator.java
    ofbiz/trunk/framework/common/src/org/ofbiz/common/image/ImageTransform.java
    ofbiz/trunk/framework/datafile/src/org/ofbiz/datafile/DataFile2EntityXml.java
    ofbiz/trunk/framework/datafile/src/org/ofbiz/datafile/Record.java
    ofbiz/trunk/framework/datafile/src/org/ofbiz/datafile/RecordIterator.java

Modified: ofbiz/trunk/framework/base/src/org/ofbiz/base/util/CompilerMatcher.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/util/CompilerMatcher.java?rev=1126708&r1=1126707&r2=1126708&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/util/CompilerMatcher.java (original)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/util/CompilerMatcher.java Mon May 23 20:11:12 2011
@@ -45,7 +45,7 @@ public class CompilerMatcher {
      * ThreadLocal causes slightly extra memory usage, but allows for faster
      * thread-safe processing than synchronization would afford.
      *
-     * @return
+     * @return returns the ThreadLocal
      */
     public static ThreadLocal<CompilerMatcher> getThreadLocal() {
         return new ThreadLocal<CompilerMatcher>() {
@@ -61,9 +61,9 @@ public class CompilerMatcher {
      * expression argument matches the aString argument.
      * Case sensitive
      *
-     * @param aString
-     * @param patternString
-     * @return
+     * @param aString a string
+     * @param patternString a string pattern
+     * @return returns true if the compiled version of the patternString regular expression argument matches the aString argument
      * @throws MalformedPatternException
      */
     public boolean matches(String aString, String patternString) throws MalformedPatternException {
@@ -73,10 +73,10 @@ public class CompilerMatcher {
     /**
      * Returns true if the compiled version of the patternString regular
      * expression argument matches the aString argument.
-     * @param aString
-     * @param patternString
-     * @param caseSensitive
-     * @return
+     * @param aString a string
+     * @param patternString a string pattern
+     * @param caseSensitive case sensitive true/false
+     * @return returns true if the compiled version of the patternString regular expression argument matches the aString argument
      * @throws MalformedPatternException
      */
     public boolean matches(String aString, String patternString, boolean caseSensitive) throws MalformedPatternException {
@@ -88,9 +88,9 @@ public class CompilerMatcher {
      * Returns true if the compiled version of the patternString regular
      * expression argument is contained in the aString argument.
      *
-     * @param aString
-     * @param patternString
-     * @return
+     * @param aString a string
+     * @param patternString a pattern string
+     * @return Returns true if the compiled version of the patternString regular expression argument is contained in the aString argument
      * @throws MalformedPatternException
      */
     public boolean contains(String aString, String patternString) throws MalformedPatternException {
@@ -100,8 +100,8 @@ public class CompilerMatcher {
     /**
      * Compiles and caches a case sensitive regexp pattern for the given string pattern.
      *
-     * @param stringPattern
-     * @return
+     * @param stringPattern a pattern string
+     * @return compiles and caches a case sensitive regexp pattern for the given string pattern
      * @throws MalformedPatternException
      */
     private Pattern getTestPattern(String stringPattern) throws MalformedPatternException {
@@ -111,9 +111,9 @@ public class CompilerMatcher {
     /**
      * Compiles and caches a regexp pattern for the given string pattern.
      *
-     * @param stringPattern
-     * @param caseSensitive
-     * @return
+     * @param stringPattern a pattern string
+     * @param caseSensitive case sensitive true/false
+     * @return compiles and caches a regexp pattern for the given string pattern
      * @throws MalformedPatternException
      */
     private Pattern getTestPattern(String stringPattern, boolean caseSensitive) throws MalformedPatternException {
@@ -135,9 +135,9 @@ public class CompilerMatcher {
      * Perl5Util's substitute() function implements Perl's s/// operator.
      * It takes two arguments: a substitution expression, and an input.
      *
-     * @param stringPattern
-     * @param input
-     * @return
+     * @param stringPattern a pattern string
+     * @param input the input string
+     * @return returns the perl5Util's substitute() function implements Perl's
      */
     public String substitute(String stringPattern, String input) {
         return this.perl5Util.substitute(stringPattern, input);

Modified: ofbiz/trunk/framework/base/src/org/ofbiz/base/util/template/FreeMarkerWorker.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/org/ofbiz/base/util/template/FreeMarkerWorker.java?rev=1126708&r1=1126707&r2=1126708&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/org/ofbiz/base/util/template/FreeMarkerWorker.java (original)
+++ ofbiz/trunk/framework/base/src/org/ofbiz/base/util/template/FreeMarkerWorker.java Mon May 23 20:11:12 2011
@@ -178,7 +178,6 @@ public class FreeMarkerWorker {
      * @param templateLocation A unique ID for this template - used for caching
      * @param context The context Map
      * @param outWriter The Writer to render to
-     * @param useCache try to get template from cache
      */
     public static void renderTemplate(String templateLocation, Map<String, Object> context, Appendable outWriter) throws TemplateException, IOException {
         Template template = getTemplate(templateLocation);
@@ -186,7 +185,7 @@ public class FreeMarkerWorker {
     }
 
     /**
-     * @deprecated, replaced by {@link #renderTemplateFromString(String templateString, String templateLocation, Map<String, Object> context, Appendable outWriter, boolean useCache)}
+     * @deprecated Renamed to {@link #renderTemplateFromString(String, String, Map, Appendable, boolean)}
      */
     @Deprecated
     public static Environment renderTemplateFromString(String templateString, String templateLocation, Map<String, Object> context, Appendable outWriter) throws TemplateException, IOException {

Modified: ofbiz/trunk/framework/birt/src/org/ofbiz/birt/email/BirtEmailServices.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/birt/src/org/ofbiz/birt/email/BirtEmailServices.java?rev=1126708&r1=1126707&r2=1126708&view=diff
==============================================================================
--- ofbiz/trunk/framework/birt/src/org/ofbiz/birt/email/BirtEmailServices.java (original)
+++ ofbiz/trunk/framework/birt/src/org/ofbiz/birt/email/BirtEmailServices.java Mon May 23 20:11:12 2011
@@ -66,9 +66,9 @@ public class BirtEmailServices {
     /**
      * send birt mail
      *
-     * @param ctx
-     * @param context
-     * @return
+     * @param ctx the dispatch context
+     * @param context the context
+     * @return returns the result of the service execution
      */
     public static Map<String, Object> sendBirtMail(DispatchContext ctx, Map<String, ? extends Object> context) {
         Map<String, Object> serviceContext = UtilMisc.makeMapWritable(context);

Modified: ofbiz/trunk/framework/birt/src/org/ofbiz/birt/report/service/OFBizBirtViewerReportService.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/birt/src/org/ofbiz/birt/report/service/OFBizBirtViewerReportService.java?rev=1126708&r1=1126707&r2=1126708&view=diff
==============================================================================
--- ofbiz/trunk/framework/birt/src/org/ofbiz/birt/report/service/OFBizBirtViewerReportService.java (original)
+++ ofbiz/trunk/framework/birt/src/org/ofbiz/birt/report/service/OFBizBirtViewerReportService.java Mon May 23 20:11:12 2011
@@ -123,11 +123,10 @@ public class OFBizBirtViewerReportServic
      * Run report.
      *
      * @param request
-     *
      * @param runnable
-     * @param archive
      * @param documentName
      * @param locale
+     * @param timeZone
      * @param parameters
      * @param displayTexts
      * @param maxRows

Modified: ofbiz/trunk/framework/birt/src/org/ofbiz/birt/widget/BirtFactory.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/birt/src/org/ofbiz/birt/widget/BirtFactory.java?rev=1126708&r1=1126707&r2=1126708&view=diff
==============================================================================
--- ofbiz/trunk/framework/birt/src/org/ofbiz/birt/widget/BirtFactory.java (original)
+++ ofbiz/trunk/framework/birt/src/org/ofbiz/birt/widget/BirtFactory.java Mon May 23 20:11:12 2011
@@ -36,7 +36,7 @@ public class BirtFactory {
     /**
      * get report input stream from location
      * @param resourceName
-     * @return
+     * @return returns the input stream from location
      * @throws IOException
      * @throws SAXException
      * @throws ParserConfigurationException

Modified: ofbiz/trunk/framework/common/src/org/ofbiz/common/CommonServices.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/common/src/org/ofbiz/common/CommonServices.java?rev=1126708&r1=1126707&r2=1126708&view=diff
==============================================================================
--- ofbiz/trunk/framework/common/src/org/ofbiz/common/CommonServices.java (original)
+++ ofbiz/trunk/framework/common/src/org/ofbiz/common/CommonServices.java Mon May 23 20:11:12 2011
@@ -203,7 +203,7 @@ public class CommonServices {
 
     /**
      * Service for setting debugging levels.
-     *@param dctx The DispatchContext that this service is operating in
+     *@param dctc The DispatchContext that this service is operating in
      *@param context Map containing the input parameters
      *@return Map with the result of the service, the output parameters
      */

Modified: ofbiz/trunk/framework/common/src/org/ofbiz/common/FindServices.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/common/src/org/ofbiz/common/FindServices.java?rev=1126708&r1=1126707&r2=1126708&view=diff
==============================================================================
--- ofbiz/trunk/framework/common/src/org/ofbiz/common/FindServices.java (original)
+++ ofbiz/trunk/framework/common/src/org/ofbiz/common/FindServices.java Mon May 23 20:11:12 2011
@@ -210,7 +210,7 @@ public class FindServices {
      * @param queryStringMap
      * @param delegator
      * @param context
-     * @return
+     * @return returns an EntityCondition list
      */
     public static List<EntityCondition> createConditionList(Map<String, ? extends Object> parameters, List<ModelField> fieldList, Map<String, Object> queryStringMap, Delegator delegator, Map<String, ?> context) {
         Set<String> processed = FastSet.newInstance();
@@ -287,7 +287,7 @@ public class FindServices {
      * @param ignoreCase
      * @param delegator
      * @param context
-     * @return
+     * @return return an EntityCondition
      */
     public static EntityCondition createSingleCondition(ModelField modelField, String operation, Object fieldValue, boolean ignoreCase, Delegator delegator, Map<String, ?> context) {
         EntityCondition cond = null;
@@ -350,8 +350,8 @@ public class FindServices {
      *
      * This is use to the generic method that expects entity data affixed with special suffixes
      * to indicate their purpose in formulating an SQL query statement.
-     * @param keys     list of field for which it's possible to make the query
-     * @param normalizedFields     list of field the user have populated
+     * @param modelEntity the model entity object
+     * @param normalizedFields list of field the user have populated
      * @return a arrayList usable to create an entityCondition
      */
     public static List<EntityCondition> createCondition(ModelEntity modelEntity, Map<String, Map<String, Map<String, Object>>> normalizedFields, Map<String, Object> queryStringMap, Map<String, List<Object[]>> origValueMap, Delegator delegator, Map<String, ?> context) {
@@ -709,7 +709,7 @@ public class FindServices {
      *
      * @param dctx
      * @param context
-     * @return
+     * @return returns the first item
      */
     public static Map<String, Object> performFindItem(DispatchContext dctx, Map<String, Object> context) {
         context.put("viewSize", 1);

Modified: ofbiz/trunk/framework/common/src/org/ofbiz/common/authentication/AuthenticationComparator.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/common/src/org/ofbiz/common/authentication/AuthenticationComparator.java?rev=1126708&r1=1126707&r2=1126708&view=diff
==============================================================================
--- ofbiz/trunk/framework/common/src/org/ofbiz/common/authentication/AuthenticationComparator.java (original)
+++ ofbiz/trunk/framework/common/src/org/ofbiz/common/authentication/AuthenticationComparator.java Mon May 23 20:11:12 2011
@@ -54,8 +54,8 @@ public class AuthenticationComparator im
      * this fact.  The recommended language is "Note: this comparator
      * imposes orderings that are inconsistent with equals."
      *
-     * @param o1 the first object to be compared.
-     * @param o2 the second object to be compared.
+     * @param a1 the first object to be compared.
+     * @param a2 the second object to be compared.
      * @return a negative integer, zero, or a positive integer as the
      *         first argument is less than, equal to, or greater than the
      *         second.

Modified: ofbiz/trunk/framework/common/src/org/ofbiz/common/image/ImageTransform.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/common/src/org/ofbiz/common/image/ImageTransform.java?rev=1126708&r1=1126707&r2=1126708&view=diff
==============================================================================
--- ofbiz/trunk/framework/common/src/org/ofbiz/common/image/ImageTransform.java (original)
+++ ofbiz/trunk/framework/common/src/org/ofbiz/common/image/ImageTransform.java Mon May 23 20:11:12 2011
@@ -63,9 +63,8 @@ public class ImageTransform {
      * <p>
      * Set a buffered image
      *
-     * @param   context
      * @param   fileLocation    Full file Path or URL
-     * @return                  URL images for all different size types
+     * @return  URL images for all different size types
      * @throws  IOException Error prevents the document from being fully parsed
      * @throws  JDOMException Errors occur in parsing
      */
@@ -104,7 +103,7 @@ public class ImageTransform {
      *
      * @param   bufImg          Buffered image to scale
      * @param   imgHeight       Original image height
-     * @param   imgwidth        Original image width
+     * @param   imgWidth        Original image width
      * @param   dimensionMap    Image dimensions by size type
      * @param   sizeType        Size type to scale
      * @return                  New scaled buffered image

Modified: ofbiz/trunk/framework/datafile/src/org/ofbiz/datafile/DataFile2EntityXml.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/datafile/src/org/ofbiz/datafile/DataFile2EntityXml.java?rev=1126708&r1=1126707&r2=1126708&view=diff
==============================================================================
--- ofbiz/trunk/framework/datafile/src/org/ofbiz/datafile/DataFile2EntityXml.java (original)
+++ ofbiz/trunk/framework/datafile/src/org/ofbiz/datafile/DataFile2EntityXml.java Mon May 23 20:11:12 2011
@@ -38,7 +38,9 @@ public class DataFile2EntityXml {
     }
 
     /**
-     * @param args the command line arguments
+     * Writes the entity xml
+     * @param fileName the file name
+     * @param dataFile the data file name
      */
     public static void writeToEntityXml(String fileName, DataFile dataFile) throws DataFileException {
         File file = new File(fileName);

Modified: ofbiz/trunk/framework/datafile/src/org/ofbiz/datafile/Record.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/datafile/src/org/ofbiz/datafile/Record.java?rev=1126708&r1=1126707&r2=1126708&view=diff
==============================================================================
--- ofbiz/trunk/framework/datafile/src/org/ofbiz/datafile/Record.java (original)
+++ ofbiz/trunk/framework/datafile/src/org/ofbiz/datafile/Record.java Mon May 23 20:11:12 2011
@@ -478,7 +478,7 @@ public class Record implements Serializa
     /** Creates new Record
      * @param modelRecord
      * @throws DataFileException Exception thown for various errors, generally has a nested exception
-     * @return
+     * @return return the Record Object created
      */
     public static Record createRecord(ModelRecord modelRecord) throws DataFileException {
     Record record = new Record(modelRecord);
@@ -490,7 +490,7 @@ public class Record implements Serializa
      * @param modelRecord
      * @param fields
      * @throws DataFileException Exception thown for various errors, generally has a nested exception
-     * @return
+     * @return return the Record Object created
      */
     public static Record createRecord(ModelRecord modelRecord, Map<String, Object> fields) throws DataFileException {
     Record record = new Record(modelRecord, fields);
@@ -503,7 +503,7 @@ public class Record implements Serializa
      * @param lineNum
      * @param modelRecord
      * @throws DataFileException Exception thown for various errors, generally has a nested exception
-     * @return
+     * @return return the Record Object created
      */
     public static Record createRecord(String line, int lineNum, ModelRecord modelRecord) throws DataFileException {
     Record record = new Record(modelRecord);
@@ -538,7 +538,7 @@ public class Record implements Serializa
      * @param modelRecord
      * @param delimiter
      * @throws DataFileException Exception thown for various errors, generally has a nested exception
-     * @return
+     * @return return a Record Object
      */
     public static Record createDelimitedRecord(String line, int lineNum, ModelRecord modelRecord, char delimiter, String textDelimiter) throws DataFileException {
     Record record = new Record(modelRecord);

Modified: ofbiz/trunk/framework/datafile/src/org/ofbiz/datafile/RecordIterator.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/datafile/src/org/ofbiz/datafile/RecordIterator.java?rev=1126708&r1=1126707&r2=1126708&view=diff
==============================================================================
--- ofbiz/trunk/framework/datafile/src/org/ofbiz/datafile/RecordIterator.java (original)
+++ ofbiz/trunk/framework/datafile/src/org/ofbiz/datafile/RecordIterator.java Mon May 23 20:11:12 2011
@@ -214,7 +214,7 @@ public class RecordIterator {
      * @param lineNum
      * @param modelDataFile
      * @throws DataFileException Exception thown for various errors, generally has a nested exception
-     * @return
+     * @return return the ModelRecord Object found
      */
     protected static ModelRecord findModelForLine(String line, int lineNum, ModelDataFile modelDataFile) throws DataFileException {
         // if (Debug.infoOn()) Debug.logInfo("[DataFile.findModelForLine] line: " + line, module);