db-jdo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Craig L Russell <Craig.Russ...@Sun.COM>
Subject Re: JDO-349 tck20 javadoc warnings
Date Wed, 29 Mar 2006 20:31:14 GMT
Hi Michael,

Go ahead and check in. Just watch out because I've checked in some of  
the changes. :(

Craig

On Mar 29, 2006, at 11:54 AM, Michael Bouschen wrote:

> Hi Craig,
>
> attached you find a patch fixing all the javadoc warnings described  
> in JDO-349. I tried to attach the patch to the JIRA issue, but I  
> still have problems accessing JIRA. You find the patch attached  
> below. Please have a look.
>
> Regards Michael
>
> -- 
> Michael Bouschen		Tech@Spree Engineering GmbH
> mailto:mbo.tech@spree.de	http://www.tech.spree.de/
> Tel.:++49/30/235 520-33		Buelowstr. 66			
> Fax.:++49/30/2175 2012		D-10783 Berlin			
>
> Index: src/java/org/apache/jdo/tck/pc/lifecycle/ 
> StateTransitionObj.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/pc/lifecycle/ 
> StateTransitionObj.java	(Revision 389821)
> +++ src/java/org/apache/jdo/tck/pc/lifecycle/ 
> StateTransitionObj.java	(Arbeitskopie)
> @@ -83,7 +83,7 @@
>
>          /**
>           * Initialize the identifier.
> -         * @param companyid The id of the company.
> +         * @param id The id of the company.
>           */
>          public Oid(int id) {
>              this.id = id;
> Index: src/java/org/apache/jdo/tck/pc/company/Insurance.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/pc/company/Insurance.java	(Revision  
> 389821)
> +++ src/java/org/apache/jdo/tck/pc/company/Insurance.java	 
> (Arbeitskopie)
> @@ -69,7 +69,7 @@
>
>      /**
>       * Set the insurance ID.
> -     * @param insid The insurance ID value.
> +     * @param id The insurance ID value.
>       */
>      public void setInsid(long id) {
>          if (this.insid != 0)
> Index: src/java/org/apache/jdo/tck/query/QueryTest.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/query/QueryTest.java	(Revision 389821)
> +++ src/java/org/apache/jdo/tck/query/QueryTest.java	(Arbeitskopie)
> @@ -660,7 +660,7 @@
>       * if <code>o1</code> and <code>o2</code> equal.
>       * This method iterates over the first collection and
>       * checks if each instance is contained in the second collection
> -     * by calling {@link QueryTest#contains(Collection, Object)}.
> +     * by calling contains(Collection, Object).
>       * This method does not allow <code>o1</code> and <code>o2</code>
>       * to be <code>null</code> both.
>       * @param o1 the first collection
> @@ -689,8 +689,7 @@
>       * Returns <code>true</code>
>       * if <code>o1</code> and <code>o2</code> equal.
>       * This method checks if the key sets and the value sets of both
> -     * maps equal calling
> -     * {@link QueryTest#equalsCollection(Collection, Collection).
> +     * maps equal calling equalsCollection(Collection, Collection).
>       * This method does not allow <code>o1</code> and <code>o2</code>
>       * to be <code>null</code> both.
>       * @param o1 the first map
> @@ -1076,7 +1075,7 @@
>
>      /**
>       * Executes the given query instance delegating to
> -     * {@link QueryTest#execute(String, Query, String, boolean,  
> Object[], Object, boolean).
> +     * execute(String, Query, String, boolean, Object, Object,  
> boolean).
>       * Logs argument <code>singleStringQuery</code>
>       * if debug logging is enabled.
>       * @param assertion the assertion to prompt if the test case  
> fails.
> @@ -1253,8 +1252,8 @@
>       * Converts the given query element holder instance to a
>       * JDO query instance.
>       * Calls {@link Query#deletePersistentAll()}, or
> -     * {@link Query#deletePersistentAll(java.util.Map), or
> -     * {@link Query#deletePersistentAll(java.lang.Object[])
> +     * {@link Query#deletePersistentAll(java.util.Map)}, or
> +     * {@link Query#deletePersistentAll(java.lang.Object[])}
>       * depending on the type of argument <code>parameters</code>.
>       * If the number of deleted objects does not
>       * match <code>expectedNrOfDeletedObjects</code>,
> @@ -1279,8 +1278,8 @@
>       * Converts the given query element holder instance to a
>       * JDO query instance.
>       * Calls {@link Query#deletePersistentAll()}, or
> -     * {@link Query#deletePersistentAll(java.util.Map), or
> -     * {@link Query#deletePersistentAll(java.lang.Object[])
> +     * {@link Query#deletePersistentAll(java.util.Map)}, or
> +     * {@link Query#deletePersistentAll(java.lang.Object[])}
>       * depending on the type of argument <code>parameters</code>.
>       * If the number of deleted objects does not
>       * match <code>expectedNrOfDeletedObjects</code>,
> Index: src/java/org/apache/jdo/tck/query/jdoql/operators/ 
> GreaterThan.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/query/jdoql/operators/ 
> GreaterThan.java	(Revision 389821)
> +++ src/java/org/apache/jdo/tck/query/jdoql/operators/ 
> GreaterThan.java	(Arbeitskopie)
> @@ -1187,9 +1187,7 @@
>          tx.rollback();
>      }
>
> -    /**
> -     * @see JDO_Test#localSetUp()
> -     */
> +    /** */
>      protected void localSetUp() {
>          addTearDownClass(AllTypes.class);
>          AllTypes.load(getPM());
> Index: src/java/org/apache/jdo/tck/query/jdoql/operators/ 
> LessThanOrEqual.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/query/jdoql/operators/ 
> LessThanOrEqual.java	(Revision 389821)
> +++ src/java/org/apache/jdo/tck/query/jdoql/operators/ 
> LessThanOrEqual.java	(Arbeitskopie)
> @@ -1198,9 +1198,7 @@
>          tx.rollback();
>      }
>
> -    /**
> -     * @see JDO_Test#localSetUp()
> -     */
> +    /** */
>      protected void localSetUp() {
>          addTearDownClass(AllTypes.class);
>          AllTypes.load(getPM());
> Index: src/java/org/apache/jdo/tck/query/jdoql/operators/ 
> NotEquals.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/query/jdoql/operators/ 
> NotEquals.java	(Revision 389821)
> +++ src/java/org/apache/jdo/tck/query/jdoql/operators/ 
> NotEquals.java	(Arbeitskopie)
> @@ -1273,9 +1273,7 @@
>          tx.rollback();
>      }
>
> -    /**
> -     * @see JDO_Test#localSetUp()
> -     */
> +    /** */
>      protected void localSetUp() {
>          addTearDownClass(AllTypes.class);
>          AllTypes.load(getPM());
> Index: src/java/org/apache/jdo/tck/query/jdoql/operators/LessThan.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/query/jdoql/operators/LessThan.java	 
> (Revision 389821)
> +++ src/java/org/apache/jdo/tck/query/jdoql/operators/LessThan.java	 
> (Arbeitskopie)
> @@ -1192,9 +1192,7 @@
>          tx.rollback();
>      }
>
> -    /**
> -     * @see JDO_Test#localSetUp()
> -     */
> +    /** */
>      protected void localSetUp() {
>          addTearDownClass(AllTypes.class);
>          AllTypes.load(getPM());
> Index: src/java/org/apache/jdo/tck/query/jdoql/operators/ 
> GreaterThanOrEqual.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/query/jdoql/operators/ 
> GreaterThanOrEqual.java	(Revision 389821)
> +++ src/java/org/apache/jdo/tck/query/jdoql/operators/ 
> GreaterThanOrEqual.java	(Arbeitskopie)
> @@ -1192,9 +1192,7 @@
>          tx.rollback();
>      }
>
> -    /**
> -     * @see JDO_Test#localSetUp()
> -     */
> +    /** */
>      protected void localSetUp() {
>          addTearDownClass(AllTypes.class);
>          AllTypes.load(getPM());
> Index: src/java/org/apache/jdo/tck/query/jdoql/operators/Equality.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/query/jdoql/operators/Equality.java	 
> (Revision 389821)
> +++ src/java/org/apache/jdo/tck/query/jdoql/operators/Equality.java	 
> (Arbeitskopie)
> @@ -1278,9 +1278,7 @@
>          tx.rollback();
>      }
>
> -    /**
> -     * @see JDO_Test#localSetUp()
> -     */
> +    /** */
>      protected void localSetUp() {
>          addTearDownClass(AllTypes.class);
>          AllTypes.load(getPM());
> Index: src/java/org/apache/jdo/tck/query/QueryElementHolder.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/query/QueryElementHolder.java	 
> (Revision 389821)
> +++ src/java/org/apache/jdo/tck/query/QueryElementHolder.java	 
> (Arbeitskopie)
> @@ -185,7 +185,7 @@
>       * {@link PersistenceManager#newQuery(Extent)}.
>       * Afterwards, all query elements of this are transfered
>       * into that instance using API methods like
> -     * {@link javax.jdo.Query#setFilter(java.lang.String) etc.
> +     * {@link javax.jdo.Query#setFilter(java.lang.String)} etc.
>       * @param pm the persistence manager
>       * @return the JDO query instance
>       */
> Index: src/java/org/apache/jdo/tck/query/result/classes/FullName.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/query/result/classes/FullName.java	 
> (Revision 389821)
> +++ src/java/org/apache/jdo/tck/query/result/classes/FullName.java	 
> (Arbeitskopie)
> @@ -103,7 +103,7 @@
>      }
>
>      /**
> -     * @param firstName The firstName to set.
> +     * @param firstname The firstName to set.
>       */
>      public void setFirstname(String firstname) {
>          this.firstName = firstname;
> @@ -117,7 +117,7 @@
>      }
>
>      /**
> -     * @param lastName The lastName to set.
> +     * @param lastname The lastName to set.
>       */
>      public void setLastname(String lastname) {
>          this.lastName = lastname;
> Index: src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByJNDILocationAndClassLoader.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByJNDILocationAndClassLoader.java	(Revision 389821)
> +++ src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByJNDILocationAndClassLoader.java	(Arbeitskopie)
> @@ -75,9 +75,7 @@
>          checkGetPMFWithValidProperties();
>      }
>
> -    /**
> -     * @see AbstractGetPMF#getPMF(String)
> -     */
> +    /** */
>      protected PersistenceManagerFactory getPMF(String name) {
>          Context context = null;
>          try {
> Index: src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByJNDILocation.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByJNDILocation.java	(Revision 389821)
> +++ src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByJNDILocation.java	(Arbeitskopie)
> @@ -75,9 +75,7 @@
>          checkGetPMFWithValidProperties();
>      }
>
> -    /**
> -     * @see AbstractGetPMF#getPMF(String)
> -     */
> +    /** */
>      protected PersistenceManagerFactory getPMF(String name) {
>          Context context = null;
>          try {
> Index: src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByFileAndClassLoader.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByFileAndClassLoader.java	(Revision 389821)
> +++ src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByFileAndClassLoader.java	(Arbeitskopie)
> @@ -76,9 +76,7 @@
>          checkGetPMFWithValidProperties();
>      }
>
> -    /**
> -     * @see AbstractGetPMF#getPMF(String)
> -     */
> +    /** */
>      protected PersistenceManagerFactory getPMF(String name) {
>          return JDOHelper.getPersistenceManagerFactory(new File(name),
>                  Thread.currentThread().getContextClassLoader());
> Index: src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByFile.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByFile.java	(Revision 389821)
> +++ src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByFile.java	(Arbeitskopie)
> @@ -71,9 +71,7 @@
>          checkGetPMFWithValidProperties();
>      }
>
> -    /**
> -     * @see AbstractGetPMF#getPMF(String)
> -     */
> +    /** */
>      protected PersistenceManagerFactory getPMF(String name) {
>          return JDOHelper.getPersistenceManagerFactory(new File 
> (name));
>      }
> Index: src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByResourceAndClassLoader.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByResourceAndClassLoader.java	(Revision 389821)
> +++ src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByResourceAndClassLoader.java	(Arbeitskopie)
> @@ -69,9 +69,7 @@
>          checkGetPMFWithValidProperties();
>      }
>
> -    /**
> -     * @see AbstractGetPMF#getPMF(String)
> -     */
> +    /** */
>      protected PersistenceManagerFactory getPMF(String name) {
>          return JDOHelper.getPersistenceManagerFactory 
> (removePathPrefix(name),
>                  Thread.currentThread().getContextClassLoader());
> Index: src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByResource.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByResource.java	(Revision 389821)
> +++ src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByResource.java	(Arbeitskopie)
> @@ -69,9 +69,7 @@
>          checkGetPMFWithValidProperties();
>      }
>
> -    /**
> -     * @see AbstractGetPMF#getPMF(String)
> -     */
> +    /** */
>      protected PersistenceManagerFactory getPMF(String name) {
>          return JDOHelper.getPersistenceManagerFactory 
> (removePathPrefix(name));
>      }
> Index: src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByStreamAndClassLoader.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByStreamAndClassLoader.java	(Revision 389821)
> +++ src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByStreamAndClassLoader.java	(Arbeitskopie)
> @@ -73,9 +73,7 @@
>          checkGetPMFWithValidProperties();
>      }
>
> -    /**
> -     * @see AbstractGetPMF#getPMF(String)
> -     */
> +    /** */
>      protected PersistenceManagerFactory getPMF(String name) {
>          FileInputStream stream = null;
>          try {
> Index: src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByStream.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByStream.java	(Revision 389821)
> +++ src/java/org/apache/jdo/tck/api/persistencemanagerfactory/ 
> GetPMFByStream.java	(Arbeitskopie)
> @@ -73,9 +73,7 @@
>          checkGetPMFWithValidProperties();
>      }
>
> -    /**
> -     * @see AbstractGetPMF#getPMF(String)
> -     */
> +    /** */
>      protected PersistenceManagerFactory getPMF(String name) {
>          FileInputStream stream = null;
>          try {
> Index: src/java/org/apache/jdo/tck/util/SystemCfgSummary.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/util/SystemCfgSummary.java	 
> (Revision 389821)
> +++ src/java/org/apache/jdo/tck/util/SystemCfgSummary.java	 
> (Arbeitskopie)
> @@ -37,8 +37,8 @@
>
>      /**
>       * Creates a new file containing system configuration  
> information.
> -     * @param args the first element contains the output directory
> -     * @param args the second element contains the file name
> +     * @param args the first element contains the output directory,
> +     * the second element contains the file name
>       */
>      public static void main(String[] args) {
>          String directory = args[0] + File.separator;
> Index: src/java/org/apache/jdo/tck/util/ConversionHelper.java
> ===================================================================
> --- src/java/org/apache/jdo/tck/util/ConversionHelper.java	 
> (Revision 389821)
> +++ src/java/org/apache/jdo/tck/util/ConversionHelper.java	 
> (Arbeitskopie)
> @@ -111,10 +111,10 @@
>
>      /**
>       * Recursively converts all elements of type <code>Object[]</ 
> code>
> -     * in the given <code>array</code> to collections.
> -     * Finally, converts the given <code>array</code> to a collection
> +     * in the given <code>object</code> to collections.
> +     * Finally, converts the given <code>object</code> to a  
> collection
>       * and return it.
> -     * @param array the array
> +     * @param object the object to be converted
>       * @return the collection
>       */
>      public static Object convertObjectArrayElements(Object object) {

Craig Russell
Architect, Sun Java Enterprise System http://java.sun.com/products/jdo
408 276-5638 mailto:Craig.Russell@sun.com
P.S. A good JDO? O, Gasp!


Mime
View raw message