You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by br...@apache.org on 2013/02/17 14:18:00 UTC

svn commit: r1447019 - /commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java

Author: britter
Date: Sun Feb 17 13:17:59 2013
New Revision: 1447019

URL: http://svn.apache.org/r1447019
Log:
Wrap JavaDoc paragraphs in <p>-tags

Modified:
    commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java

Modified: commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java
URL: http://svn.apache.org/viewvc/commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java?rev=1447019&r1=1447018&r2=1447019&view=diff
==============================================================================
--- commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java (original)
+++ commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java Sun Feb 17 13:17:59 2013
@@ -20,7 +20,9 @@ package org.apache.commons.beanutils2;
  */
 
 /**
+ * <p>
  * Provides access to constructors and static methods on a class.
+ * </p>
  *
  * @param <B> The type modeled by this {@code ClassAccessor}.
  */
@@ -30,9 +32,11 @@ public interface ClassAccessor<B>
     // constructors
 
     /**
+     * <p>
      * Creates a new instance of type {@code B} by calling the parameterless constructor of the wrapped class.
+     * </p>
      *
-     * @param<B> the type of the new instance
+     * @param <B> the type of the new instance
      * @return a {@link BeanAccessor} that wraps the new instance.
      * @throws BeanInstantiationException if the class wrapped by this {@code ClassAccessor} is not instantiable (for
      *             example if it is a primitive type).
@@ -44,8 +48,10 @@ public interface ClassAccessor<B>
     BeanAccessor<B> newInstance();
 
     /**
+     * <p>
      * Invokes the constructor with the parameter list represented by {@code arguments} on the wrapped class. Primitive
      * types may be converted to wrapper types and vice versa to match the methods signature.
+     * </p>
      *
      * @param arguments the list of arguments to invoke the constructor with. None of the {@code Argument} objects must
      *            be {@code null}. If you want to pass {@code null} to the constructor use
@@ -60,8 +66,10 @@ public interface ClassAccessor<B>
     BeanAccessor<B> invokeConstructor( Argument<?>... arguments );
 
     /**
+     * <p>
      * Invokes the constructor with the parameter list represented by {@code arguments} on the wrapped class. Invoking
      * an exact constructor in this context means to not perform any type conversations during invocation.
+     * </p>
      *
      * @param arguments the list of arguments to invoke the constructor with. None of the {@code Argument} objects must
      *            be {@code null}. If you want to pass {@code null} to the constructor use
@@ -79,7 +87,9 @@ public interface ClassAccessor<B>
     // bean properties
 
     /**
+     * <p>
      * Provides access to the {@link BeanProperties} defined by the wrapped class.
+     * </p>
      *
      * @return the {@link BeanProperties} for the wrapped class.
      */
@@ -88,8 +98,10 @@ public interface ClassAccessor<B>
     // static methods invocation
 
     /**
+     * <p>
      * Invokes the method with name {@code methodName} on the wrapped class. Primitive types may be converted to wrapper
      * types and vice versa to match the methods signature.
+     * </p>
      *
      * @param methodName the name of the method to invoke. Must not be {@code null}!
      * @return the {@link ArgumentsAccessor} for this method invocation.
@@ -97,8 +109,10 @@ public interface ClassAccessor<B>
     ArgumentsAccessor invokeStatic( String methodName );
 
     /**
+     * <p>
      * Invokes the method with name {@code methodName} on the wrapped class. Invoking an exact method in this context
      * means to not perform any type conversations during invocation.
+     * </p>
      *
      * @param methodName the name of the method to invoke. Must not be {@code null}!
      * @return the {@link ArgumentsAccessor} for this method invocation.



Re: svn commit: r1447019 - /commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java

Posted by Simone Tripodi <si...@apache.org>.
Hallo Bene,

don't worry, the good thing is we have an SCM that allows us reviewing
modifications, so we can discuss about modifications :)

Alles gute!
-Simo

http://people.apache.org/~simonetripodi/
http://simonetripodi.livejournal.com/
http://twitter.com/simonetripodi
http://www.99soft.org/


On Mon, Feb 18, 2013 at 9:11 AM, Benedikt Ritter <br...@apache.org> wrote:
> Ciao Simo,
>
> thanks a lot! I adopted the <p>-tags from BU1. I was wondering why they are
> used in that way in BU1. Should have asked the ML. I'll change this tonight!
>
> Benedikt
>
>
> 2013/2/17 Simone Tripodi <si...@apache.org>
>
>> unneeded, I suggest you to read our mate Stephen's blog about that:
>> http://blog.joda.org/2012/11/javadoc-coding-standards.html
>>
>> HTH,
>> -Simo
>>
>> http://people.apache.org/~simonetripodi/
>> http://simonetripodi.livejournal.com/
>> http://twitter.com/simonetripodi
>> http://www.99soft.org/
>>
>>
>> On Sun, Feb 17, 2013 at 2:18 PM,  <br...@apache.org> wrote:
>> > Author: britter
>> > Date: Sun Feb 17 13:17:59 2013
>> > New Revision: 1447019
>> >
>> > URL: http://svn.apache.org/r1447019
>> > Log:
>> > Wrap JavaDoc paragraphs in <p>-tags
>> >
>> > Modified:
>> >
>> commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java
>> >
>> > Modified:
>> commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java
>> > URL:
>> http://svn.apache.org/viewvc/commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java?rev=1447019&r1=1447018&r2=1447019&view=diff
>> >
>> ==============================================================================
>> > ---
>> commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java
>> (original)
>> > +++
>> commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java
>> Sun Feb 17 13:17:59 2013
>> > @@ -20,7 +20,9 @@ package org.apache.commons.beanutils2;
>> >   */
>> >
>> >  /**
>> > + * <p>
>> >   * Provides access to constructors and static methods on a class.
>> > + * </p>
>> >   *
>> >   * @param <B> The type modeled by this {@code ClassAccessor}.
>> >   */
>> > @@ -30,9 +32,11 @@ public interface ClassAccessor<B>
>> >      // constructors
>> >
>> >      /**
>> > +     * <p>
>> >       * Creates a new instance of type {@code B} by calling the
>> parameterless constructor of the wrapped class.
>> > +     * </p>
>> >       *
>> > -     * @param<B> the type of the new instance
>> > +     * @param <B> the type of the new instance
>> >       * @return a {@link BeanAccessor} that wraps the new instance.
>> >       * @throws BeanInstantiationException if the class wrapped by this
>> {@code ClassAccessor} is not instantiable (for
>> >       *             example if it is a primitive type).
>> > @@ -44,8 +48,10 @@ public interface ClassAccessor<B>
>> >      BeanAccessor<B> newInstance();
>> >
>> >      /**
>> > +     * <p>
>> >       * Invokes the constructor with the parameter list represented by
>> {@code arguments} on the wrapped class. Primitive
>> >       * types may be converted to wrapper types and vice versa to match
>> the methods signature.
>> > +     * </p>
>> >       *
>> >       * @param arguments the list of arguments to invoke the constructor
>> with. None of the {@code Argument} objects must
>> >       *            be {@code null}. If you want to pass {@code null} to
>> the constructor use
>> > @@ -60,8 +66,10 @@ public interface ClassAccessor<B>
>> >      BeanAccessor<B> invokeConstructor( Argument<?>... arguments );
>> >
>> >      /**
>> > +     * <p>
>> >       * Invokes the constructor with the parameter list represented by
>> {@code arguments} on the wrapped class. Invoking
>> >       * an exact constructor in this context means to not perform any
>> type conversations during invocation.
>> > +     * </p>
>> >       *
>> >       * @param arguments the list of arguments to invoke the constructor
>> with. None of the {@code Argument} objects must
>> >       *            be {@code null}. If you want to pass {@code null} to
>> the constructor use
>> > @@ -79,7 +87,9 @@ public interface ClassAccessor<B>
>> >      // bean properties
>> >
>> >      /**
>> > +     * <p>
>> >       * Provides access to the {@link BeanProperties} defined by the
>> wrapped class.
>> > +     * </p>
>> >       *
>> >       * @return the {@link BeanProperties} for the wrapped class.
>> >       */
>> > @@ -88,8 +98,10 @@ public interface ClassAccessor<B>
>> >      // static methods invocation
>> >
>> >      /**
>> > +     * <p>
>> >       * Invokes the method with name {@code methodName} on the wrapped
>> class. Primitive types may be converted to wrapper
>> >       * types and vice versa to match the methods signature.
>> > +     * </p>
>> >       *
>> >       * @param methodName the name of the method to invoke. Must not be
>> {@code null}!
>> >       * @return the {@link ArgumentsAccessor} for this method invocation.
>> > @@ -97,8 +109,10 @@ public interface ClassAccessor<B>
>> >      ArgumentsAccessor invokeStatic( String methodName );
>> >
>> >      /**
>> > +     * <p>
>> >       * Invokes the method with name {@code methodName} on the wrapped
>> class. Invoking an exact method in this context
>> >       * means to not perform any type conversations during invocation.
>> > +     * </p>
>> >       *
>> >       * @param methodName the name of the method to invoke. Must not be
>> {@code null}!
>> >       * @return the {@link ArgumentsAccessor} for this method invocation.
>> >
>> >
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>> For additional commands, e-mail: dev-help@commons.apache.org
>>
>>
>
>
> --
> http://people.apache.org/~britter/
> http://www.systemoutprintln.de/
> http://twitter.com/BenediktRitter
> http://github.com/britter

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: svn commit: r1447019 - /commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java

Posted by Benedikt Ritter <br...@apache.org>.
Ciao Simo,

thanks a lot! I adopted the <p>-tags from BU1. I was wondering why they are
used in that way in BU1. Should have asked the ML. I'll change this tonight!

Benedikt


2013/2/17 Simone Tripodi <si...@apache.org>

> unneeded, I suggest you to read our mate Stephen's blog about that:
> http://blog.joda.org/2012/11/javadoc-coding-standards.html
>
> HTH,
> -Simo
>
> http://people.apache.org/~simonetripodi/
> http://simonetripodi.livejournal.com/
> http://twitter.com/simonetripodi
> http://www.99soft.org/
>
>
> On Sun, Feb 17, 2013 at 2:18 PM,  <br...@apache.org> wrote:
> > Author: britter
> > Date: Sun Feb 17 13:17:59 2013
> > New Revision: 1447019
> >
> > URL: http://svn.apache.org/r1447019
> > Log:
> > Wrap JavaDoc paragraphs in <p>-tags
> >
> > Modified:
> >
> commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java
> >
> > Modified:
> commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java
> > URL:
> http://svn.apache.org/viewvc/commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java?rev=1447019&r1=1447018&r2=1447019&view=diff
> >
> ==============================================================================
> > ---
> commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java
> (original)
> > +++
> commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java
> Sun Feb 17 13:17:59 2013
> > @@ -20,7 +20,9 @@ package org.apache.commons.beanutils2;
> >   */
> >
> >  /**
> > + * <p>
> >   * Provides access to constructors and static methods on a class.
> > + * </p>
> >   *
> >   * @param <B> The type modeled by this {@code ClassAccessor}.
> >   */
> > @@ -30,9 +32,11 @@ public interface ClassAccessor<B>
> >      // constructors
> >
> >      /**
> > +     * <p>
> >       * Creates a new instance of type {@code B} by calling the
> parameterless constructor of the wrapped class.
> > +     * </p>
> >       *
> > -     * @param<B> the type of the new instance
> > +     * @param <B> the type of the new instance
> >       * @return a {@link BeanAccessor} that wraps the new instance.
> >       * @throws BeanInstantiationException if the class wrapped by this
> {@code ClassAccessor} is not instantiable (for
> >       *             example if it is a primitive type).
> > @@ -44,8 +48,10 @@ public interface ClassAccessor<B>
> >      BeanAccessor<B> newInstance();
> >
> >      /**
> > +     * <p>
> >       * Invokes the constructor with the parameter list represented by
> {@code arguments} on the wrapped class. Primitive
> >       * types may be converted to wrapper types and vice versa to match
> the methods signature.
> > +     * </p>
> >       *
> >       * @param arguments the list of arguments to invoke the constructor
> with. None of the {@code Argument} objects must
> >       *            be {@code null}. If you want to pass {@code null} to
> the constructor use
> > @@ -60,8 +66,10 @@ public interface ClassAccessor<B>
> >      BeanAccessor<B> invokeConstructor( Argument<?>... arguments );
> >
> >      /**
> > +     * <p>
> >       * Invokes the constructor with the parameter list represented by
> {@code arguments} on the wrapped class. Invoking
> >       * an exact constructor in this context means to not perform any
> type conversations during invocation.
> > +     * </p>
> >       *
> >       * @param arguments the list of arguments to invoke the constructor
> with. None of the {@code Argument} objects must
> >       *            be {@code null}. If you want to pass {@code null} to
> the constructor use
> > @@ -79,7 +87,9 @@ public interface ClassAccessor<B>
> >      // bean properties
> >
> >      /**
> > +     * <p>
> >       * Provides access to the {@link BeanProperties} defined by the
> wrapped class.
> > +     * </p>
> >       *
> >       * @return the {@link BeanProperties} for the wrapped class.
> >       */
> > @@ -88,8 +98,10 @@ public interface ClassAccessor<B>
> >      // static methods invocation
> >
> >      /**
> > +     * <p>
> >       * Invokes the method with name {@code methodName} on the wrapped
> class. Primitive types may be converted to wrapper
> >       * types and vice versa to match the methods signature.
> > +     * </p>
> >       *
> >       * @param methodName the name of the method to invoke. Must not be
> {@code null}!
> >       * @return the {@link ArgumentsAccessor} for this method invocation.
> > @@ -97,8 +109,10 @@ public interface ClassAccessor<B>
> >      ArgumentsAccessor invokeStatic( String methodName );
> >
> >      /**
> > +     * <p>
> >       * Invokes the method with name {@code methodName} on the wrapped
> class. Invoking an exact method in this context
> >       * means to not perform any type conversations during invocation.
> > +     * </p>
> >       *
> >       * @param methodName the name of the method to invoke. Must not be
> {@code null}!
> >       * @return the {@link ArgumentsAccessor} for this method invocation.
> >
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>


-- 
http://people.apache.org/~britter/
http://www.systemoutprintln.de/
http://twitter.com/BenediktRitter
http://github.com/britter

Re: svn commit: r1447019 - /commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java

Posted by Simone Tripodi <si...@apache.org>.
unneeded, I suggest you to read our mate Stephen's blog about that:
http://blog.joda.org/2012/11/javadoc-coding-standards.html

HTH,
-Simo

http://people.apache.org/~simonetripodi/
http://simonetripodi.livejournal.com/
http://twitter.com/simonetripodi
http://www.99soft.org/


On Sun, Feb 17, 2013 at 2:18 PM,  <br...@apache.org> wrote:
> Author: britter
> Date: Sun Feb 17 13:17:59 2013
> New Revision: 1447019
>
> URL: http://svn.apache.org/r1447019
> Log:
> Wrap JavaDoc paragraphs in <p>-tags
>
> Modified:
>     commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java
>
> Modified: commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java
> URL: http://svn.apache.org/viewvc/commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java?rev=1447019&r1=1447018&r2=1447019&view=diff
> ==============================================================================
> --- commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java (original)
> +++ commons/sandbox/beanutils2/trunk/src/main/java/org/apache/commons/beanutils2/ClassAccessor.java Sun Feb 17 13:17:59 2013
> @@ -20,7 +20,9 @@ package org.apache.commons.beanutils2;
>   */
>
>  /**
> + * <p>
>   * Provides access to constructors and static methods on a class.
> + * </p>
>   *
>   * @param <B> The type modeled by this {@code ClassAccessor}.
>   */
> @@ -30,9 +32,11 @@ public interface ClassAccessor<B>
>      // constructors
>
>      /**
> +     * <p>
>       * Creates a new instance of type {@code B} by calling the parameterless constructor of the wrapped class.
> +     * </p>
>       *
> -     * @param<B> the type of the new instance
> +     * @param <B> the type of the new instance
>       * @return a {@link BeanAccessor} that wraps the new instance.
>       * @throws BeanInstantiationException if the class wrapped by this {@code ClassAccessor} is not instantiable (for
>       *             example if it is a primitive type).
> @@ -44,8 +48,10 @@ public interface ClassAccessor<B>
>      BeanAccessor<B> newInstance();
>
>      /**
> +     * <p>
>       * Invokes the constructor with the parameter list represented by {@code arguments} on the wrapped class. Primitive
>       * types may be converted to wrapper types and vice versa to match the methods signature.
> +     * </p>
>       *
>       * @param arguments the list of arguments to invoke the constructor with. None of the {@code Argument} objects must
>       *            be {@code null}. If you want to pass {@code null} to the constructor use
> @@ -60,8 +66,10 @@ public interface ClassAccessor<B>
>      BeanAccessor<B> invokeConstructor( Argument<?>... arguments );
>
>      /**
> +     * <p>
>       * Invokes the constructor with the parameter list represented by {@code arguments} on the wrapped class. Invoking
>       * an exact constructor in this context means to not perform any type conversations during invocation.
> +     * </p>
>       *
>       * @param arguments the list of arguments to invoke the constructor with. None of the {@code Argument} objects must
>       *            be {@code null}. If you want to pass {@code null} to the constructor use
> @@ -79,7 +87,9 @@ public interface ClassAccessor<B>
>      // bean properties
>
>      /**
> +     * <p>
>       * Provides access to the {@link BeanProperties} defined by the wrapped class.
> +     * </p>
>       *
>       * @return the {@link BeanProperties} for the wrapped class.
>       */
> @@ -88,8 +98,10 @@ public interface ClassAccessor<B>
>      // static methods invocation
>
>      /**
> +     * <p>
>       * Invokes the method with name {@code methodName} on the wrapped class. Primitive types may be converted to wrapper
>       * types and vice versa to match the methods signature.
> +     * </p>
>       *
>       * @param methodName the name of the method to invoke. Must not be {@code null}!
>       * @return the {@link ArgumentsAccessor} for this method invocation.
> @@ -97,8 +109,10 @@ public interface ClassAccessor<B>
>      ArgumentsAccessor invokeStatic( String methodName );
>
>      /**
> +     * <p>
>       * Invokes the method with name {@code methodName} on the wrapped class. Invoking an exact method in this context
>       * means to not perform any type conversations during invocation.
> +     * </p>
>       *
>       * @param methodName the name of the method to invoke. Must not be {@code null}!
>       * @return the {@link ArgumentsAccessor} for this method invocation.
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org