1
2                           JDiff Doclet
3                           ------------
4
5                           Matthew Doar
6                          mdoar@pobox.com
7
8
9The JDiff doclet is used to generate a report describing the
10difference between two public Java APIs. 
11
12The file jdiff.html contains the reference page for JDiff.  The latest
13version of JDiff can be downloaded at:
14http://sourceforge.net/projects/javadiff
15
16To use the Ant task on your own project, see example.xml. More examples
17of using JDiff to compare the public APIs of J2SE1.3 and J2SE1.4 can
18be seen at http://www.jdiff.org
19
20For an example with the source distribution, run "ant" and
21look at the HTML output in ./build/reports/example/changes.html 
22The page at ./build/reports/example/changes/com.acme.sp.SPImpl.html
23shows what a typical page of changes looks like. 
24
25System Requirements
26-------------------
27
28JDiff has been tested with all releases of Java since J2SE1.2 but
29releases of JDiff after 1.10.0 focus on JDK1.5.
30
31License
32-------
33
34JDiff is licensed under the Lesser GNU General Public License (LGPL).
35See the file LICENSE.txt.
36
37Acknowledgements
38----------------
39
40JDiff uses Stuart D. Gathman's Java translation of Gene Myers' O(ND) 
41difference algorithm.
42
43JDiff uses Xerces 1.4.2 from http://www.apache.org.
44
45JDiff also includes a script to use the classdoc application from
46http://classdoc.sourceforge.net or http://www.jensgulden.de, by Jens
47Gulden, (mail@jensgulden.de), to call a doclet such as jdiff on a .jar
48file rather than on source.
49
50Many thanks to the reviewers at Sun and Vitria who gave feedback on early
51versions of JDiff output, and also to the distillers of Laphroaig, and to
52Arturo Fuente for his consistently fine cigars which helped inspire
53much of this work.
54
55
56Footnote:
57
58If you are looking for a generalized diff tool for XML, try diffmk from
59http://wwws.sun.com/software/xml/developers/diffmk/
60