You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2009/08/16 13:48:30 UTC
svn commit: r804672 -
/maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
Author: vsiveton
Date: Sun Aug 16 11:48:30 2009
New Revision: 804672
URL: http://svn.apache.org/viewvc?rev=804672&view=rev
Log:
MPLUGIN-157: Review the Doxia Sink calls
o added Doxia schema
o fix empty attributes
Modified:
maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
Modified: maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java
URL: http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java?rev=804672&r1=804671&r2=804672&view=diff
==============================================================================
--- maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java (original)
+++ maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginXdocGenerator.java Sun Aug 16 11:48:30 2009
@@ -101,7 +101,7 @@
{
execute( destinationDirectory, new DefaultPluginToolsRequest( project, pluginDescriptor ) );
}
-
+
/** {@inheritDoc} */
public void execute( File destinationDirectory, PluginToolsRequest request )
throws IOException
@@ -160,6 +160,9 @@
private void writeBody( MojoDescriptor mojoDescriptor, XMLWriter w )
{
w.startElement( "document" );
+ w.addAttribute( "xmlns", "http://maven.apache.org/XDOC/2.0" );
+ w.addAttribute( "xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance" );
+ w.addAttribute( "xsi:schemaLocation", "http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd" );
// ----------------------------------------------------------------------
//
@@ -254,12 +257,15 @@
w.writeMarkup( getString( "pluginxdoc.mojodescriptor.attributes" ) );
w.endElement(); //p
- w.startElement( "ul" );
-
+ boolean addedUl = false;
String value;
-
if ( mojoDescriptor.isProjectRequired() )
{
+ if ( !addedUl )
+ {
+ w.startElement( "ul" );
+ addedUl = true;
+ }
w.startElement( "li" );
w.writeMarkup( getString( "pluginxdoc.mojodescriptor.projectRequired" ) );
w.endElement(); //li
@@ -267,6 +273,11 @@
if ( mojoDescriptor.isAggregator() )
{
+ if ( !addedUl )
+ {
+ w.startElement( "ul" );
+ addedUl = true;
+ }
w.startElement( "li" );
w.writeMarkup( getString( "pluginxdoc.mojodescriptor.aggregator" ) );
w.endElement(); //li
@@ -274,6 +285,11 @@
if ( mojoDescriptor.isDirectInvocationOnly() )
{
+ if ( !addedUl )
+ {
+ w.startElement( "ul" );
+ addedUl = true;
+ }
w.startElement( "li" );
w.writeMarkup( getString( "pluginxdoc.mojodescriptor.directInvocationOnly" ) );
w.endElement(); //li
@@ -282,6 +298,11 @@
value = mojoDescriptor.isDependencyResolutionRequired();
if ( StringUtils.isNotEmpty( value ) )
{
+ if ( !addedUl )
+ {
+ w.startElement( "ul" );
+ addedUl = true;
+ }
w.startElement( "li" );
w.writeMarkup( format( "pluginxdoc.mojodescriptor.dependencyResolutionRequired", value ) );
w.endElement(); //li
@@ -290,6 +311,11 @@
value = mojoDescriptor.getSince();
if ( StringUtils.isNotEmpty( value ) )
{
+ if ( !addedUl )
+ {
+ w.startElement( "ul" );
+ addedUl = true;
+ }
w.startElement( "li" );
w.writeMarkup( format( "pluginxdoc.mojodescriptor.since", value ) );
w.endElement(); //li
@@ -298,6 +324,11 @@
value = mojoDescriptor.getPhase();
if ( StringUtils.isNotEmpty( value ) )
{
+ if ( !addedUl )
+ {
+ w.startElement( "ul" );
+ addedUl = true;
+ }
w.startElement( "li" );
w.writeMarkup( format( "pluginxdoc.mojodescriptor.phase", value ) );
w.endElement(); //li
@@ -306,6 +337,11 @@
value = mojoDescriptor.getExecutePhase();
if ( StringUtils.isNotEmpty( value ) )
{
+ if ( !addedUl )
+ {
+ w.startElement( "ul" );
+ addedUl = true;
+ }
w.startElement( "li" );
w.writeMarkup( format( "pluginxdoc.mojodescriptor.executePhase", value ) );
w.endElement(); //li
@@ -314,6 +350,11 @@
value = mojoDescriptor.getExecuteGoal();
if ( StringUtils.isNotEmpty( value ) )
{
+ if ( !addedUl )
+ {
+ w.startElement( "ul" );
+ addedUl = true;
+ }
w.startElement( "li" );
w.writeMarkup( format( "pluginxdoc.mojodescriptor.executeGoal", value ) );
w.endElement(); //li
@@ -322,6 +363,11 @@
value = mojoDescriptor.getExecuteLifecycle();
if ( StringUtils.isNotEmpty( value ) )
{
+ if ( !addedUl )
+ {
+ w.startElement( "ul" );
+ addedUl = true;
+ }
w.startElement( "li" );
w.writeMarkup( format( "pluginxdoc.mojodescriptor.executeLifecycle", value ) );
w.endElement(); //li
@@ -329,6 +375,11 @@
if ( mojoDescriptor.isOnlineRequired() )
{
+ if ( !addedUl )
+ {
+ w.startElement( "ul" );
+ addedUl = true;
+ }
w.startElement( "li" );
w.writeMarkup( getString( "pluginxdoc.mojodescriptor.onlineRequired" ) );
w.endElement(); //li
@@ -336,12 +387,20 @@
if ( !mojoDescriptor.isInheritedByDefault() )
{
+ if ( !addedUl )
+ {
+ w.startElement( "ul" );
+ addedUl = true;
+ }
w.startElement( "li" );
w.writeMarkup( getString( "pluginxdoc.mojodescriptor.inheritedByDefault" ) );
w.endElement(); //li
}
- w.endElement(); //ul
+ if ( addedUl )
+ {
+ w.endElement(); //ul
+ }
}
/**
@@ -440,18 +499,32 @@
}
w.endElement(); // div
- w.startElement( "ul" );
-
+ boolean addedUl = false;
+ if ( !addedUl && StringUtils.isNotEmpty( parameter.getType() ) )
+ {
+ w.startElement( "ul" );
+ addedUl = true;
+ }
writeDetail( getString( "pluginxdoc.mojodescriptor.parameter.type" ), parameter.getType(), w );
if ( StringUtils.isNotEmpty( parameter.getSince() ) )
{
+ if ( !addedUl )
+ {
+ w.startElement( "ul" );
+ addedUl = true;
+ }
writeDetail( getString( "pluginxdoc.mojodescriptor.parameter.since" ), parameter.getSince(), w );
}
else
{
if ( StringUtils.isNotEmpty( mojoDescriptor.getSince() ) )
{
+ if ( !addedUl )
+ {
+ w.startElement( "ul" );
+ addedUl = true;
+ }
writeDetail( getString( "pluginxdoc.mojodescriptor.parameter.since" ),
mojoDescriptor.getSince(), w );
}
@@ -459,20 +532,43 @@
if ( parameter.isRequired() )
{
+ if ( !addedUl )
+ {
+ w.startElement( "ul" );
+ addedUl = true;
+ }
writeDetail( getString( "pluginxdoc.mojodescriptor.parameter.required" ),
getString( "pluginxdoc.yes" ), w );
}
else
{
+ if ( !addedUl )
+ {
+ w.startElement( "ul" );
+ addedUl = true;
+ }
writeDetail( getString( "pluginxdoc.mojodescriptor.parameter.required" ),
getString( "pluginxdoc.no" ), w );
}
+ if ( !addedUl && StringUtils.isNotEmpty( parameter.getExpression() ) )
+ {
+ w.startElement( "ul" );
+ addedUl = true;
+ }
writeDetail( getString( "pluginxdoc.mojodescriptor.parameter.expression" ), parameter.getExpression(), w );
+ if ( !addedUl && StringUtils.isNotEmpty( parameter.getDefaultValue() ) )
+ {
+ w.startElement( "ul" );
+ addedUl = true;
+ }
writeDetail( getString( "pluginxdoc.mojodescriptor.parameter.default" ), parameter.getDefaultValue(), w );
- w.endElement(); //ul
+ if ( addedUl )
+ {
+ w.endElement(); //ul
+ }
if ( parameters.hasNext() )
{