Added missing javadoc

Author: “jklein94”

org-tweetyproject-arg-eaf/src/main/java/org/tweetyproject/arg/eaf/examples/EafTheoryGeneratorExample.java

@@ -30,13 +30,13 @@
 import org.tweetyproject.arg.eaf.writer.EafApxWriter;
 
 /**
- * Demonstrates the generation and export of {@link EpistemicArgumentationFramework}s (EAFs)
+ * Demonstrates the generation and export of EAFs
  * using various generation strategies.
  *
  * <p>The generated EAFs are written to `.apx` files using {@link EafApxWriter}.
  * Three approaches are shown:
  * <ul>
- *   <li>Random EAF generation using {@link DefaultDungTheoryGenerator}</li>
+ *   <li>Random EAF generation</li>
  *   <li>Controlled generation with specific structural and semantic properties using {@link KwtDungTheoryGenerator}</li>
  *   <li>Generation based on a custom, user-defined {@link DungTheory}</li>
  * </ul>
@@ -54,7 +54,7 @@ public EafTheoryGeneratorExample() {
      *
      * <p>Three types of EAF datasets are created:
      * <ul>
-     *   <li>20 randomly generated EAFs using {@link DefaultDungTheoryGenerator}</li>
+     *   <li>20 randomly generated EAFs
      *   <li>20 structured EAFs generated using {@link KwtDungTheoryGenerator}, with controlled semantic properties</li>
      *   <li>20 EAFs derived from a manually constructed {@link DungTheory}</li>
      * </ul>

org-tweetyproject-arg-eaf/src/main/java/org/tweetyproject/arg/eaf/reasoner/SimpleEAFAdmissibleReasoner.java

@@ -31,15 +31,15 @@
  * This reasoner for epistemic Dung theories performs inference on the admissible extension.
  * Extensions are determined by checking for all admissible sets which set combinations satisfy the epistemic constraint.
  * Note that this reasoner does not compute epistemic extension sets.
- * 
+ *
  * @author Sandra Hoffmann
  *
  */
 public class SimpleEAFAdmissibleReasoner extends AbstractEAFReasoner{
 
 	/**
 	 * Computes all admissible extensions that satisfy the epistemic constraint of the EAF.
-	 * 
+	 *
 	 * @param bbase the epistemic argumentation framework
 	 * @return A collection of all admissible extensions that satisfy the constraint.
 	 */
@@ -49,12 +49,12 @@ public Collection<Extension<EpistemicArgumentationFramework>> getModels(Epistemi
 
 	/**
 	 * Computes one admissible extension that satisfies the epistemic constraint of the EAF.
-	 * 
+	 *
 	 * @param bbase the constrained argumentation framework
 	 * @return An admissible extension that satisfies the constraint.
 	 */
 	public Extension<EpistemicArgumentationFramework> getModel(EpistemicArgumentationFramework bbase) {
 		return super.getModel(bbase, Semantics.ADM);
 	}
-	
+
 }

org-tweetyproject-arg-eaf/src/main/java/org/tweetyproject/arg/eaf/writer/AbstractEafWriter.java

@@ -26,39 +26,56 @@
 import org.tweetyproject.arg.eaf.syntax.EpistemicArgumentationFramework;
 
 /**
- * @author Sandra Hoffmann
+ * Abstract base class for writing EpistemicArgumentationFramework (EAF) instances
+ * to different file formats.
+ *
+ * Subclasses must implement the write method for specific formats.
+ * This class also provides a static factory method to retrieve a suitable writer
+ * for a given file format.
+ *
+ * Supported formats include:
+ *
+ *  - TGF - Trivial Graph Format
+ *  - APX - Argumentation Interchange Format (used by ASPARTIX)
+ *  - CNF - Conjunctive Normal Form (logic-based encoding)
+ *
+ *
+ *
+ * Author: Sandra Hoffmann
  */
 public abstract class AbstractEafWriter {
-	
-	/**
-	 * standard constructor
-	 */
-	public AbstractEafWriter() {
-		super();
-	}
-	
-	
-	/**
-	 * Retrieves the writer for the given file format.
-	 * @param f some file format
-	 * @return a writer or null if the format is not supported.
-	 */
-	public static AbstractEafWriter getWriter(FileFormat f){
-		if(f.equals(FileFormat.TGF))
-			return new EafTgfWriter();
-		if(f.equals(FileFormat.APX))
-			return new EafApxWriter();
-		if(f.equals(FileFormat.CNF))
-			return new EafCnfWriter();
-		return null;
-	}
-	
-	/**
-	 * Writes the given eaf into a file
-	 * @param eaf an abstract argumentation framework
-	 * @param f the file that will be overwritten. 
-	 * @throws IOException for all errors concerning file reading/writing.
-	 */
-	public abstract void write(EpistemicArgumentationFramework eaf, File f) throws IOException;
 
+    /**
+     * Standard constructor.
+     */
+    public AbstractEafWriter() {
+        super();
+    }
+
+    /**
+     * Returns an AbstractEafWriter instance for the specified file format.
+     *
+     * @param f the desired file format
+     * @return a writer for the format, or null if the format is not supported
+     */
+    public static AbstractEafWriter getWriter(FileFormat f) {
+        if (f.equals(FileFormat.TGF))
+            return new EafTgfWriter();
+        if (f.equals(FileFormat.APX))
+            return new EafApxWriter();
+        if (f.equals(FileFormat.CNF))
+            return new EafCnfWriter();
+        return null;
+    }
+
+    /**
+     * Writes the given epistemic argumentation framework to the specified file.
+     * If the file already exists, it will be overwritten.
+     *
+     * @param eaf the epistemic argumentation framework to be written
+     * @param f the file to write to
+     * @throws IOException if an error occurs during file writing
+     */
+    public abstract void write(EpistemicArgumentationFramework eaf, File f) throws IOException;
 }
+