Fix documentation compilation issues

src/main/java/beamline/filters/ExcludeOnCaseAttributeEqualityFilter.java

@@ -40,7 +40,7 @@ public class ExcludeOnCaseAttributeEqualityFilter<T extends XAttribute> implemen
 	/**
 	 * Adds the value to the list of values to be considered for removal
 	 * 
-	 * @param value
+	 * @param value value
 	 */
 	public void addValue(T value) {
 		this.attributeValues.add(value);

src/main/java/beamline/filters/ExcludeOnEventAttributeEqualityFilter.java

@@ -40,7 +40,7 @@ public class ExcludeOnEventAttributeEqualityFilter<T extends XAttribute> impleme
 	/**
 	 * Adds the value to the list of values to be considered for removal
 	 * 
-	 * @param value
+	 * @param value value
 	 */
 	public void addValue(T value) {
 		this.attributeValues.add(value);

src/main/java/beamline/filters/RetainOnCaseAttributeEqualityFilter.java

@@ -40,7 +40,7 @@ public class RetainOnCaseAttributeEqualityFilter<T extends XAttribute> implement
 	/**
 	 * Adds the value to the list of values to be considered for retention
 	 * 
-	 * @param value
+	 * @param value value
 	 */
 	public void addValue(T value) {
 		this.attributeValues.add(value);

src/main/java/beamline/filters/RetainOnEventAttributeEqualityFilter.java

@@ -40,7 +40,7 @@ public class RetainOnEventAttributeEqualityFilter<T extends XAttribute> implemen
 	/**
 	 * Adds the value to the list of values to be considered for retention
 	 * 
-	 * @param value
+	 * @param value value
 	 */
 	public void addValue(T value) {
 		this.attributeValues.add(value);

src/main/java/beamline/mappers/DirectlyFollowsRelation.java

@@ -17,9 +17,9 @@ public class DirectlyFollowsRelation {
 	/**
 	 * Constructor
 	 * 
-	 * @param caseId
-	 * @param first
-	 * @param second
+	 * @param caseId the case id
+	 * @param first the first event
+	 * @param second the second event
 	 */
 	public DirectlyFollowsRelation(String caseId, XEvent first, XEvent second) {
 		this.caseId = caseId;
@@ -30,7 +30,7 @@ public class DirectlyFollowsRelation {
 	/**
 	 * Returns the case id this directly follows relation belongs to
 	 * 
-	 * @return
+	 * @return the case id
 	 */
 	public String getCaseId() {
 		return caseId;
@@ -39,7 +39,7 @@ public class DirectlyFollowsRelation {
 	/**
 	 * Returns the first event
 	 * 
-	 * @return
+	 * @return the first event
 	 */
 	public XEvent getFirst() {
 		return first;
@@ -48,7 +48,7 @@ public class DirectlyFollowsRelation {
 	/**
 	 * Returns the second event
 	 * 
-	 * @return
+	 * @return the second event
 	 */
 	public XEvent getSecond() {
 		return second;

src/main/java/beamline/models/algorithms/StreamMiningAlgorithm.java

@@ -5,8 +5,8 @@ import io.reactivex.rxjava3.functions.Consumer;
 
 /**
  * This abstract class defines the root of the mining algorithms hierarchy. It
- * is a {@link Consumer} of elements with type <tt>T</tt> that is capable of
- * producing responses of a certain type <tt>K</tt>.
+ * is a {@link Consumer} of elements with type <code>T</code> that is capable of
+ * producing responses of a certain type <code>K</code>.
  * 
  * @author Andrea Burattin
  *
@@ -33,7 +33,7 @@ public abstract class StreamMiningAlgorithm<T, K> implements Consumer<T> {
 	/**
 	 * Returns the total number of events processed so far
 	 * 
-	 * @return
+	 * @return the total number of events processed so far
 	 */
 	public int getProcessedEvents() {
 		return processedEvents;
@@ -42,7 +42,7 @@ public abstract class StreamMiningAlgorithm<T, K> implements Consumer<T> {
 	/**
 	 * Returns the latest result of the mining
 	 * 
-	 * @return
+	 * @return the latest result of the mining
 	 */
 	public K getLatestResponse() {
 		return latestResponse;

src/main/java/beamline/models/responses/GraphvizResponse.java

@@ -13,7 +13,7 @@ public interface GraphvizResponse extends Response {
 	/**
 	 * Returns the Dot representation of the response
 	 * 
-	 * @return
+	 * @return the Dot representation of the response
 	 */
 	public abstract Dot generateDot();
 }

src/main/java/beamline/sources/CSVLogSource.java

 package beamline.sources;
 
-import java.io.IOException;
 import java.io.Reader;
 import java.nio.file.Files;
 import java.nio.file.Paths;
@@ -53,9 +52,8 @@ public class CSVLogSource implements XesSource {
 	 * @param activityNameColumn the id of the column containing the activity
 	 * name (counting starts from 0)
 	 * @param parser the parser to be used for parsing the CSV file
-	 * @throws IOException
 	 */
-	public CSVLogSource(String filename, int caseIdColumn, int activityNameColumn, CSVParser parser) throws IOException {
+	public CSVLogSource(String filename, int caseIdColumn, int activityNameColumn, CSVParser parser) {
 		this.filename = filename;
 		this.caseIdColumn = caseIdColumn;
 		this.activityNameColumn = activityNameColumn;
@@ -70,9 +68,8 @@ public class CSVLogSource implements XesSource {
 	 * starts from 0)
 	 * @param activityNameColumn the id of the column containing the activity
 	 * name (counting starts from 0)
-	 * @throws IOException
 	 */
-	public CSVLogSource(String filename, int caseIdColumn, int activityNameColumn) throws IOException {
+	public CSVLogSource(String filename, int caseIdColumn, int activityNameColumn) {
 		this(filename, caseIdColumn, activityNameColumn, null);
 	}
 

src/main/java/beamline/sources/MQTTXesSource.java

@@ -30,7 +30,9 @@ import io.reactivex.rxjava3.subjects.PublishSubject;
  * source.prepare();
  * </pre>
  * 
- * @see {@link http://www.beamline.cloud/mqtt-xes/}
+ * <p>
+ * See also the documentation of MQTT-XES at http://www.beamline.cloud/mqtt-xes/
+ * 
  * @author Andrea Burattin
  */
 public class MQTTXesSource implements XesSource {

src/main/java/beamline/sources/Source.java

@@ -19,7 +19,7 @@ public interface Source<T> {
 	 * this method, it is important to prepare the source by calling the
 	 * {@link #prepare()} method.
 	 * 
-	 * @return
+	 * @return the {@link Observable}
 	 */
 	public Observable<T> getObservable();
 	
@@ -27,7 +27,9 @@ public interface Source<T> {
 	 * This method is supposed to be called before the {@link #getObservable()}
 	 * one: it is in charge of preparing the source to be processed.
 	 * 
-	 * @throws Exception 
+	 * @throws Exception while preparing the source, it is important to be aware
+	 * that some sources may generate specific exceptions (e.g., file not found,
+	 * network problems).
 	 */
 	public void prepare() throws Exception;
 }