Author: rdonkin
Date: Mon Dec 9 06:02:25 2013
New Revision: 1549442
URL: http://svn.apache.org/r1549442
Log:
Add Java Doc.
Modified:
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/api/Document.java
Modified:
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/api/Document.java
URL:
http://svn.apache.org/viewvc/creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/api/Document.java?rev=1549442&r1=1549441&r2=1549442&view=diff
==============================================================================
---
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/api/Document.java
(original)
+++
creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/api/Document.java
Mon Dec 9 06:02:25 2013
@@ -23,13 +23,14 @@ import java.io.InputStream;
import java.io.Reader;
/**
- *
+ * The Interface Document.
*/
public interface Document {
/**
+ * Gets the name.
*
- * @return
+ * @return the name
*/
String getName();
@@ -59,7 +60,7 @@ public interface Document {
MetaData getMetaData();
/**
- * Is this a composite document?
+ * Is this a composite document?.
*
* @return true if composite, false otherwise
*/
