db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Andy Coulbeck (JIRA)" <derby-...@db.apache.org>
Subject [jira] Created: (DERBY-1665) Incorrect JavaDoc for Qualifier interface
Date Thu, 10 Aug 2006 19:21:15 GMT
Incorrect JavaDoc for Qualifier interface

                 Key: DERBY-1665
                 URL: http://issues.apache.org/jira/browse/DERBY-1665
             Project: Derby
          Issue Type: Bug
          Components: Javadoc
            Reporter: Andy Coulbeck
            Priority: Trivial

Just some small comments about the Javadoc for the org.apache.derby.iapi.store.access.Qualifier
interface, that made it hard for me to understand. (see http://db.apache.org/derby/javadoc/engine/)

1. In examples 1a through 4 there looks to be a missing [] in the array initialization.  In
example 1a, instead of:
  qualifier = new Qualifier[3]; // 3 AND clauses

I think it should be:
  qualifier = new Qualifier[3][]; // 3 AND clauses

Similar for 2 through 4.

2. The formatting is messed up as the text for the examples appears as one long hyperlink
in the seeAlso section.

3. This pseudo-code doesn't look right.  I don't think there should be a test on qualifier.negateCompareResult()
at the outer level?

if (qualifier.negateCompareResult())

      compare_result =


    if (qualifier.negateCompareResult()) {

          compare_result = !(compare_result);


This message is automatically generated by JIRA.
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira


View raw message