Documentation Improvements
--------------------------
Key: MANIMALSNIFFER-21
URL: https://jira.codehaus.org/browse/MANIMALSNIFFER-21
Project: Mojo Animal Sniffer
Issue Type: Improvement
Components: Maven Plugin
Affects Versions: 1.7
Environment: n/a
Reporter: Eric Kolotyluk
Assignee: Stephen Connolly
Priority: Minor
I had a seriously difficult time trying to understand
http://mojo.codehaus.org/animal-sniffer-maven-plugin/index.html and I suggest
you add the follow text after
The Animal Sniffer Plugin is used to build signatures of APIs and to check your
classes against previously generated signatures. This plugin is called animal
sniffer because the principal signatures that are used are those of the Java
Runtime, and since Sun traditionally names the different versions of its Java
Runtimes after different animals, the plugin that detects what Java Runtime
your code requires was called "Animal Sniffer".
The intent of animal sniffer is to allow you to use <source>1.5</source>
<target>1.5</target> with a 1.6 JDK and not accidentally link to methods like
java.lang.String#isEmpty(). Setting the source to 1.5 will only flush out the
class format; the signatures of methods used can only be enforced by the
sniffer. For example, when you are on a Macintosh you cannot compile with JDK
1.5 so you might use http://mojo.codehaus.org/signatures/java15/ (note: be sure
to use the latest version of the plug-in by checking http://search.maven.org/
for animal-sniffer-maven-plugin). See also
http://mojo.codehaus.org/animal-sniffer/animal-sniffer/index.html for related
information.
--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe from this list, please visit:
http://xircles.codehaus.org/manage_email
