I have observed that some of the plugins are missing a description of
properties which they are sensitive to.
This is sometimes very painful.
If there is already a way (or will be soon) to automate generation of
documentation for goals:
plugin.jelly -> goals.xml -> goals.html
Why not to have automated way for documenting properties:
properties.xml -> plugin.properties
-> xdocs/properties.xml -> properties.html
The missing element of the puzzle which is not existing for the moment is
properties.xml file
The content of that file may look like follows:
<properties>
<!--this lets to divide properties into logical groups - see e.g
http://jakarta.apache.org/turbine/maven/reference/plugins/java/properties.ht
ml ->
<group>
<name>compile</name>
<title>Compile Settings</title>
<group>
<group>
<name>Jar Settings</name>
<title>jar</title>
<group>
<group>
<name>Deploy Settings</name>
<title>deploy</title>
<group>
<group>
<name>other</name> <!--it think that group should be predefined, or
there must me some other way (see #1 below) ->
<title>Other Settings</title>
<group>
<property>
<name>maven.xxx.yyy</name>
<default>123</default>
<description>
khkjhkjHKJhkjhjkhkjhkj
dfssssssssssssssssfdds
fdssssssssssssssss
</description>
<optional>true</optional>
<group>compile<group> <!-- propertes can be gruped - this qualifies
this property to a given group defined above - >
</property>
<property>
...
</property>
<property>
<name>maven.vvv.ssss</name>
<default>true</default>
<description>
Here is a description as now is in xdocs/properties.xml
</description>
<optional>false</optional>
<group>other</group>
</property>
<properties>
Ad #1
Often properties may be also used in other plugins or taken from POM.
In this case they should not be written to "plugin.properties" file even if
they are required
The group called "others" can be used to denote this situation. I guess that
smarter solutin can be found.
I think that this should be fairly simple to implement.
Michal
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
