creadur-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rdon...@apache.org
Subject svn commit: r1548877 - /creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/report/RatReport.java
Date Sat, 07 Dec 2013 11:22:24 GMT
Author: rdonkin
Date: Sat Dec  7 11:22:24 2013
New Revision: 1548877

URL: http://svn.apache.org/r1548877
Log:
Add java doc.

Modified:
    creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/report/RatReport.java

Modified: creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/report/RatReport.java
URL: http://svn.apache.org/viewvc/creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/report/RatReport.java?rev=1548877&r1=1548876&r2=1548877&view=diff
==============================================================================
--- creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/report/RatReport.java
(original)
+++ creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/report/RatReport.java
Sat Dec  7 11:22:24 2013
@@ -21,11 +21,34 @@ package org.apache.rat.report;
 import org.apache.rat.api.Document;
 import org.apache.rat.api.RatException;
 
+/**
+ * The Interface RatReport.
+ */
 public interface RatReport {
 
+	/**
+	 * Start report.
+	 * 
+	 * @throws RatException
+	 *             the rat exception
+	 */
 	public void startReport() throws RatException;
 
+	/**
+	 * Report.
+	 * 
+	 * @param document
+	 *            the document
+	 * @throws RatException
+	 *             the rat exception
+	 */
 	public void report(Document document) throws RatException;
 
+	/**
+	 * End report.
+	 * 
+	 * @throws RatException
+	 *             the rat exception
+	 */
 	public void endReport() throws RatException;
 }



Mime
View raw message