Stephen Connolly wrote:
Folks, I've been working on the versions-maven-plugin and I think it's
ready to cut the first alpha release.
0, not using it. Side notes:
The plugin's POM declare compiler source/target to be 1.4 but actually
requires Java 1.5 to compile/run.
The project license URL should be
http://www.apache.org/licenses/LICENSE-2.0.txt
i.e. with the ".txt" extension added such that the "Project License"
report doesn't end up including the entire Apache HTML page.
The Javadoc generation points out the following bad tags:
- @requires-project, should be @requiresProject
- @description, is superfluos since class javadoc is goal description
- @dontrequiresDependencyResolution ???
Compare the Mojo API Spec [0].
I believe the fields
- remoteRepositories
- localRepository
from AbstractVersionsUpdaterMojo should be annotated with @readonly to
hide them from the public goal documentation.
The configuration
<configuration>
<goalPrefix>versions</goalPrefix>
</configuration>
seems unnecessary, "versions" is already the default prefix for the plugin.
mvn dependency:analyze reports some inconsistencies.
You already have some nice docs, consider to also add an improved
index.apt, as suggested in the plugin documentation standard [1].
The file "examples\display-plugin-updates.apt" contains a POM snippet
with a very long (and ill-wrapped) line for the <project> element. I
don't know if one can get the scrolling source box in APT, too, so I
just suggest you simply remove all the namespace attributes from the
example.
The "usage.apt" says "invokation", it's "invocation", isn't it?
Also, the "usage.apt" uses several times the word "here" for hyperlinks.
That's not the best way of presenting links [2].
Benjamin
[0] http://maven.apache.org/developers/mojo-api-specification.html
[1]
http://maven.apache.org/guides/development/guide-plugin-documentation.html
[2] http://www.w3.org/QA/Tips/noClickHere
---------------------------------------------------------------------
To unsubscribe from this list, please visit:
http://xircles.codehaus.org/manage_email
