Some javadoc added

[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / phpparser / SyntaxError.java

diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/phpparser/SyntaxError.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/phpparser/SyntaxError.java
index 5da81e8..7c174da 100644 (file)
--- a/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/phpparser/SyntaxError.java
+++ b/net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/phpparser/SyntaxError.java
@@ -19,19 +19,25 @@
 package net.sourceforge.phpeclipse.phpeditor.phpparser;
 
 /**
- * Exception for a syntax error detected by the HartMath parser
- * 
+ * Exception for a syntax error detected by the HartMath parser.
  */
 public class SyntaxError extends Error {
 
+  /** The line where the error start */
   int lineNumber;
+  /** The column where the error start */
   int columnNumber;
+  /** the current line. */
   String currentLine;
+  /** The error message. */
   String error;
+
   /**
    * SyntaxError exception
-   * 
-   *
+   * @param lineNumber the line number where the error start
+   * @param columnNumber the column where the error start
+   * @param currentLine the line where the error end
+   * @param error the error message
    * @see
    */
   public SyntaxError(int lineNumber, int columnNumber, String currentLine, String error) {
@@ -41,6 +47,10 @@ public class SyntaxError extends Error {
     this.error = error;
   }
 
+  /**
+   * Get the error message.
+   * @return the error message
+   */
   public String getMessage() {
     //    StringBuffer buf = new StringBuffer(256);
     //    buf.append("Syntax error in line:");
@@ -59,6 +69,10 @@ public class SyntaxError extends Error {
     return error;
   }
 
+  /**
+   * Get the line number where the error happens
+   * @return the line number
+   */
   public int getLine() {
     return lineNumber;
   }