Debian Codegraph @

animal-sniffer-maven-plugin/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-10-27
30 ------
31
32 Animal Sniffer Maven Plugin
33
34 The Animal Sniffer Plugin is used to build signatures of APIs and to check your classes
35 against previously generated signatures. This plugin is called animal sniffer because the
36 principal signatures that are used are those of the Java Runtime, and since Sun
37 traditionally names the different versions of its Java Runtimes after different animals,
38 the plugin that detects what Java Runtime your code requires was called "Animal Sniffer".
39
40 * Goals Overview
41
42 The Animal Sniffer Plugin has the following goals.
43
44 * {{{./build-mojo.html}animal-sniffer:build}} creates a signature of an API.
45
46 * {{{./check-mojo.html}animal-sniffer:check}} checks a project against an API signature.
47
48 * Usage
49
50 General instructions on how to use the Animal Sniffer Plugin can be found on the {{{./usage.html}usage page}}. Some more
51 specific use cases are described in the examples given below. Last but not least, users occasionally contribute
52 additional examples, tips or errata to the
53 {{{http://docs.codehaus.org/display/MAVENUSER/Animal+Sniffer+Maven+Plugin}plugin's wiki page}}.
54
55 In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel
56 free to contact the {{{./mail-lists.html}user mailing list}}. The posts to the mailing list are archived and could
57 already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
58 the {{{./mail-lists.html}mail archive}}.
59
60 If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our
61 {{{./issue-tracking.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
62 concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason,
63 entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated.
64 Of course, patches are welcome, too. Contributors can check out the project from our
65 {{{./source-repository.html}source repository}} and will find supplementary information in the
66 {{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.
67
68 * Examples
69
70 To provide you with better understanding of some usages of Animal Sniffer,
71 you can take a look into the following examples:
72
73 * {{{./examples/generating-java-signatures.html}Generating signatures of the Java Runtime}}
74
75 * {{{./examples/generating-other-api-signatures.html}Generating signatures of other APIs}}
76
77 * {{{./examples/checking-signatures.html}Checking a project against API signatures}}
78
79 []