Javadoc warnings should be fixed

• Key: JDO-349
• Type: Bug
• Status: Resolved
• Resolution: Fixed
• Priority: Minor
• Assignee: Michael Bouschen
• Reporter: Michelle Caisse
• Component/s: tck2
• Affects Version/s: JDO 2 beta
• Fix Version/s: JDO 2 final

Description

  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\api\persistencemanagerfactory\GetPMFByFile.java:77: warning - Tag @see: reference not found: AbstractGetPMF#getPMF(String)
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\api\persistencemanagerfactory\GetPMFByFileAndClassLoader.java:82: warning - Tag @see: reference not found: AbstractGetPMF#getPMF(String)
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\api\persistencemanagerfactory\GetPMFByJNDILocation.java:81: warning - Tag @see: reference not found: AbstractGetPMF#getPMF(String)
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\api\persistencemanagerfactory\GetPMFByJNDILocationAndClassLoader.java:81: warning - Tag @see: reference not found: AbstractGetPMF#getPMF(String)
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\api\persistencemanagerfactory\GetPMFByResource.java:75: warning - Tag @see: reference not found: AbstractGetPMF#getPMF(String)
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\api\persistencemanagerfactory\GetPMFByResourceAndClassLoader.java:75: warning - Tag @see: reference not found: AbstractGetPMF#getPMF(String)
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\api\persistencemanagerfactory\GetPMFByStream.java:79: warning - Tag @see: reference not found: AbstractGetPMF#getPMF(String)
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\api\persistencemanagerfactory\GetPMFByStreamAndClassLoader.java:79: warning - Tag @see: reference not found: AbstractGetPMF#getPMF(String)
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\pc\company\Insurance.java:74: warning - @param argument "insid" is not a parameter name.
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\pc\lifecycle\StateTransitionObj.java:88: warning - @param argument "companyid" is not a parameter name.
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\query\QueryElementHolder.java:192: warning - Missing closing '}' character for inline tag: "{@link javax.jdo.Query#setFilter(java.lang.String) etc."
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\query\QueryTest.java:1267: warning - Missing closing '}' character for inline tag: "{@link Query#deletePersistentAll(java.util.Map), or
  [javadoc] {@link Query#deletePersistentAll(java.lang.Object[])
  [javadoc] depending on the type of argument <code>parameters</code>.
  [javadoc] If the number of deleted objects does not
  [javadoc] match <code>expectedNrOfDeletedObjects</code>,
  [javadoc] then the test case fails prompting argument <code>assertion</code>."
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\query\QueryTest.java:1293: warning - Missing closing '}' character for inline tag: "{@link Query#deletePersistentAll(java.util.Map), or
  [javadoc] {@link Query#deletePersistentAll(java.lang.Object[])
  [javadoc] depending on the type of argument <code>parameters</code>.
  [javadoc] If the number of deleted objects does not
  [javadoc] match <code>expectedNrOfDeletedObjects</code>,
  [javadoc] then the test case fails prompting argument <code>assertion</code>."
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\query\QueryTest.java:700: warning - Missing closing '}' character for inline tag: "{@link QueryTest#equalsCollection(Collection, Collection).
  [javadoc] This method does not allow <code>o1</code> and <code>o2</code>
  [javadoc] to be <code>null</code> both."
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\query\QueryTest.java:1092: warning - Missing closing '}' character for inline tag: "{@link QueryTest#execute(String, Query, String, boolean, Object[], Object, boolean).
  [javadoc] Logs argument <code>singleStringQuery</code>
  [javadoc] if debug logging is enabled."
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\query\jdoql\operators\Equality.java:1284: warning - Tag @see: reference not found: JDO_Test#localSetUp()
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\query\jdoql\operators\GreaterThan.java:1193: warning - Tag @see: reference not found: JDO_Test#localSetUp()
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\query\jdoql\operators\GreaterThanOrEqual.java:1198: warning - Tag @see: reference not found: JDO_Test#localSetUp()
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\query\jdoql\operators\LessThan.java:1198: warning - Tag @see: reference not found: JDO_Test#localSetUp()
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\query\jdoql\operators\LessThanOrEqual.java:1204: warning - Tag @see: reference not found: JDO_Test#localSetUp()
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\query\jdoql\operators\NotEquals.java:1279: warning - Tag @see: reference not found: JDO_Test#localSetUp()
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\query\result\classes\FullName.java:108: warning - @param argument "firstName" is not a parameter name.
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\query\result\classes\FullName.java:122: warning - @param argument "lastName" is not a parameter name.
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\util\ConversionHelper.java:120: warning - @param argument "array" is not a parameter name.
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\util\SystemCfgSummary.java:43: warning - Parameter "args" is documented more than once.
  [javadoc] Generating C:\svn0\jdo\trunk\tck20\target\docs\apidocs\serialized-form.html...
  [javadoc] Copying file C:\Documents and Settings\michelle\.maven\cache\maven-javadoc-plugin-1.7\plugin-resources\stylesheet.css to file C:\svn0\jdo\trunk\tck20\target\docs\apidocs\stylesheet.css...
  [javadoc] Building index for all the packages and classes...
  [javadoc] Building index for all classes...
  [javadoc] Generating C:\svn0\jdo\trunk\tck20\target\docs\apidocs\help-doc.html...
  [javadoc] 25 warnings

Comments

[Michael Bouschen]

The attached patch (JDO-349-patch) fixes the javadoc warnings. Please have a look.

[Craig Russell]

  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\api\persistencemanagerfactory\GetPMFByFile.java:77: warning - Tag @see: reference not found: AbstractGetPMF#getPMF(String)
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\api\persistencemanagerfactory\GetPMFByFileAndClassLoader.java:82: warning - Tag @see: reference not found: AbstractGetPMF#getPMF(String)
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\api\persistencemanagerfactory\GetPMFByJNDILocation.java:81: warning - Tag @see: reference not found: AbstractGetPMF#getPMF(String)
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\api\persistencemanagerfactory\GetPMFByJNDILocationAndClassLoader.java:81: warning - Tag @see: reference not found: AbstractGetPMF#getPMF(String)
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\api\persistencemanagerfactory\GetPMFByResource.java:75: warning - Tag @see: reference not found: AbstractGetPMF#getPMF(String)
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\api\persistencemanagerfactory\GetPMFByResourceAndClassLoader.java:75: warning - Tag @see: reference not found: AbstractGetPMF#getPMF(String)
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\api\persistencemanagerfactory\GetPMFByStream.java:79: warning - Tag @see: reference not found: AbstractGetPMF#getPMF(String)
  [javadoc] C:\svn0\jdo\trunk\tck20\src\java\org\apache\jdo\tck\api\persistencemanagerfactory\GetPMFByStreamAndClassLoader.java:79: warning - Tag @see: reference not found: AbstractGetPMF#getPMF(String)

<javadoc spec>
The first set of forms (with no class or package) will cause the Javadoc tool to search only through the current class's hierarchy. It will find a member of the current class or interface, one of its superclasses or superinterfaces, or one of its enclosing classes or interfaces (search steps 1-3). It will not search the rest of the current package or other packages (search steps 4-5).
</javadoc>

I can't find anything wrong with these @see tags. They reference the superclass method which according to the javadoc documentation should work.

Anyone have any ideas?