Author: sgoeschl
Date: Thu Oct 15 21:56:01 2009
New Revision: 825675
URL: http://svn.apache.org/viewvc?rev=825675&view=rev
Log:
Cleaned up javadocs
Modified:
turbine/fulcrum/trunk/xslt/src/java/org/apache/fulcrum/xslt/XSLTService.java
turbine/fulcrum/trunk/xslt/src/java/org/apache/fulcrum/xslt/XSLTServiceFacade.java
turbine/fulcrum/trunk/xslt/src/test/org/apache/fulcrum/xslt/XSLTServiceTest.java
Modified:
turbine/fulcrum/trunk/xslt/src/java/org/apache/fulcrum/xslt/XSLTService.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/xslt/src/java/org/apache/fulcrum/xslt/XSLTService.java?rev=825675&r1=825674&r2=825675&view=diff
==============================================================================
---
turbine/fulcrum/trunk/xslt/src/java/org/apache/fulcrum/xslt/XSLTService.java
(original)
+++
turbine/fulcrum/trunk/xslt/src/java/org/apache/fulcrum/xslt/XSLTService.java
Thu Oct 15 21:56:01 2009
@@ -45,6 +45,7 @@
* @param xslName The name of the file that contains the xsl stylesheet.
* @param in The reader that passes the xml to be transformed
* @param out The writer for the transformed output
+ * @throws Exception the transformation failed
*/
void transform (String xslName, Reader in, Writer out) throws Exception;
@@ -54,6 +55,8 @@
*
* @param xslName The name of the file that contains the xsl stylesheet.
* @param in The reader that passes the xml to be transformed
+ * @return the transformed output
+ * @throws Exception the transformation failed
*/
String transform (String xslName, Reader in) throws Exception;
@@ -64,6 +67,7 @@
* @param xslName The name of the file that contains the xsl stylesheet.
* @param in The DOM Node to be transformed
* @param out The writer for the transformed output
+ * @throws Exception the transformation failed
*/
void transform (String xslName, Node in, Writer out) throws Exception;
@@ -72,7 +76,9 @@
* string containing the transformed output.
*
* @param xslName The name of the file that contains the xsl stylesheet.
- * @param out The writer for the transformed output
+ * @param in The DOM Node to be transformed
+ * @return the transformed output
+ * @throws Exception the transformation failed
*/
String transform (String xslName, Node in) throws Exception;
@@ -84,6 +90,7 @@
* @param in The reader that passes the xml to be transformed
* @param out The writer for the transformed output
* @param params A set of parameters that will be forwarded to the XSLT
+ * @throws Exception the transformation failed
*/
void transform(String xslName, Reader in, Writer out, Map params) throws
Exception;
@@ -94,6 +101,8 @@
* @param xslName The name of the file that contains the xsl stylesheet.
* @param in The reader that passes the xml to be transformed
* @param params A set of parameters that will be forwarded to the XSLT
+ * @return the transformed output
+ * @throws Exception the transformation failed
*/
String transform(String xslName, Reader in, Map params) throws Exception;
@@ -105,6 +114,7 @@
* @param in The DOM Node to be transformed
* @param out The writer for the transformed output
* @param params A set of parameters that will be forwarded to the XSLT
+ * @throws Exception the transformation failed
*/
void transform(String xslName, Node in, Writer out, Map params) throws
Exception;
@@ -115,6 +125,8 @@
* @param xslName The name of the file that contains the xsl stylesheet.
* @param in The DOM Node to be transformed
* @param params A set of parameters that will be forwarded to the XSLT
+ * @return the transformed output
+ * @throws Exception the transformation failed
*/
String transform(String xslName, Node in, Map params) throws Exception;
}
Modified:
turbine/fulcrum/trunk/xslt/src/java/org/apache/fulcrum/xslt/XSLTServiceFacade.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/xslt/src/java/org/apache/fulcrum/xslt/XSLTServiceFacade.java?rev=825675&r1=825674&r2=825675&view=diff
==============================================================================
---
turbine/fulcrum/trunk/xslt/src/java/org/apache/fulcrum/xslt/XSLTServiceFacade.java
(original)
+++
turbine/fulcrum/trunk/xslt/src/java/org/apache/fulcrum/xslt/XSLTServiceFacade.java
Thu Oct 15 21:56:01 2009
@@ -65,6 +65,7 @@
* @param xslName The name of the file that contains the xsl stylesheet.
* @param in The reader that passes the xml to be transformed
* @param out The writer for the transformed output
+ * @throws Exception the transformation failed
*/
public static void transform(String xslName, Reader in, Writer out)
throws Exception
@@ -78,6 +79,8 @@
*
* @param xslName The name of the file that contains the xsl stylesheet.
* @param in The reader that passes the xml to be transformed
+ * @return the transformed output
+ * @throws Exception the transformation failed
*/
public static String transform(String xslName, Reader in) throws Exception
{
@@ -91,6 +94,7 @@
* @param xslName The name of the file that contains the xsl stylesheet.
* @param in The DOM Node to be transformed
* @param out The writer for the transformed output
+ * @throws Exception the transformation failed
*/
public void transform(String xslName, Node in, Writer out) throws Exception
{
@@ -103,6 +107,8 @@
*
* @param xslName The name of the file that contains the xsl stylesheet.
* @param in The DOM Node to be transformed
+ * @return the transformed output
+ * @throws Exception the transformation failed
*/
public String transform(String xslName, Node in) throws Exception
{
@@ -117,6 +123,7 @@
* @param in The reader that passes the xml to be transformed
* @param out The writer for the transformed output
* @param params A set of parameters that will be forwarded to the XSLT
+ * @throws Exception the transformation failed
*/
void transform(String xslName, Reader in, Writer out, Map params) throws
Exception
{
@@ -130,6 +137,8 @@
* @param xslName The name of the file that contains the xsl stylesheet.
* @param in The reader that passes the xml to be transformed
* @param params A set of parameters that will be forwarded to the XSLT
+ * @return the transformed output
+ * @throws Exception the transformation failed
*/
String transform(String xslName, Reader in, Map params) throws Exception
{
@@ -144,6 +153,7 @@
* @param in The DOM Node to be transformed
* @param out The writer for the transformed output
* @param params A set of parameters that will be forwarded to the XSLT
+ * @throws Exception the transformation failed
*/
void transform(String xslName, Node in, Writer out, Map params) throws
Exception
{
@@ -157,6 +167,8 @@
* @param xslName The name of the file that contains the xsl stylesheet.
* @param in The DOM Node to be transformed
* @param params A set of parameters that will be forwarded to the XSLT
+ * @return the transformed output
+ * @throws Exception the transformation failed
*/
String transform(String xslName, Node in, Map params) throws Exception
{
Modified:
turbine/fulcrum/trunk/xslt/src/test/org/apache/fulcrum/xslt/XSLTServiceTest.java
URL:
http://svn.apache.org/viewvc/turbine/fulcrum/trunk/xslt/src/test/org/apache/fulcrum/xslt/XSLTServiceTest.java?rev=825675&r1=825674&r2=825675&view=diff
==============================================================================
---
turbine/fulcrum/trunk/xslt/src/test/org/apache/fulcrum/xslt/XSLTServiceTest.java
(original)
+++
turbine/fulcrum/trunk/xslt/src/test/org/apache/fulcrum/xslt/XSLTServiceTest.java
Thu Oct 15 21:56:01 2009
@@ -39,8 +39,6 @@
{
private XSLTService xsltService = null;
-
-
/**
* Defines the testcase name for JUnit.
*
@@ -66,13 +64,19 @@
}
/**
* Simple test that verify an object can be created and deleted.
- * @throws Exception
+ * @throws Exception the test failed
*/
public void testPath() throws Exception
{
assertNotNull(xsltService);
}
+ /**
+ * Test an indentity transformation to make sure that the service
+ * works.
+ *
+ * @throws Exception the test failed
+ */
public void testTransform() throws Exception
{
Reader reader = new FileReader("./pom.xml");
@@ -81,5 +85,4 @@
reader.close();
writer.close();
}
-
}
