[Dive4elements-commits] [PATCH 3 of 4] Doc

[Wald Commits]

# HG changeset patch
# User Felix Wolfsteller <felix.wolfsteller at intevation.de>
# Date 1355478102 -3600
# Node ID 23392c25fc119a487e4beeda8cb271ca612d4b76
# Parent  83838f87e98fe1ced5eac9b23ded9a4d6c37860b
Doc.

diff -r 83838f87e98f -r 23392c25fc11 flys-backend/src/main/java/de/intevation/flys/importer/parsers/LineParser.java
--- a/flys-backend/src/main/java/de/intevation/flys/importer/parsers/LineParser.java	Fri Dec 14 10:41:24 2012 +0100
+++ b/flys-backend/src/main/java/de/intevation/flys/importer/parsers/LineParser.java	Fri Dec 14 10:41:42 2012 +0100
@@ -18,8 +18,14 @@
 import org.apache.log4j.Logger;
 
 
+/**
+ * Base-Class for prasers for line-based file formats.
+ * Calls reset(), then read line by line, calling handleLine() for each,
+ * then calls finish().
+ */
 public abstract class LineParser {
 
+    /** Private logger. */
     private static final Logger log = Logger.getLogger(LineParser.class);
 
     public static final String ENCODING = "ISO-8859-1";
@@ -39,7 +45,7 @@
 
     /**
      * This method reads each line of <i>file</i>. At the beginning,
-     * <i>reset()</i> is called; afterwars for each line <i>handleLine()</i> is
+     * <i>reset()</i> is called; afterwards for each line <i>handleLine()</i> is
      * called; at the end <i>finish</i> is called.
      *
      * @param file The file which should be parsed.