README.txt
1__signature-tools__
2
3This project contains the source code and tests for API signature comparison tools.
4It consists roughly of five parts:
5
6#Signature model : A generic model to represent the structure of an API
7
8#Converters : A dex -> signature model converter (utilizing the dex-tools parser)
9 A java source -> signature model converter (utilizing the doclet tools)
10
11#Delta model : A model to represent differences between two signature models
12
13#Comparator : Put two signature models into the comparator and you get a delta model
14
15#Report engine : Translates a delta model to a html output based on templates (utilizing the StringTemplate framework)
16
17
18Since this folder contains a .project file, it can be imported directly into eclipse as a java project.
19
20Feel free to improve!
21
22_Structure_
23
24dex.reader
25 |
26 src : source code
27 | |
28 | signature : the driver classes
29 | |
30 | compare : the comparator code
31 | | |
32 | | model : the delta model
33 | |
34 | converter : the converters
35 | |
36 | io : common io interfaces
37 | | |
38 | | html : html report generator
39 | |
40 | model : signature model
41 |
42 test : source code of the test suite
43 |
44 templates : templates for html output generation
45 |
46 launches : eclipse launches for the tools
47 |
48 lib : required libraries
49 |
50 spec : various input files to try the tool
51 |
52 README.txt : you are here
53 |
54 TODO.txt : tasks which are still open
55
56