Tim Kettler wrote:
Dennis Lundberg schrieb:
[...]
Well, the plugin that had documentation preceeding the currently
released plugin was maven-dependency-plugin a way back. I was trying
to use the analysis goal, which the documentation showed but the
plugin didn't have. And also there were some <exclude*> parameters in
copy-dependencies that were in the online docs, but not in the
released plugin.
This has been a source of confusion and frustration for users before.
And I think it still is.
What we have done to improve the situation is to add support for
@since annotations for mojo classes and parameters. If these
annotations are added in the source code for a plugin, and they should
be, the generated documentation for goals and parameters shows this.
With this I think, you just try to medicate a symptom instead of healing
the root cause (to speak in medical terms).
Agreed. This was a soothing "pill" to ease the pain somewhat. It hasn't
cured the patient completely though. This pill has been used in other
places like the Ant documentation as well, which has been brought up as
something to look up to.
The root cause is imho that the current plugin documentation is not what
the useres expect it to be. When a user sees in the plugin index the
entry for the dependency plugin with the version stated as 2.0-alpha-4
and then clicks on the link to the plugins documentaion she expects to
read the documentation for *exactly* that version and not for some
unreleased features.
As Wendy said, there has been some work done on this, but it's not
finished yet.
The dependency-plugin has a good example of this, where the class
(goal) is available since 2.0-alpha-3 and a couple of parameters since
2.0-alpha-5:
http://maven.apache.org/plugins/maven-dependency-plugin/analyze-mojo.html
This is hopefully outdated information, and has been fixed a long time
back. However I avoid doing "mvn -U", since I'm still on 2.0.4 (see
above).
Thanks
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
--
Dennis Lundberg
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
