update javadoc for GenericOkapiFilterAdapter

zanata · Jun 5, 2013 · baa1042 · baa1042
1 parent c6d7236
commit baa1042
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/zanata-war/src/main/java/org/zanata/adapter/GenericOkapiFilterAdapter.java b/zanata-war/src/main/java/org/zanata/adapter/GenericOkapiFilterAdapter.java
@@ -90,7 +90,8 @@ public enum IdSource {
     * 
     * @param filter {@link IFilter} used to parse the document
     * @param idSource determines how ids are assigned to TextFlows. The chosen
-    *                 source should never produce duplicate ids.
+    *                 source should only produce duplicate ids when source
+    *                 content is identical.
     */
    public GenericOkapiFilterAdapter(IFilter filter, IdSource idSource)
    {
@@ -101,7 +102,12 @@ public GenericOkapiFilterAdapter(IFilter filter, IdSource idSource)
     * Create an adapter that will use the specified {@link IdSource} as TextFlow id.
     * 
     * @param filter {@link IFilter} used to parse the document
-    * @param idSource determines how ids are assigned to TextFlows
+    * @param idSource determines how ids are assigned to TextFlows The chosen
+    *                 source should only produce duplicate ids when source
+    *                 content is identical.
+    * @param requireFileOutput true if filter requires a file on disk rather than
+    *                          just a stream. Causes a temp file to be created
+    *                          when parsing.
     */
    public GenericOkapiFilterAdapter(IFilter filter, IdSource idSource, boolean requireFileOutput)
    {