AvatarFromSysMLError commented

src/main/java/avatartranslator/tosysmlv2/AvatarFromSysMLError.java

@@ -42,19 +42,27 @@ import java_cup.runtime.ComplexSymbolFactory.Location;
  * Class AvatarFromSysMLError
  * Creation: 20/06/2024
  *
+ * Errors that are reported when parsing an Avatar SysML model and building the corresponding Avatar Model.
+ * These errors are (potentially) provided with two locations. Idea: the location where the error occurs + a reference location for conflicting
+ * declarations, for example.
  * @author Sophie Coudert
  * @version 0.1 20/06/2024
  */
 public class AvatarFromSysMLError {
-    public static final byte LOWWARNING = 0;
+    public static final byte LOWWARNING = 0; // TODO: probably simplify in 3 levels ERROR, WARNING, BUG
     public static final byte HIGHWARNING = 1;
-     public static final byte LOWERROR = 2;
+    public static final byte LOWERROR = 2;
     public static final byte HIGHERROR = 3;
     public static final byte BUGERROR = 4;
-   private Location location;
+    /** location (sometime approximative) where the error has been detected */
+    private Location location;
+    /** reference location concerned by the error, in case of conflict for example */
     private Location reference;
+    /** message describing the error */
     private String message;
+    /** seriousness of the error */
     private byte level;
+    
     public AvatarFromSysMLError(Byte lv, Location loc, String msg, Location ref){
         location = loc;
         reference = ref;