Author: rdonkin
Date: Sun Dec 8 21:30:36 2013
New Revision: 1549299
URL: http://svn.apache.org/r1549299
Log:
Add java doc.
Modified:
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/report/IReportable.java
Modified:
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/report/IReportable.java
URL:
http://svn.apache.org/viewvc/creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/report/IReportable.java?rev=1549299&r1=1549298&r2=1549299&view=diff
==============================================================================
---
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/report/IReportable.java
(original)
+++
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/report/IReportable.java
Sun Dec 8 21:30:36 2013
@@ -20,7 +20,18 @@ package org.apache.rat.report;
import org.apache.rat.api.RatException;
+/**
+ * The Interface IReportable.
+ */
public interface IReportable {
+ /**
+ * Run.
+ *
+ * @param report
+ * the report
+ * @throws RatException
+ * the rat exception
+ */
public void run(RatReport report) throws RatException;
}
