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