Author: rdonkin
Date: Sat Dec 7 11:26:56 2013
New Revision: 1548882
URL: http://svn.apache.org/r1548882
Log:
Add java doc.
Modified:
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/document/IDocumentAnalyser.java
Modified:
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/document/IDocumentAnalyser.java
URL:
http://svn.apache.org/viewvc/creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/document/IDocumentAnalyser.java?rev=1548882&r1=1548881&r2=1548882&view=diff
==============================================================================
---
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/document/IDocumentAnalyser.java
(original)
+++
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/document/IDocumentAnalyser.java
Sat Dec 7 11:26:56 2013
@@ -18,10 +18,22 @@
*/
package org.apache.rat.document;
-import org.apache.rat.api.Document;
import java.io.IOException;
+import org.apache.rat.api.Document;
+
+/**
+ * The Interface IDocumentAnalyser.
+ */
public interface IDocumentAnalyser {
+ /**
+ * Analyse.
+ *
+ * @param document
+ * the document
+ * @throws IOException
+ * Signals that an I/O exception has occurred.
+ */
public void analyse(Document document) throws IOException;
}
