svn commit: r654900 - in /maven/plugin-tools/trunk/maven-plugin-tools-api/src: main/java/org/apache/maven/tools/plugin/util/PluginUtils.java test/java/org/apache/maven/tools/plugin/util/PluginUtilsTest.java

[bentmann]

Author: bentmann
Date: Fri May  9 11:03:38 2008
New Revision: 654900

URL: http://svn.apache.org/viewvc?rev=654900&view=rev
Log:
o Clarified that makeHtmlValid() outputs XHTML

Modified:
    
maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/util/PluginUtils.java
    
maven/plugin-tools/trunk/maven-plugin-tools-api/src/test/java/org/apache/maven/tools/plugin/util/PluginUtilsTest.java

Modified: 
maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/util/PluginUtils.java
URL: 
http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/util/PluginUtils.java?rev=654900&r1=654899&r2=654900&view=diff
==============================================================================
--- 
maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/util/PluginUtils.java
 (original)
+++ 
maven/plugin-tools/trunk/maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/util/PluginUtils.java
 Fri May  9 11:03:38 2008
@@ -233,8 +233,10 @@
     }
 
     /**
-     * @param description Javadoc description with HTML tags
-     * @return the description with valid HTML tags
+     * Fixes some javadoc comment to become a valid XHTML snippet.
+     * 
+     * @param description Javadoc description with HTML tags, may be 
<code>null</code>.
+     * @return The description with valid XHTML tags, never <code>null</code>.
      */
     public static String makeHtmlValid( String description )
     {

Modified: 
maven/plugin-tools/trunk/maven-plugin-tools-api/src/test/java/org/apache/maven/tools/plugin/util/PluginUtilsTest.java
URL: 
http://svn.apache.org/viewvc/maven/plugin-tools/trunk/maven-plugin-tools-api/src/test/java/org/apache/maven/tools/plugin/util/PluginUtilsTest.java?rev=654900&r1=654899&r2=654900&view=diff
==============================================================================
--- 
maven/plugin-tools/trunk/maven-plugin-tools-api/src/test/java/org/apache/maven/tools/plugin/util/PluginUtilsTest.java
 (original)
+++ 
maven/plugin-tools/trunk/maven-plugin-tools-api/src/test/java/org/apache/maven/tools/plugin/util/PluginUtilsTest.java
 Fri May  9 11:03:38 2008
@@ -132,6 +132,10 @@
         javadoc = "Generates <i>something</i> <b> for the project.";
         assertEquals( "Generates <i>something</i> <b> for the project.</b>", 
PluginUtils.makeHtmlValid( javadoc ) );
 
+        // wrong XHTML
+        javadoc = "Line1<br>Line2";
+        assertEquals( "Line1<br/>Line2", PluginUtils.makeHtmlValid( javadoc 
).replaceAll( "\\s", "" ) );
+
         // special characters
         javadoc = "& &amp; < > \u00A0";
         assertEquals( "&amp; &amp; &lt; &gt; \u00A0", 
PluginUtils.makeHtmlValid( javadoc ) );