Debian Codegraph @

animal-sniffer-ant-tasks/src/site/apt/index.apt

raw
1 ~~ The MIT License
2 ~~
3 ~~ Copyright (c) 2009 codehaus.org.
4 ~~
5 ~~ Permission is hereby granted, free of charge, to any person obtaining a copy
6 ~~ of this software and associated documentation files (the "Software"), to deal
7 ~~ in the Software without restriction, including without limitation the rights
8 ~~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ~~ copies of the Software, and to permit persons to whom the Software is
10 ~~ furnished to do so, subject to the following conditions:
11 ~~
12 ~~ The above copyright notice and this permission notice shall be included in
13 ~~ all copies or substantial portions of the Software.
14 ~~
15 ~~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 ~~ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 ~~ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 ~~ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 ~~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 ~~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 ~~ THE SOFTWARE.
22 ~~
23
24 ------
25 Introduction
26 ------
27 Stephen Connolly
28 ------
29 2009-11-05
30 ------
31
32 Animal Sniffer ANT Tasks
33
34 The Animal Sniffer ANT Tasks can be used to build signatures of APIs and to check your classes
35 against previously generated signatures.
36
37 * Tasks Overview
38
39 The Animal Sniffer ANT Tasks inlcude the following tasks.
40
41 * <<<build-signatures>>> creates a signature of an API.
42
43 * <<<check-signature>>> checks a classes against an API signature.
44
45 * Usage
46
47 General instructions on how to use the Animal Sniffer ANT Tasks can be found on the {{{./usage.html}usage page}}. Some more
48 specific use cases are described in the examples given below. Last but not least, users occasionally contribute
49 additional examples, tips or errata to the
50 {{{http://docs.codehaus.org/display/MAVENUSER/Animal+Sniffer+ANT+Tasks}ANT Tasks's wiki page}}.
51
52 In case you still have questions regarding the ANT Tasks's usage, please feel
53 free to contact the {{{./mail-lists.html}user mailing list}}. The posts to the mailing list are archived and could
54 already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
55 the {{{./mail-lists.html}mail archive}}.
56
57 If you feel like the ANT Tasks are missing a feature or have a defect, you can fill a feature request or bug report in our
58 {{{./issue-tracking.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
59 concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason,
60 entire debug logs, <<<build.xml>>>s or most preferably little demo projects attached to the issue are very much appreciated.
61 Of course, patches are welcome, too. Contributors can check out the project from our
62 {{{./source-repository.html}source repository}} and will find supplementary information in the
63 {{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.
64
65 * Examples
66
67 To provide you with better understanding of some usages of Animal Sniffer ANT Tasks,
68 you can take a look into the following examples:
69
70 * {{{./examples/generating-signatures.html}Generating signatures}}
71
72 * {{{./examples/checking-signatures.html}Checking signatures}}
73
74 * {{{./examples/sample-project.html}A sample project}}
75
76 []