Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

#58 Javadoc call with less warnings (generated + classpath)

closed
nobody
None
5
2006-07-25
2005-12-06
Eric L.
No

Hi,

the attached patch adds a classpath to the javadoc
command and adds also the generated classes to the
sources (adding the need for a dependency to the 'gen'
target).
The advantage is that javadoc already spits a lot less
warnings (~20kB less, out of 100kB).

Cheers, Eric

PS: I plan to now remove all the remaining javadoc
warnings. Tell me if it's not useful.

Discussion

  • Eric L.
    Eric L.
    2005-12-15

    Logged In: YES
    user_id=318488

    OK, I did as announce, and brought down the number of
    warnings generated by javadoc from some hundreds to only 11.
    And these 11 are actually in the 'generated' tree, i.e. they
    are induced by errors in the JAXB implementation.

    Please close the patch once integrated in CVS.

    Thanks, Eric

     
  • Eric L.
    Eric L.
    2006-06-27

    Logged In: YES
    user_id=318488

    I attach a new diff which just removes some little issues
    due to wrong characted encoding (iconv.diff).

    Eric

     
  • Eric L.
    Eric L.
    2006-06-28

    Logged In: YES
    user_id=318488

    Hi,

    I've generated a new diff which obsoletes all the others.
    This time I've been a bit more bold in my corrections, and
    just remove all '@return' tags without explanation, and all
    @param tags with only the name of the variable. This doesn't
    remove any value to the resulting javadoc, so I think it's OK.

    Please close the case and document the new CVS tag once applied.

    Thanks, Eric

    PS: for reuse, how to remove @return and @param without
    explanations:
    for i in $(find . -name \*.java); do if (grep -qe '@return$'
    $i); then grep -ve '@return$' $i > ${i}.NEW && mv -v
    ${i}.NEW $i; fi; done
    for i in $(find . -name \*.java); do if (grep -qe '^[
    ][ ]*\* @param [a-zA-Z0-9][a-zA-Z0-9]*$' $i); then grep
    -ve '^[ ][ ]*\* @param [a-zA-Z0-9][a-zA-Z0-9]*$' $i
    > ${i}.NEW && mv -v ${i}.NEW ${i}; fi; done

     
  • Logged In: YES
    user_id=885594

    Integrated in integration branch

     
    • status: open --> closed