You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by ja...@apache.org on 2016/12/09 08:49:56 UTC
svn commit: r1773338 - in /ofbiz/trunk/framework:
base/src/main/java/org/apache/ofbiz/base/container/
base/src/main/java/org/apache/ofbiz/base/util/
base/src/main/java/org/apache/ofbiz/base/util/cache/
common/src/main/java/org/apache/ofbiz/common/image...
Author: jacopoc
Date: Fri Dec 9 08:49:56 2016
New Revision: 1773338
URL: http://svn.apache.org/viewvc?rev=1773338&view=rev
Log:
Fixed: a series of wrong argument names in Javadoc comments.
Modified:
ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/container/ContainerLoader.java
ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilXml.java
ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/cache/UtilCache.java
ofbiz/trunk/framework/common/src/main/java/org/apache/ofbiz/common/image/ImageTransform.java
ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/model/ModelUtil.java
ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/util/EntityQuery.java
Modified: ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/container/ContainerLoader.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/container/ContainerLoader.java?rev=1773338&r1=1773337&r2=1773338&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/container/ContainerLoader.java (original)
+++ ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/container/ContainerLoader.java Fri Dec 9 08:49:56 2016
@@ -49,7 +49,7 @@ public class ContainerLoader implements
private final List<Container> loadedContainers = new LinkedList<Container>();
/**
- * @see org.apache.ofbiz.base.start.StartupLoader#load(Config, String[])
+ * @see org.apache.ofbiz.base.start.StartupLoader#load(Config, List<StartupCommand>[])
*/
@Override
public synchronized void load(Config config, List<StartupCommand> ofbizCommands) throws StartupException {
Modified: ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilXml.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilXml.java?rev=1773338&r1=1773337&r2=1773338&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilXml.java (original)
+++ ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilXml.java Fri Dec 9 08:49:56 2016
@@ -1148,7 +1148,7 @@ public final class UtilXml {
/**
* get tag name without any prefix
- * @param node
+ * @param element
* @return
*/
public static String getTagNameIgnorePrefix(Element element){
@@ -1163,7 +1163,7 @@ public final class UtilXml {
/**
* get attribute value ignoring prefix in attribute name
- * @param node
+ * @param element
* @return
*/
public static String getAttributeValueIgnorePrefix(Element element, String attributeName){
Modified: ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/cache/UtilCache.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/cache/UtilCache.java?rev=1773338&r1=1773337&r2=1773338&view=diff
==============================================================================
--- ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/cache/UtilCache.java (original)
+++ ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/cache/UtilCache.java Fri Dec 9 08:49:56 2016
@@ -111,7 +111,7 @@ public class UtilCache<K, V> implements
/** Constructor which specifies the cacheName as well as the sizeLimit, expireTime and useSoftReference.
* The passed sizeLimit, expireTime and useSoftReference will be overridden by values from cache.properties if found.
* @param sizeLimit The sizeLimit member is set to this value
- * @param expireTime The expireTime member is set to this value
+ * @param expireTimeMillis The expireTime member is set to this value
* @param cacheName The name of the cache.
* @param useSoftReference Specifies whether or not to use soft references for this cache.
*/
Modified: ofbiz/trunk/framework/common/src/main/java/org/apache/ofbiz/common/image/ImageTransform.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/common/src/main/java/org/apache/ofbiz/common/image/ImageTransform.java?rev=1773338&r1=1773337&r2=1773338&view=diff
==============================================================================
--- ofbiz/trunk/framework/common/src/main/java/org/apache/ofbiz/common/image/ImageTransform.java (original)
+++ ofbiz/trunk/framework/common/src/main/java/org/apache/ofbiz/common/image/ImageTransform.java Fri Dec 9 08:49:56 2016
@@ -63,7 +63,7 @@ public class ImageTransform {
* @param fileLocation Full file Path or URL
* @return URL images for all different size types
* @throws IOException Error prevents the document from being fully parsed
- * @throws JDOMException Errors occur in parsing
+ * @throws IllegalArgumentException Errors occur in parsing
*/
public static Map<String, Object> getBufferedImage(String fileLocation, Locale locale)
throws IllegalArgumentException, IOException {
Modified: ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/model/ModelUtil.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/model/ModelUtil.java?rev=1773338&r1=1773337&r2=1773338&view=diff
==============================================================================
--- ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/model/ModelUtil.java (original)
+++ ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/model/ModelUtil.java Fri Dec 9 08:49:56 2016
@@ -314,7 +314,7 @@ public final class ModelUtil {
* Check is a ModelEntity have a default resource associate to resolve localized value
* When the ModelEntity is a ModelViewEntity, check with the list fields to resolve these related entities
* @param modelEntity
- * @param fieldName
+ * @param fieldNames
* @return
*/
public static boolean isPotentialLocalizedFields(ModelEntity modelEntity, List<String> fieldNames) {
Modified: ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/util/EntityQuery.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/util/EntityQuery.java?rev=1773338&r1=1773337&r2=1773338&view=diff
==============================================================================
--- ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/util/EntityQuery.java (original)
+++ ofbiz/trunk/framework/entity/src/main/java/org/apache/ofbiz/entity/util/EntityQuery.java Fri Dec 9 08:49:56 2016
@@ -104,7 +104,7 @@ public class EntityQuery {
* Note that the select methods are not additive, if a subsequent
* call is made to select then the existing fields for selection
* will be replaced.
- * @param fieldsToSelect - Strings containing the field names to be selected
+ * @param fields - Strings containing the field names to be selected
* @return this EntityQuery object, to enable chaining
*/
public EntityQuery select(String...fields) {
@@ -157,7 +157,7 @@ public class EntityQuery {
/** Set a series of field name/values to be ANDed together as the WHERE clause for the query
*
* NOTE: Each successive call to any of the where(...) methods will replace the currently set condition for the query.
- * @param fieldMap - A series of field names/values to be ANDed together as the where clause for the query
+ * @param fields - A series of field names/values to be ANDed together as the where clause for the query
* @return this EntityQuery object, to enable chaining
*/
public EntityQuery where(Object...fields) {
@@ -179,7 +179,7 @@ public class EntityQuery {
/** Set a list of EntityCondition objects to be ANDed together as the WHERE clause for the query
*
* NOTE: Each successive call to any of the where(...) methods will replace the currently set condition for the query.
- * @param fieldMap - A list of EntityCondition objects to be ANDed together as the WHERE clause for the query
+ * @param andConditions - A list of EntityCondition objects to be ANDed together as the WHERE clause for the query
* @return this EntityQuery object, to enable chaining
*/
public <T extends EntityCondition> EntityQuery where(List<T> andConditions) {
@@ -214,7 +214,7 @@ public class EntityQuery {
/** The fields of the named entity to order the resultset by; optionally add a " ASC" for ascending or " DESC" for descending
*
* NOTE: Each successive call to any of the orderBy(...) methods will replace the currently set orderBy fields for the query.
- * @param orderBy - The fields of the named entity to order the resultset by
+ * @param fields - The fields of the named entity to order the resultset by
* @return this EntityQuery object, to enable chaining
*/
public EntityQuery orderBy(String...fields) {
@@ -349,7 +349,7 @@ public class EntityQuery {
/** Specifies whether the query should return only values that are currently active using the specified from/thru field name pairs.
*
- * @param fromThruFieldName - String pairs representing the from/thru date field names e.g. "fromDate", "thruDate", "contactFromDate", "contactThruDate"
+ * @param filterByFieldName - String pairs representing the from/thru date field names e.g. "fromDate", "thruDate", "contactFromDate", "contactThruDate"
* @return this EntityQuery object, to enable chaining
*/
public EntityQuery filterByDate(String... filterByFieldName) {
@@ -359,7 +359,7 @@ public class EntityQuery {
/** Specifies whether the query should return only values that are active during the specified moment using the specified from/thru field name pairs.
*
* @param moment - Timestamp representing the moment in time that the values should be active during
- * @param fromThruFieldName - String pairs representing the from/thru date field names e.g. "fromDate", "thruDate", "contactFromDate", "contactThruDate"
+ * @param filterByFieldName - String pairs representing the from/thru date field names e.g. "fromDate", "thruDate", "contactFromDate", "contactThruDate"
* @return this EntityQuery object, to enable chaining
*/
public EntityQuery filterByDate(Timestamp moment, String... filterByFieldName) {
Re: svn commit: r1773338 - in /ofbiz/trunk/framework:
base/src/main/java/org/apache/ofbiz/base/container/ base/src/main/java/org/apache/ofbiz/base/util/
base/src/main/java/org/apache/ofbiz/base/util/cache/ common/src/main/java/org/apache/ofbiz/common/image...
Posted by Taher Alkhateeb <sl...@gmail.com>.
Hi Jacopo,
What I am doing is replacing angle brackets with < and > to make it a
legal javadoc. There are a LOT of errors all over the code base so this
might take a while.
Cheers,
Taher
On Dec 9, 2016 1:37 PM, "Jacopo Cappellato" <
jacopo.cappellato@hotwaxsystems.com> wrote:
> Thank you Taher!!!
> In rev 1773354 I have removed also the diamond operator because my IDE was
> considering it illegal for Javadoc; let me know if you have suggestions and
> I will fix it (or feel free to modify it if you are working on the same).
>
> Jacopo
>
> On Fri, Dec 9, 2016 at 10:10 AM, Taher Alkhateeb <
> slidingfilaments@gmail.com
> > wrote:
>
> > Great work Jacopo!
> >
> > minor note:
> > - * @see org.apache.ofbiz.base.start.StartupLoader#load(Config,
> > String[])
> > + * @see org.apache.ofbiz.base.start.StartupLoader#load(Config,
> > List<StartupCommand>[])
> >
> > There is still an array set of brackets "[]" which should go away
> >
> > It's funny but I'm actually working on the javadocs right now to try an
> > enforce guidelines by gradle. Weird that we work on the same stuff, must
> be
> > telepathy :)
> >
> > On Fri, Dec 9, 2016 at 11:49 AM, <ja...@apache.org> wrote:
> >
> > > Author: jacopoc
> > > Date: Fri Dec 9 08:49:56 2016
> > > New Revision: 1773338
> > >
> > > URL: http://svn.apache.org/viewvc?rev=1773338&view=rev
> > > Log:
> > > Fixed: a series of wrong argument names in Javadoc comments.
> > >
> > > Modified:
> > > ofbiz/trunk/framework/base/src/main/java/org/apache/
> > > ofbiz/base/container/ContainerLoader.java
> > > ofbiz/trunk/framework/base/src/main/java/org/apache/
> > > ofbiz/base/util/UtilXml.java
> > > ofbiz/trunk/framework/base/src/main/java/org/apache/
> > > ofbiz/base/util/cache/UtilCache.java
> > > ofbiz/trunk/framework/common/src/main/java/org/apache/
> > > ofbiz/common/image/ImageTransform.java
> > > ofbiz/trunk/framework/entity/src/main/java/org/apache/
> > > ofbiz/entity/model/ModelUtil.java
> > > ofbiz/trunk/framework/entity/src/main/java/org/apache/
> > > ofbiz/entity/util/EntityQuery.java
> > >
> > > Modified: ofbiz/trunk/framework/base/src/main/java/org/apache/
> > > ofbiz/base/container/ContainerLoader.java
> > > URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/
> > > src/main/java/org/apache/ofbiz/base/container/
> ContainerLoader.java?rev=
> > > 1773338&r1=1773337&r2=1773338&view=diff
> > > ============================================================
> > > ==================
> > > --- ofbiz/trunk/framework/base/src/main/java/org/apache/
> > > ofbiz/base/container/ContainerLoader.java (original)
> > > +++ ofbiz/trunk/framework/base/src/main/java/org/apache/
> > > ofbiz/base/container/ContainerLoader.java Fri Dec 9 08:49:56 2016
> > > @@ -49,7 +49,7 @@ public class ContainerLoader implements
> > > private final List<Container> loadedContainers = new
> > > LinkedList<Container>();
> > >
> > > /**
> > > - * @see org.apache.ofbiz.base.start.StartupLoader#load(Config,
> > > String[])
> > > + * @see org.apache.ofbiz.base.start.StartupLoader#load(Config,
> > > List<StartupCommand>[])
> > > */
> > > @Override
> > > public synchronized void load(Config config, List<StartupCommand>
> > > ofbizCommands) throws StartupException {
> > >
> > > Modified: ofbiz/trunk/framework/base/src/main/java/org/apache/
> > > ofbiz/base/util/UtilXml.java
> > > URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/
> > > src/main/java/org/apache/ofbiz/base/util/UtilXml.java?
> > > rev=1773338&r1=1773337&r2=1773338&view=diff
> > > ============================================================
> > > ==================
> > > --- ofbiz/trunk/framework/base/src/main/java/org/apache/
> > ofbiz/base/util/UtilXml.java
> > > (original)
> > > +++ ofbiz/trunk/framework/base/src/main/java/org/apache/
> > ofbiz/base/util/UtilXml.java
> > > Fri Dec 9 08:49:56 2016
> > > @@ -1148,7 +1148,7 @@ public final class UtilXml {
> > >
> > > /**
> > > * get tag name without any prefix
> > > - * @param node
> > > + * @param element
> > > * @return
> > > */
> > > public static String getTagNameIgnorePrefix(Element element){
> > > @@ -1163,7 +1163,7 @@ public final class UtilXml {
> > >
> > > /**
> > > * get attribute value ignoring prefix in attribute name
> > > - * @param node
> > > + * @param element
> > > * @return
> > > */
> > > public static String getAttributeValueIgnorePrefix(Element
> element,
> > > String attributeName){
> > >
> > > Modified: ofbiz/trunk/framework/base/src/main/java/org/apache/
> > > ofbiz/base/util/cache/UtilCache.java
> > > URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/
> > > src/main/java/org/apache/ofbiz/base/util/cache/
> > > UtilCache.java?rev=1773338&r1=1773337&r2=1773338&view=diff
> > > ============================================================
> > > ==================
> > > --- ofbiz/trunk/framework/base/src/main/java/org/apache/
> > > ofbiz/base/util/cache/UtilCache.java (original)
> > > +++ ofbiz/trunk/framework/base/src/main/java/org/apache/
> > > ofbiz/base/util/cache/UtilCache.java Fri Dec 9 08:49:56 2016
> > > @@ -111,7 +111,7 @@ public class UtilCache<K, V> implements
> > > /** Constructor which specifies the cacheName as well as the
> > > sizeLimit, expireTime and useSoftReference.
> > > * The passed sizeLimit, expireTime and useSoftReference will be
> > > overridden by values from cache.properties if found.
> > > * @param sizeLimit The sizeLimit member is set to this value
> > > - * @param expireTime The expireTime member is set to this value
> > > + * @param expireTimeMillis The expireTime member is set to this
> > value
> > > * @param cacheName The name of the cache.
> > > * @param useSoftReference Specifies whether or not to use soft
> > > references for this cache.
> > > */
> > >
> > > Modified: ofbiz/trunk/framework/common/src/main/java/org/apache/
> > > ofbiz/common/image/ImageTransform.java
> > > URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/common/
> > > src/main/java/org/apache/ofbiz/common/image/ImageTransform.java?rev=
> > > 1773338&r1=1773337&r2=1773338&view=diff
> > > ============================================================
> > > ==================
> > > --- ofbiz/trunk/framework/common/src/main/java/org/apache/
> > > ofbiz/common/image/ImageTransform.java (original)
> > > +++ ofbiz/trunk/framework/common/src/main/java/org/apache/
> > > ofbiz/common/image/ImageTransform.java Fri Dec 9 08:49:56 2016
> > > @@ -63,7 +63,7 @@ public class ImageTransform {
> > > * @param fileLocation Full file Path or URL
> > > * @return URL images for all different size types
> > > * @throws IOException Error prevents the document from being
> fully
> > > parsed
> > > - * @throws JDOMException Errors occur in parsing
> > > + * @throws IllegalArgumentException Errors occur in parsing
> > > */
> > > public static Map<String, Object> getBufferedImage(String
> > > fileLocation, Locale locale)
> > > throws IllegalArgumentException, IOException {
> > >
> > > Modified: ofbiz/trunk/framework/entity/src/main/java/org/apache/
> > > ofbiz/entity/model/ModelUtil.java
> > > URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/
> > > src/main/java/org/apache/ofbiz/entity/model/ModelUtil.
> > > java?rev=1773338&r1=1773337&r2=1773338&view=diff
> > > ============================================================
> > > ==================
> > > --- ofbiz/trunk/framework/entity/src/main/java/org/apache/
> > > ofbiz/entity/model/ModelUtil.java (original)
> > > +++ ofbiz/trunk/framework/entity/src/main/java/org/apache/
> > > ofbiz/entity/model/ModelUtil.java Fri Dec 9 08:49:56 2016
> > > @@ -314,7 +314,7 @@ public final class ModelUtil {
> > > * Check is a ModelEntity have a default resource associate to
> > > resolve localized value
> > > * When the ModelEntity is a ModelViewEntity, check with the list
> > > fields to resolve these related entities
> > > * @param modelEntity
> > > - * @param fieldName
> > > + * @param fieldNames
> > > * @return
> > > */
> > > public static boolean isPotentialLocalizedFields(ModelEntity
> > > modelEntity, List<String> fieldNames) {
> > >
> > > Modified: ofbiz/trunk/framework/entity/src/main/java/org/apache/
> > > ofbiz/entity/util/EntityQuery.java
> > > URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/
> > > src/main/java/org/apache/ofbiz/entity/util/EntityQuery.
> > > java?rev=1773338&r1=1773337&r2=1773338&view=diff
> > > ============================================================
> > > ==================
> > > --- ofbiz/trunk/framework/entity/src/main/java/org/apache/
> > > ofbiz/entity/util/EntityQuery.java (original)
> > > +++ ofbiz/trunk/framework/entity/src/main/java/org/apache/
> > > ofbiz/entity/util/EntityQuery.java Fri Dec 9 08:49:56 2016
> > > @@ -104,7 +104,7 @@ public class EntityQuery {
> > > * Note that the select methods are not additive, if a subsequent
> > > * call is made to select then the existing fields for selection
> > > * will be replaced.
> > > - * @param fieldsToSelect - Strings containing the field names to
> be
> > > selected
> > > + * @param fields - Strings containing the field names to be
> selected
> > > * @return this EntityQuery object, to enable chaining
> > > */
> > > public EntityQuery select(String...fields) {
> > > @@ -157,7 +157,7 @@ public class EntityQuery {
> > > /** Set a series of field name/values to be ANDed together as the
> > > WHERE clause for the query
> > > *
> > > * NOTE: Each successive call to any of the where(...) methods
> will
> > > replace the currently set condition for the query.
> > > - * @param fieldMap - A series of field names/values to be ANDed
> > > together as the where clause for the query
> > > + * @param fields - A series of field names/values to be ANDed
> > > together as the where clause for the query
> > > * @return this EntityQuery object, to enable chaining
> > > */
> > > public EntityQuery where(Object...fields) {
> > > @@ -179,7 +179,7 @@ public class EntityQuery {
> > > /** Set a list of EntityCondition objects to be ANDed together as
> > the
> > > WHERE clause for the query
> > > *
> > > * NOTE: Each successive call to any of the where(...) methods
> will
> > > replace the currently set condition for the query.
> > > - * @param fieldMap - A list of EntityCondition objects to be ANDed
> > > together as the WHERE clause for the query
> > > + * @param andConditions - A list of EntityCondition objects to be
> > > ANDed together as the WHERE clause for the query
> > > * @return this EntityQuery object, to enable chaining
> > > */
> > > public <T extends EntityCondition> EntityQuery where(List<T>
> > > andConditions) {
> > > @@ -214,7 +214,7 @@ public class EntityQuery {
> > > /** The fields of the named entity to order the resultset by;
> > > optionally add a " ASC" for ascending or " DESC" for descending
> > > *
> > > * NOTE: Each successive call to any of the orderBy(...) methods
> > will
> > > replace the currently set orderBy fields for the query.
> > > - * @param orderBy - The fields of the named entity to order the
> > > resultset by
> > > + * @param fields - The fields of the named entity to order the
> > > resultset by
> > > * @return this EntityQuery object, to enable chaining
> > > */
> > > public EntityQuery orderBy(String...fields) {
> > > @@ -349,7 +349,7 @@ public class EntityQuery {
> > >
> > > /** Specifies whether the query should return only values that are
> > > currently active using the specified from/thru field name pairs.
> > > *
> > > - * @param fromThruFieldName - String pairs representing the
> > from/thru
> > > date field names e.g. "fromDate", "thruDate", "contactFromDate",
> > > "contactThruDate"
> > > + * @param filterByFieldName - String pairs representing the
> > from/thru
> > > date field names e.g. "fromDate", "thruDate", "contactFromDate",
> > > "contactThruDate"
> > > * @return this EntityQuery object, to enable chaining
> > > */
> > > public EntityQuery filterByDate(String... filterByFieldName) {
> > > @@ -359,7 +359,7 @@ public class EntityQuery {
> > > /** Specifies whether the query should return only values that are
> > > active during the specified moment using the specified from/thru field
> > name
> > > pairs.
> > > *
> > > * @param moment - Timestamp representing the moment in time that
> > the
> > > values should be active during
> > > - * @param fromThruFieldName - String pairs representing the
> > from/thru
> > > date field names e.g. "fromDate", "thruDate", "contactFromDate",
> > > "contactThruDate"
> > > + * @param filterByFieldName - String pairs representing the
> > from/thru
> > > date field names e.g. "fromDate", "thruDate", "contactFromDate",
> > > "contactThruDate"
> > > * @return this EntityQuery object, to enable chaining
> > > */
> > > public EntityQuery filterByDate(Timestamp moment, String...
> > > filterByFieldName) {
> > >
> > >
> > >
> >
>
Re: svn commit: r1773338 - in /ofbiz/trunk/framework:
base/src/main/java/org/apache/ofbiz/base/container/ base/src/main/java/org/apache/ofbiz/base/util/
base/src/main/java/org/apache/ofbiz/base/util/cache/ common/src/main/java/org/apache/ofbiz/common/image...
Posted by Jacopo Cappellato <ja...@hotwaxsystems.com>.
Thank you Taher!!!
In rev 1773354 I have removed also the diamond operator because my IDE was
considering it illegal for Javadoc; let me know if you have suggestions and
I will fix it (or feel free to modify it if you are working on the same).
Jacopo
On Fri, Dec 9, 2016 at 10:10 AM, Taher Alkhateeb <slidingfilaments@gmail.com
> wrote:
> Great work Jacopo!
>
> minor note:
> - * @see org.apache.ofbiz.base.start.StartupLoader#load(Config,
> String[])
> + * @see org.apache.ofbiz.base.start.StartupLoader#load(Config,
> List<StartupCommand>[])
>
> There is still an array set of brackets "[]" which should go away
>
> It's funny but I'm actually working on the javadocs right now to try an
> enforce guidelines by gradle. Weird that we work on the same stuff, must be
> telepathy :)
>
> On Fri, Dec 9, 2016 at 11:49 AM, <ja...@apache.org> wrote:
>
> > Author: jacopoc
> > Date: Fri Dec 9 08:49:56 2016
> > New Revision: 1773338
> >
> > URL: http://svn.apache.org/viewvc?rev=1773338&view=rev
> > Log:
> > Fixed: a series of wrong argument names in Javadoc comments.
> >
> > Modified:
> > ofbiz/trunk/framework/base/src/main/java/org/apache/
> > ofbiz/base/container/ContainerLoader.java
> > ofbiz/trunk/framework/base/src/main/java/org/apache/
> > ofbiz/base/util/UtilXml.java
> > ofbiz/trunk/framework/base/src/main/java/org/apache/
> > ofbiz/base/util/cache/UtilCache.java
> > ofbiz/trunk/framework/common/src/main/java/org/apache/
> > ofbiz/common/image/ImageTransform.java
> > ofbiz/trunk/framework/entity/src/main/java/org/apache/
> > ofbiz/entity/model/ModelUtil.java
> > ofbiz/trunk/framework/entity/src/main/java/org/apache/
> > ofbiz/entity/util/EntityQuery.java
> >
> > Modified: ofbiz/trunk/framework/base/src/main/java/org/apache/
> > ofbiz/base/container/ContainerLoader.java
> > URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/
> > src/main/java/org/apache/ofbiz/base/container/ContainerLoader.java?rev=
> > 1773338&r1=1773337&r2=1773338&view=diff
> > ============================================================
> > ==================
> > --- ofbiz/trunk/framework/base/src/main/java/org/apache/
> > ofbiz/base/container/ContainerLoader.java (original)
> > +++ ofbiz/trunk/framework/base/src/main/java/org/apache/
> > ofbiz/base/container/ContainerLoader.java Fri Dec 9 08:49:56 2016
> > @@ -49,7 +49,7 @@ public class ContainerLoader implements
> > private final List<Container> loadedContainers = new
> > LinkedList<Container>();
> >
> > /**
> > - * @see org.apache.ofbiz.base.start.StartupLoader#load(Config,
> > String[])
> > + * @see org.apache.ofbiz.base.start.StartupLoader#load(Config,
> > List<StartupCommand>[])
> > */
> > @Override
> > public synchronized void load(Config config, List<StartupCommand>
> > ofbizCommands) throws StartupException {
> >
> > Modified: ofbiz/trunk/framework/base/src/main/java/org/apache/
> > ofbiz/base/util/UtilXml.java
> > URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/
> > src/main/java/org/apache/ofbiz/base/util/UtilXml.java?
> > rev=1773338&r1=1773337&r2=1773338&view=diff
> > ============================================================
> > ==================
> > --- ofbiz/trunk/framework/base/src/main/java/org/apache/
> ofbiz/base/util/UtilXml.java
> > (original)
> > +++ ofbiz/trunk/framework/base/src/main/java/org/apache/
> ofbiz/base/util/UtilXml.java
> > Fri Dec 9 08:49:56 2016
> > @@ -1148,7 +1148,7 @@ public final class UtilXml {
> >
> > /**
> > * get tag name without any prefix
> > - * @param node
> > + * @param element
> > * @return
> > */
> > public static String getTagNameIgnorePrefix(Element element){
> > @@ -1163,7 +1163,7 @@ public final class UtilXml {
> >
> > /**
> > * get attribute value ignoring prefix in attribute name
> > - * @param node
> > + * @param element
> > * @return
> > */
> > public static String getAttributeValueIgnorePrefix(Element element,
> > String attributeName){
> >
> > Modified: ofbiz/trunk/framework/base/src/main/java/org/apache/
> > ofbiz/base/util/cache/UtilCache.java
> > URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/
> > src/main/java/org/apache/ofbiz/base/util/cache/
> > UtilCache.java?rev=1773338&r1=1773337&r2=1773338&view=diff
> > ============================================================
> > ==================
> > --- ofbiz/trunk/framework/base/src/main/java/org/apache/
> > ofbiz/base/util/cache/UtilCache.java (original)
> > +++ ofbiz/trunk/framework/base/src/main/java/org/apache/
> > ofbiz/base/util/cache/UtilCache.java Fri Dec 9 08:49:56 2016
> > @@ -111,7 +111,7 @@ public class UtilCache<K, V> implements
> > /** Constructor which specifies the cacheName as well as the
> > sizeLimit, expireTime and useSoftReference.
> > * The passed sizeLimit, expireTime and useSoftReference will be
> > overridden by values from cache.properties if found.
> > * @param sizeLimit The sizeLimit member is set to this value
> > - * @param expireTime The expireTime member is set to this value
> > + * @param expireTimeMillis The expireTime member is set to this
> value
> > * @param cacheName The name of the cache.
> > * @param useSoftReference Specifies whether or not to use soft
> > references for this cache.
> > */
> >
> > Modified: ofbiz/trunk/framework/common/src/main/java/org/apache/
> > ofbiz/common/image/ImageTransform.java
> > URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/common/
> > src/main/java/org/apache/ofbiz/common/image/ImageTransform.java?rev=
> > 1773338&r1=1773337&r2=1773338&view=diff
> > ============================================================
> > ==================
> > --- ofbiz/trunk/framework/common/src/main/java/org/apache/
> > ofbiz/common/image/ImageTransform.java (original)
> > +++ ofbiz/trunk/framework/common/src/main/java/org/apache/
> > ofbiz/common/image/ImageTransform.java Fri Dec 9 08:49:56 2016
> > @@ -63,7 +63,7 @@ public class ImageTransform {
> > * @param fileLocation Full file Path or URL
> > * @return URL images for all different size types
> > * @throws IOException Error prevents the document from being fully
> > parsed
> > - * @throws JDOMException Errors occur in parsing
> > + * @throws IllegalArgumentException Errors occur in parsing
> > */
> > public static Map<String, Object> getBufferedImage(String
> > fileLocation, Locale locale)
> > throws IllegalArgumentException, IOException {
> >
> > Modified: ofbiz/trunk/framework/entity/src/main/java/org/apache/
> > ofbiz/entity/model/ModelUtil.java
> > URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/
> > src/main/java/org/apache/ofbiz/entity/model/ModelUtil.
> > java?rev=1773338&r1=1773337&r2=1773338&view=diff
> > ============================================================
> > ==================
> > --- ofbiz/trunk/framework/entity/src/main/java/org/apache/
> > ofbiz/entity/model/ModelUtil.java (original)
> > +++ ofbiz/trunk/framework/entity/src/main/java/org/apache/
> > ofbiz/entity/model/ModelUtil.java Fri Dec 9 08:49:56 2016
> > @@ -314,7 +314,7 @@ public final class ModelUtil {
> > * Check is a ModelEntity have a default resource associate to
> > resolve localized value
> > * When the ModelEntity is a ModelViewEntity, check with the list
> > fields to resolve these related entities
> > * @param modelEntity
> > - * @param fieldName
> > + * @param fieldNames
> > * @return
> > */
> > public static boolean isPotentialLocalizedFields(ModelEntity
> > modelEntity, List<String> fieldNames) {
> >
> > Modified: ofbiz/trunk/framework/entity/src/main/java/org/apache/
> > ofbiz/entity/util/EntityQuery.java
> > URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/
> > src/main/java/org/apache/ofbiz/entity/util/EntityQuery.
> > java?rev=1773338&r1=1773337&r2=1773338&view=diff
> > ============================================================
> > ==================
> > --- ofbiz/trunk/framework/entity/src/main/java/org/apache/
> > ofbiz/entity/util/EntityQuery.java (original)
> > +++ ofbiz/trunk/framework/entity/src/main/java/org/apache/
> > ofbiz/entity/util/EntityQuery.java Fri Dec 9 08:49:56 2016
> > @@ -104,7 +104,7 @@ public class EntityQuery {
> > * Note that the select methods are not additive, if a subsequent
> > * call is made to select then the existing fields for selection
> > * will be replaced.
> > - * @param fieldsToSelect - Strings containing the field names to be
> > selected
> > + * @param fields - Strings containing the field names to be selected
> > * @return this EntityQuery object, to enable chaining
> > */
> > public EntityQuery select(String...fields) {
> > @@ -157,7 +157,7 @@ public class EntityQuery {
> > /** Set a series of field name/values to be ANDed together as the
> > WHERE clause for the query
> > *
> > * NOTE: Each successive call to any of the where(...) methods will
> > replace the currently set condition for the query.
> > - * @param fieldMap - A series of field names/values to be ANDed
> > together as the where clause for the query
> > + * @param fields - A series of field names/values to be ANDed
> > together as the where clause for the query
> > * @return this EntityQuery object, to enable chaining
> > */
> > public EntityQuery where(Object...fields) {
> > @@ -179,7 +179,7 @@ public class EntityQuery {
> > /** Set a list of EntityCondition objects to be ANDed together as
> the
> > WHERE clause for the query
> > *
> > * NOTE: Each successive call to any of the where(...) methods will
> > replace the currently set condition for the query.
> > - * @param fieldMap - A list of EntityCondition objects to be ANDed
> > together as the WHERE clause for the query
> > + * @param andConditions - A list of EntityCondition objects to be
> > ANDed together as the WHERE clause for the query
> > * @return this EntityQuery object, to enable chaining
> > */
> > public <T extends EntityCondition> EntityQuery where(List<T>
> > andConditions) {
> > @@ -214,7 +214,7 @@ public class EntityQuery {
> > /** The fields of the named entity to order the resultset by;
> > optionally add a " ASC" for ascending or " DESC" for descending
> > *
> > * NOTE: Each successive call to any of the orderBy(...) methods
> will
> > replace the currently set orderBy fields for the query.
> > - * @param orderBy - The fields of the named entity to order the
> > resultset by
> > + * @param fields - The fields of the named entity to order the
> > resultset by
> > * @return this EntityQuery object, to enable chaining
> > */
> > public EntityQuery orderBy(String...fields) {
> > @@ -349,7 +349,7 @@ public class EntityQuery {
> >
> > /** Specifies whether the query should return only values that are
> > currently active using the specified from/thru field name pairs.
> > *
> > - * @param fromThruFieldName - String pairs representing the
> from/thru
> > date field names e.g. "fromDate", "thruDate", "contactFromDate",
> > "contactThruDate"
> > + * @param filterByFieldName - String pairs representing the
> from/thru
> > date field names e.g. "fromDate", "thruDate", "contactFromDate",
> > "contactThruDate"
> > * @return this EntityQuery object, to enable chaining
> > */
> > public EntityQuery filterByDate(String... filterByFieldName) {
> > @@ -359,7 +359,7 @@ public class EntityQuery {
> > /** Specifies whether the query should return only values that are
> > active during the specified moment using the specified from/thru field
> name
> > pairs.
> > *
> > * @param moment - Timestamp representing the moment in time that
> the
> > values should be active during
> > - * @param fromThruFieldName - String pairs representing the
> from/thru
> > date field names e.g. "fromDate", "thruDate", "contactFromDate",
> > "contactThruDate"
> > + * @param filterByFieldName - String pairs representing the
> from/thru
> > date field names e.g. "fromDate", "thruDate", "contactFromDate",
> > "contactThruDate"
> > * @return this EntityQuery object, to enable chaining
> > */
> > public EntityQuery filterByDate(Timestamp moment, String...
> > filterByFieldName) {
> >
> >
> >
>
Re: svn commit: r1773338 - in /ofbiz/trunk/framework:
base/src/main/java/org/apache/ofbiz/base/container/ base/src/main/java/org/apache/ofbiz/base/util/
base/src/main/java/org/apache/ofbiz/base/util/cache/ common/src/main/java/org/apache/ofbiz/common/image...
Posted by Taher Alkhateeb <sl...@gmail.com>.
Great work Jacopo!
minor note:
- * @see org.apache.ofbiz.base.start.StartupLoader#load(Config,
String[])
+ * @see org.apache.ofbiz.base.start.StartupLoader#load(Config,
List<StartupCommand>[])
There is still an array set of brackets "[]" which should go away
It's funny but I'm actually working on the javadocs right now to try an
enforce guidelines by gradle. Weird that we work on the same stuff, must be
telepathy :)
On Fri, Dec 9, 2016 at 11:49 AM, <ja...@apache.org> wrote:
> Author: jacopoc
> Date: Fri Dec 9 08:49:56 2016
> New Revision: 1773338
>
> URL: http://svn.apache.org/viewvc?rev=1773338&view=rev
> Log:
> Fixed: a series of wrong argument names in Javadoc comments.
>
> Modified:
> ofbiz/trunk/framework/base/src/main/java/org/apache/
> ofbiz/base/container/ContainerLoader.java
> ofbiz/trunk/framework/base/src/main/java/org/apache/
> ofbiz/base/util/UtilXml.java
> ofbiz/trunk/framework/base/src/main/java/org/apache/
> ofbiz/base/util/cache/UtilCache.java
> ofbiz/trunk/framework/common/src/main/java/org/apache/
> ofbiz/common/image/ImageTransform.java
> ofbiz/trunk/framework/entity/src/main/java/org/apache/
> ofbiz/entity/model/ModelUtil.java
> ofbiz/trunk/framework/entity/src/main/java/org/apache/
> ofbiz/entity/util/EntityQuery.java
>
> Modified: ofbiz/trunk/framework/base/src/main/java/org/apache/
> ofbiz/base/container/ContainerLoader.java
> URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/
> src/main/java/org/apache/ofbiz/base/container/ContainerLoader.java?rev=
> 1773338&r1=1773337&r2=1773338&view=diff
> ============================================================
> ==================
> --- ofbiz/trunk/framework/base/src/main/java/org/apache/
> ofbiz/base/container/ContainerLoader.java (original)
> +++ ofbiz/trunk/framework/base/src/main/java/org/apache/
> ofbiz/base/container/ContainerLoader.java Fri Dec 9 08:49:56 2016
> @@ -49,7 +49,7 @@ public class ContainerLoader implements
> private final List<Container> loadedContainers = new
> LinkedList<Container>();
>
> /**
> - * @see org.apache.ofbiz.base.start.StartupLoader#load(Config,
> String[])
> + * @see org.apache.ofbiz.base.start.StartupLoader#load(Config,
> List<StartupCommand>[])
> */
> @Override
> public synchronized void load(Config config, List<StartupCommand>
> ofbizCommands) throws StartupException {
>
> Modified: ofbiz/trunk/framework/base/src/main/java/org/apache/
> ofbiz/base/util/UtilXml.java
> URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/
> src/main/java/org/apache/ofbiz/base/util/UtilXml.java?
> rev=1773338&r1=1773337&r2=1773338&view=diff
> ============================================================
> ==================
> --- ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilXml.java
> (original)
> +++ ofbiz/trunk/framework/base/src/main/java/org/apache/ofbiz/base/util/UtilXml.java
> Fri Dec 9 08:49:56 2016
> @@ -1148,7 +1148,7 @@ public final class UtilXml {
>
> /**
> * get tag name without any prefix
> - * @param node
> + * @param element
> * @return
> */
> public static String getTagNameIgnorePrefix(Element element){
> @@ -1163,7 +1163,7 @@ public final class UtilXml {
>
> /**
> * get attribute value ignoring prefix in attribute name
> - * @param node
> + * @param element
> * @return
> */
> public static String getAttributeValueIgnorePrefix(Element element,
> String attributeName){
>
> Modified: ofbiz/trunk/framework/base/src/main/java/org/apache/
> ofbiz/base/util/cache/UtilCache.java
> URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/base/
> src/main/java/org/apache/ofbiz/base/util/cache/
> UtilCache.java?rev=1773338&r1=1773337&r2=1773338&view=diff
> ============================================================
> ==================
> --- ofbiz/trunk/framework/base/src/main/java/org/apache/
> ofbiz/base/util/cache/UtilCache.java (original)
> +++ ofbiz/trunk/framework/base/src/main/java/org/apache/
> ofbiz/base/util/cache/UtilCache.java Fri Dec 9 08:49:56 2016
> @@ -111,7 +111,7 @@ public class UtilCache<K, V> implements
> /** Constructor which specifies the cacheName as well as the
> sizeLimit, expireTime and useSoftReference.
> * The passed sizeLimit, expireTime and useSoftReference will be
> overridden by values from cache.properties if found.
> * @param sizeLimit The sizeLimit member is set to this value
> - * @param expireTime The expireTime member is set to this value
> + * @param expireTimeMillis The expireTime member is set to this value
> * @param cacheName The name of the cache.
> * @param useSoftReference Specifies whether or not to use soft
> references for this cache.
> */
>
> Modified: ofbiz/trunk/framework/common/src/main/java/org/apache/
> ofbiz/common/image/ImageTransform.java
> URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/common/
> src/main/java/org/apache/ofbiz/common/image/ImageTransform.java?rev=
> 1773338&r1=1773337&r2=1773338&view=diff
> ============================================================
> ==================
> --- ofbiz/trunk/framework/common/src/main/java/org/apache/
> ofbiz/common/image/ImageTransform.java (original)
> +++ ofbiz/trunk/framework/common/src/main/java/org/apache/
> ofbiz/common/image/ImageTransform.java Fri Dec 9 08:49:56 2016
> @@ -63,7 +63,7 @@ public class ImageTransform {
> * @param fileLocation Full file Path or URL
> * @return URL images for all different size types
> * @throws IOException Error prevents the document from being fully
> parsed
> - * @throws JDOMException Errors occur in parsing
> + * @throws IllegalArgumentException Errors occur in parsing
> */
> public static Map<String, Object> getBufferedImage(String
> fileLocation, Locale locale)
> throws IllegalArgumentException, IOException {
>
> Modified: ofbiz/trunk/framework/entity/src/main/java/org/apache/
> ofbiz/entity/model/ModelUtil.java
> URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/
> src/main/java/org/apache/ofbiz/entity/model/ModelUtil.
> java?rev=1773338&r1=1773337&r2=1773338&view=diff
> ============================================================
> ==================
> --- ofbiz/trunk/framework/entity/src/main/java/org/apache/
> ofbiz/entity/model/ModelUtil.java (original)
> +++ ofbiz/trunk/framework/entity/src/main/java/org/apache/
> ofbiz/entity/model/ModelUtil.java Fri Dec 9 08:49:56 2016
> @@ -314,7 +314,7 @@ public final class ModelUtil {
> * Check is a ModelEntity have a default resource associate to
> resolve localized value
> * When the ModelEntity is a ModelViewEntity, check with the list
> fields to resolve these related entities
> * @param modelEntity
> - * @param fieldName
> + * @param fieldNames
> * @return
> */
> public static boolean isPotentialLocalizedFields(ModelEntity
> modelEntity, List<String> fieldNames) {
>
> Modified: ofbiz/trunk/framework/entity/src/main/java/org/apache/
> ofbiz/entity/util/EntityQuery.java
> URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/entity/
> src/main/java/org/apache/ofbiz/entity/util/EntityQuery.
> java?rev=1773338&r1=1773337&r2=1773338&view=diff
> ============================================================
> ==================
> --- ofbiz/trunk/framework/entity/src/main/java/org/apache/
> ofbiz/entity/util/EntityQuery.java (original)
> +++ ofbiz/trunk/framework/entity/src/main/java/org/apache/
> ofbiz/entity/util/EntityQuery.java Fri Dec 9 08:49:56 2016
> @@ -104,7 +104,7 @@ public class EntityQuery {
> * Note that the select methods are not additive, if a subsequent
> * call is made to select then the existing fields for selection
> * will be replaced.
> - * @param fieldsToSelect - Strings containing the field names to be
> selected
> + * @param fields - Strings containing the field names to be selected
> * @return this EntityQuery object, to enable chaining
> */
> public EntityQuery select(String...fields) {
> @@ -157,7 +157,7 @@ public class EntityQuery {
> /** Set a series of field name/values to be ANDed together as the
> WHERE clause for the query
> *
> * NOTE: Each successive call to any of the where(...) methods will
> replace the currently set condition for the query.
> - * @param fieldMap - A series of field names/values to be ANDed
> together as the where clause for the query
> + * @param fields - A series of field names/values to be ANDed
> together as the where clause for the query
> * @return this EntityQuery object, to enable chaining
> */
> public EntityQuery where(Object...fields) {
> @@ -179,7 +179,7 @@ public class EntityQuery {
> /** Set a list of EntityCondition objects to be ANDed together as the
> WHERE clause for the query
> *
> * NOTE: Each successive call to any of the where(...) methods will
> replace the currently set condition for the query.
> - * @param fieldMap - A list of EntityCondition objects to be ANDed
> together as the WHERE clause for the query
> + * @param andConditions - A list of EntityCondition objects to be
> ANDed together as the WHERE clause for the query
> * @return this EntityQuery object, to enable chaining
> */
> public <T extends EntityCondition> EntityQuery where(List<T>
> andConditions) {
> @@ -214,7 +214,7 @@ public class EntityQuery {
> /** The fields of the named entity to order the resultset by;
> optionally add a " ASC" for ascending or " DESC" for descending
> *
> * NOTE: Each successive call to any of the orderBy(...) methods will
> replace the currently set orderBy fields for the query.
> - * @param orderBy - The fields of the named entity to order the
> resultset by
> + * @param fields - The fields of the named entity to order the
> resultset by
> * @return this EntityQuery object, to enable chaining
> */
> public EntityQuery orderBy(String...fields) {
> @@ -349,7 +349,7 @@ public class EntityQuery {
>
> /** Specifies whether the query should return only values that are
> currently active using the specified from/thru field name pairs.
> *
> - * @param fromThruFieldName - String pairs representing the from/thru
> date field names e.g. "fromDate", "thruDate", "contactFromDate",
> "contactThruDate"
> + * @param filterByFieldName - String pairs representing the from/thru
> date field names e.g. "fromDate", "thruDate", "contactFromDate",
> "contactThruDate"
> * @return this EntityQuery object, to enable chaining
> */
> public EntityQuery filterByDate(String... filterByFieldName) {
> @@ -359,7 +359,7 @@ public class EntityQuery {
> /** Specifies whether the query should return only values that are
> active during the specified moment using the specified from/thru field name
> pairs.
> *
> * @param moment - Timestamp representing the moment in time that the
> values should be active during
> - * @param fromThruFieldName - String pairs representing the from/thru
> date field names e.g. "fromDate", "thruDate", "contactFromDate",
> "contactThruDate"
> + * @param filterByFieldName - String pairs representing the from/thru
> date field names e.g. "fromDate", "thruDate", "contactFromDate",
> "contactThruDate"
> * @return this EntityQuery object, to enable chaining
> */
> public EntityQuery filterByDate(Timestamp moment, String...
> filterByFieldName) {
>
>
>