Summary: resolve compilation, checkstyle, javadoc warnings
           Product: Fop
           Version: 1.1dev
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: major
          Priority: P2
         Component: general

This patch resolves all compilation, checkstyle, and javadocs warnings except
as noted below. Comments follow:

* incorporates the changes introduced by the patch previously posted with Bug
49700, so the comments which apply to it apply here as well; note that one
deprecation warning remains due to an external dependency in

* patches 409 files in order to fix 1969 checkstyle errors, approximately 100
warnings when building javadocs, and a few dozen compilation warnings;

* updates the checkstyle configuration to use version 5.1, and removes old
support for versions 4.0 and 5.0;

* introduces checkstyle-suppressions.xml in order to filter certain errors at
the file level;

* introduces checkstyle control comment keywords CSOFF, CSON, and CSOK in order
to control generation of certain checkstyle errors within source files; CSOFF
disables specific checks, CSON re-enables checks previously disabled, and CSOK
disables checks for the same line on which the comment appears; search for
these keywords in the patched source for examples of usage;

* in general, an attempt was made to remove the underlying cause of a reported
error or warning; however, in certain cases, doing so would have required a
greater amount of refactoring or code rewriting than was desired at this time;
authors or owners of specific code to which the above keywords have been
applied may wish to revisit such code and make the necessary changes that
permits removing the CS control keywords; in other cases, it may be desired to
retain the keywords, e.g., if the author uses a different coding style than
reflected by checkstyle-5.1.xml;

* expands the fileset over which checkstyle runs to include both src/codegen
and src/sandbox hierarchies;

* modifies the checkstyle target to add "package" as a dependency in order to
access compiled class files, access to which is needed to resolve Exception
related class files from @throws comments in the code under test;

* does not yet include sources in the test hierarchy for the purpose of
performing checkstyle testing; this will accomplished after this patch is
merged into the development trunk;

The following commands should be used to apply this patch to the FOP trunk:

$ cd ${FOP_TRUNK}
$ svn update -r 982124
$ gzcat ~/fop-warnings-patch.diff.gz | patch -p0
$ svn rm --force checkstyle-4.0.xml
$ svn rm --force checkstyle-5.0.xml
$ svn rm --force
$ svn add checkstyle-5.1.xml
$ svn add checkstyle-suppressions.xml
$ svn add src/java/org/apache/fop/render/bitmap/
$ svn add src/java/org/apache/fop/svg/

The following are provided as attachments to this bug report:

* patch file (fop-warnings-patch.diff.gz)
* transcript of patch application followed by "ant clean junit checkstyle
* before and after output from checkstyle

This patch was created relative to revision 982124 of FOP trunk.


Configure bugmail:
------- You are receiving this mail because: -------
You are the assignee for the bug.

Reply via email to