update javadoc to fix errors

kieler · Sep 1, 2023 · 8180323 · 8180323
1 parent 28284d1
commit 8180323
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 34 deletions.
diff --git a/...ins/de.cau.cs.kieler.klighd/src/de/cau/cs/kieler/klighd/filtering/IdentityConnective.java b/...ins/de.cau.cs.kieler.klighd/src/de/cau/cs/kieler/klighd/filtering/IdentityConnective.java
@@ -3,7 +3,7 @@
  *
  * http://rtsys.informatik.uni-kiel.de/kieler
  * 
- * Copyright 2022 by
+ * Copyright 2022 - 2023 by
  * + Kiel University
  *   + Department of Computer Science
  *     + Real-Time and Embedded Systems Group
@@ -28,17 +28,15 @@ public class IdentityConnective extends UnaryConnective {
 
     /**
      * Constructor for unnamed rule.
-     * @param leftOperand left operand
-     * @param rightOperand right operand
+     * @param operand operand
      */
     public IdentityConnective(SemanticFilterRule operand) {
         this(operand, null, null);
     }
 
     /**
      * Constructor for unnamed rule with default value.
-     * @param leftOperand left operand
-     * @param rightOperand right operand
+     * @param operand operand
      * @param defaultValue the default value
      */
     public IdentityConnective(SemanticFilterRule operand, Boolean defaultValue) {
@@ -47,8 +45,7 @@ public IdentityConnective(SemanticFilterRule operand, Boolean defaultValue) {
 
     /**
      * Constructor for named rule.
-     * @param leftOperand left operand
-     * @param rightOperand right operand
+     * @param operand operand
      * @param ruleName rule name
      */
     public IdentityConnective(SemanticFilterRule operand, String ruleName) {
@@ -57,8 +54,7 @@ public IdentityConnective(SemanticFilterRule operand, String ruleName) {
 
     /**
      * Constructor for named rule with default value.
-     * @param leftOperand left operand
-     * @param rightOperand right operand
+     * @param operand operand
      * @param defaultValue the default value
      * @param ruleName rule name
      */

diff --git a/...s/de.cau.cs.kieler.klighd/src/de/cau/cs/kieler/klighd/filtering/LessEqualsConnective.java b/...s/de.cau.cs.kieler.klighd/src/de/cau/cs/kieler/klighd/filtering/LessEqualsConnective.java
@@ -3,7 +3,7 @@
  *
  * http://rtsys.informatik.uni-kiel.de/kieler
  * 
- * Copyright 2022 by
+ * Copyright 2022 - 2023 by
  * + Kiel University
  *   + Department of Computer Science
  *     + Real-Time and Embedded Systems Group
@@ -19,7 +19,7 @@
 /**
  * A LessEquals Connective takes two numeric rules R1 and R2 and evaluates to true
  * iff
- * R1 <= R2
+ * {@code R1 <= R2}
  * 
  * @author mka
  *

diff --git a/...ins/de.cau.cs.kieler.klighd/src/de/cau/cs/kieler/klighd/filtering/LessThanConnective.java b/...ins/de.cau.cs.kieler.klighd/src/de/cau/cs/kieler/klighd/filtering/LessThanConnective.java
@@ -3,7 +3,7 @@
  *
  * http://rtsys.informatik.uni-kiel.de/kieler
  * 
- * Copyright 2022 by
+ * Copyright 2022 - 2023 by
  * + Kiel University
  *   + Department of Computer Science
  *     + Real-Time and Embedded Systems Group
@@ -19,7 +19,7 @@
 /**
  * A LessThan Connective takes two numeric rules R1 and R2 and evaluates to true
  * iff
- * R1 < R2
+ * {@code R1 < R2}
  * @author tik, mka
  *
  */

diff --git a/...cau.cs.kieler.klighd/src/de/cau/cs/kieler/klighd/filtering/NumericAdditionConnective.java b/...cau.cs.kieler.klighd/src/de/cau/cs/kieler/klighd/filtering/NumericAdditionConnective.java
@@ -3,7 +3,7 @@
  *
  * http://rtsys.informatik.uni-kiel.de/kieler
  * 
- * Copyright 2022 by
+ * Copyright 2022 - 2023 by
  * + Kiel University
  *   + Department of Computer Science
  *     + Real-Time and Embedded Systems Group
@@ -30,11 +30,9 @@ public class NumericAdditionConnective extends BinaryConnective implements Numer
     protected static final String NAME = "NUMERICADDITION";
 
     /**
-     * Constructor for named rule with default value.
+     * Constructor for numeric addition connective.
      * @param leftOperand left operand
      * @param rightOperand right operand
-     * @param defaultValue the default value
-     * @param ruleName rule name
      */
     public NumericAdditionConnective(NumericResult leftOperand, NumericResult rightOperand) {
         super();

diff --git a/...cau.cs.kieler.klighd/src/de/cau/cs/kieler/klighd/filtering/NumericDivisionConnective.java b/...cau.cs.kieler.klighd/src/de/cau/cs/kieler/klighd/filtering/NumericDivisionConnective.java
@@ -3,7 +3,7 @@
  *
  * http://rtsys.informatik.uni-kiel.de/kieler
  * 
- * Copyright 2022 by
+ * Copyright 2022 - 2023 by
  * + Kiel University
  *   + Department of Computer Science
  *     + Real-Time and Embedded Systems Group
@@ -30,11 +30,9 @@ public class NumericDivisionConnective extends BinaryConnective implements Numer
     protected static final String NAME = "NUMERICDIVISION";
 
     /**
-     * Constructor for named rule with default value.
+     * Constructor for numeric division connective.
      * @param leftOperand left operand
      * @param rightOperand right operand
-     * @param defaultValue the default value
-     * @param ruleName rule name
      */
     public NumericDivisionConnective(NumericResult leftOperand, NumericResult rightOperand) {
         super();

diff --git a/....kieler.klighd/src/de/cau/cs/kieler/klighd/filtering/NumericMultiplicationConnective.java b/....kieler.klighd/src/de/cau/cs/kieler/klighd/filtering/NumericMultiplicationConnective.java
@@ -3,7 +3,7 @@
  *
  * http://rtsys.informatik.uni-kiel.de/kieler
  * 
- * Copyright 2022 by
+ * Copyright 2022 - 2023 by
  * + Kiel University
  *   + Department of Computer Science
  *     + Real-Time and Embedded Systems Group
@@ -30,11 +30,9 @@ public class NumericMultiplicationConnective extends BinaryConnective implements
     protected static final String NAME = "NUMERICMULTIPLICATION";
 
     /**
-     * Constructor for named rule with default value.
+     * Constructor for numeric multiplication connective.
      * @param leftOperand left operand
      * @param rightOperand right operand
-     * @param defaultValue the default value
-     * @param ruleName rule name
      */
     public NumericMultiplicationConnective(NumericResult leftOperand, NumericResult rightOperand) {
         super();

diff --git a/....cs.kieler.klighd/src/de/cau/cs/kieler/klighd/filtering/NumericSubtractionConnective.java b/....cs.kieler.klighd/src/de/cau/cs/kieler/klighd/filtering/NumericSubtractionConnective.java
@@ -3,7 +3,7 @@
  *
  * http://rtsys.informatik.uni-kiel.de/kieler
  * 
- * Copyright 2022 by
+ * Copyright 2022 - 2023 by
  * + Kiel University
  *   + Department of Computer Science
  *     + Real-Time and Embedded Systems Group
@@ -30,11 +30,9 @@ public class NumericSubtractionConnective extends BinaryConnective implements Nu
     protected static final String NAME = "NUMERICSUBSTRACTION";
 
     /**
-     * Constructor for named rule with default value.
+     * Constructor for numeric subtraction connective.
      * @param leftOperand left operand
      * @param rightOperand right operand
-     * @param defaultValue the default value
-     * @param ruleName rule name
      */
     public NumericSubtractionConnective(NumericResult leftOperand, NumericResult rightOperand) {
         super();

diff --git a/....kieler.klighd/src/de/cau/cs/kieler/klighd/filtering/parser/SemanticFilterRuleParser.java b/....kieler.klighd/src/de/cau/cs/kieler/klighd/filtering/parser/SemanticFilterRuleParser.java
@@ -48,13 +48,13 @@
 
 /**
  * Provides a parser for the semantic filter language. The syntax is of the form
- * <rule> <operator> <rule> for all binary operators. The most basic rule is a tag
- * #<tag> that evaluates to true if an element has that tag and false otherwise. 
- * Tags may also contain numeric values in which case they  are written as $<tag>.
+ * &lt;rule&gt; &lt;operator&gt; &lt;rule&gt; for all binary operators. The most basic rule is a tag
+ * #&lt;tag&gt; that evaluates to true if an element has that tag and false otherwise. 
+ * Tags may also contain numeric values in which case they  are written as $&lt;tag&gt;.
  * Constant values can be expressed as true, false or a number. Brackets may be used 
  * to override precedences. The full list of available operators is given in the table 
  * below.
- * 
+ * <pre>{@code
  * | Operator       |  Syntax                |  Input          | Output  | Precedence |
  * |----------------|------------------------|-----------------|---------|------------|
  * | And            | \<expr\> && \<expr\>   | boolean         | boolean | 4          |
@@ -70,7 +70,7 @@
  * | LessThan       | \<expr\> < \<expr\>    | numeric         | boolean | 8          |
  * | Equals         | \<expr\> = \<expr\>    | numeric/boolean | boolean | 7          |
  * | NotEqual       | \<expr\> != \<expr\>   | numeric/boolean | boolean | 7          |
-
+ * }</pre>
  * @author mka
  *
  */