[DL-Learner SVN] SF.net SVN: dl-learner:[4098] trunk/components-core/src/main/java/org/ dllearner/algorithms/isle/index

[<dfl...@us...>]

Revision: 4098
          http://sourceforge.net/p/dl-learner/code/4098
Author:   dfleischhacker
Date:     2013-09-09 10:11:41 +0000 (Mon, 09 Sep 2013)
Log Message:
-----------
Improve some documentation

Modified Paths:
--------------
    trunk/components-core/src/main/java/org/dllearner/algorithms/isle/index/Annotation.java
    trunk/components-core/src/main/java/org/dllearner/algorithms/isle/index/LinguisticAnnotator.java

Modified: trunk/components-core/src/main/java/org/dllearner/algorithms/isle/index/Annotation.java
===================================================================
--- trunk/components-core/src/main/java/org/dllearner/algorithms/isle/index/Annotation.java	2013-09-09 10:10:55 UTC (rev 4097)
+++ trunk/components-core/src/main/java/org/dllearner/algorithms/isle/index/Annotation.java	2013-09-09 10:11:41 UTC (rev 4098)
@@ -5,6 +5,7 @@
 
 
 /**
+ * A (non-semantic) annotation which represents an entity in a document by its offset and length.
  * @author Lorenz Buehmann
  *
  */

Modified: trunk/components-core/src/main/java/org/dllearner/algorithms/isle/index/LinguisticAnnotator.java
===================================================================
--- trunk/components-core/src/main/java/org/dllearner/algorithms/isle/index/LinguisticAnnotator.java	2013-09-09 10:10:55 UTC (rev 4097)
+++ trunk/components-core/src/main/java/org/dllearner/algorithms/isle/index/LinguisticAnnotator.java	2013-09-09 10:11:41 UTC (rev 4098)
@@ -6,11 +6,15 @@
 import java.util.Set;
 
 /**
+ * Interface for generating (non-semantic) annotations for documents.
  * @author Lorenz Buehmann
- *
  */
 public interface LinguisticAnnotator {
-	
+    /**
+     * Returns the set of annotation for the given document.
+     * @param document the document to get annotation for
+     * @return set of annotations for the given document
+     */
 	Set<Annotation> annotate(Document document);
 
 }

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.