update javadoc

easy-rules-core/src/main/java/org/jeasy/rules/api/Rule.java

@@ -26,7 +26,7 @@
 /**
  * Abstraction for a rule that can be fired by the rules engine.
  *
- * Rules are registered in the rules engine registry and must have a <strong>unique</strong> name.
+ * Rules are registered in a rule set of type <code>Rules</code> in which they must have a <strong>unique</strong> name.
  *
  * @author Mahmoud Ben Hassine ([email protected])
  */

easy-rules-core/src/main/java/org/jeasy/rules/core/InferenceRulesEngine.java

@@ -34,7 +34,7 @@
  *
  * Rules are selected based on given facts and fired according to their natural order which is priority by default.
  *
- * The engine continuously select and fire rules until no more rules are applicable.
+ * The engine continuously selects and fires rules until no more rules are applicable.
  *
  * @author Mahmoud Ben Hassine ([email protected])
  */

easy-rules-core/src/main/java/org/jeasy/rules/core/RuleDefinitionValidator.java

@@ -38,7 +38,7 @@
 import org.jeasy.rules.api.Facts;
 
 /**
- * Validate that an annotated rule object is well defined.
+ * This component validates that an annotated rule object is well defined.
  *
  * @author Mahmoud Ben Hassine ([email protected])
  */

easy-rules-core/src/main/java/org/jeasy/rules/core/RulesEngineParameters.java

@@ -27,8 +27,8 @@
  * Parameters of a rules engine.
  *
  * <ul>
- *     <li>When parameters are used with a {@link DefaultRulesEngine}, they are applied on all registered rules.</li>
- *     <li>When parameters are used with a {@link InferenceRulesEngine}, they are applied on candidate rules in each iteration.</li>
+ *     <li>When parameters are used with a {@link DefaultRulesEngine}, they are applied on <strong>all registered rules</strong>.</li>
+ *     <li>When parameters are used with a {@link InferenceRulesEngine}, they are applied on <strong>candidate rules in each iteration</strong>.</li>
  * </ul>
  *
  * @author Mahmoud Ben Hassine ([email protected])

easy-rules-core/src/test/java/org/jeasy/rules/core/CompositeRuleTest.java

@@ -32,11 +32,6 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.Mockito.*;
 
-/**
- * Test class for composite rule execution.
- *
- * @author Mahmoud Ben Hassine ([email protected])
- */
 public class CompositeRuleTest extends AbstractTest {
 
     private CompositeRule compositeRule;

easy-rules-core/src/test/java/org/jeasy/rules/core/CustomRuleOrderingTest.java

@@ -33,11 +33,6 @@
 import static org.mockito.Mockito.inOrder;
 import static org.mockito.Mockito.when;
 
-/**
- * Test class for custom rule ordering.
- *
- * @author Mahmoud Ben Hassine ([email protected])
- */
 @RunWith(MockitoJUnitRunner.class)
 public class CustomRuleOrderingTest extends AbstractTest {
 

easy-rules-core/src/test/java/org/jeasy/rules/core/DefaultRulesEngineTest.java

@@ -44,11 +44,6 @@
 import org.mockito.InOrder;
 import org.mockito.Mock;
 
-/**
- * Test class for {@link DefaultRulesEngine}.
- *
- * @author Mahmoud Ben Hassine ([email protected])
- */
 public class DefaultRulesEngineTest extends AbstractTest {
 
     @Mock

easy-rules-core/src/test/java/org/jeasy/rules/core/RuleListenerTest.java

@@ -31,11 +31,6 @@
 
 import static org.mockito.Mockito.*;
 
-/**
- * Test class of the execution of rule listeners.
- *
- * @author Mahmoud Ben Hassine ([email protected])
- */
 public class RuleListenerTest extends AbstractTest {
 
     @Mock

easy-rules-core/src/test/java/org/jeasy/rules/core/RulePriorityThresholdTest.java

@@ -30,11 +30,6 @@
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
-/**
- * Test class of rules priority comparison.
- *
- * @author Mahmoud Ben Hassine ([email protected])
- */
 public class RulePriorityThresholdTest extends AbstractTest {
 
     @Before

easy-rules-core/src/test/java/org/jeasy/rules/core/RulesEngineListenerTest.java

@@ -32,11 +32,6 @@
 import static java.util.Arrays.asList;
 import static org.mockito.Mockito.*;
 
-/**
- * Test class of the execution of rules engine listeners.
- *
- * @author Mahmoud Ben Hassine ([email protected])
- */
 public class RulesEngineListenerTest extends AbstractTest {
 
     @Mock

easy-rules-core/src/test/java/org/jeasy/rules/core/SkipOnFirstAppliedRuleTest.java

@@ -28,11 +28,6 @@
 
 import static org.mockito.Mockito.*;
 
-/**
- * Test class of "skip on first applied rule" parameter of Easy Rules default engine.
- *
- * @author Mahmoud Ben Hassine ([email protected])
- */
 public class SkipOnFirstAppliedRuleTest extends AbstractTest {
 
     @Before

easy-rules-core/src/test/java/org/jeasy/rules/core/SkipOnFirstFailedRuleTest.java

@@ -28,11 +28,6 @@
 
 import static org.mockito.Mockito.*;
 
-/**
- * Test class of "skip on first failed rule" parameter of Easy Rules default engine.
- *
- * @author Mahmoud Ben Hassine ([email protected])
- */
 public class SkipOnFirstFailedRuleTest extends AbstractTest {
 
     @Before

easy-rules-core/src/test/java/org/jeasy/rules/core/SkipOnFirstNonTriggeredRuleTest.java

@@ -28,11 +28,6 @@
 
 import static org.mockito.Mockito.*;
 
-/**
- * Test class of "skip on first non triggered rule" parameter of Easy Rules default engine.
- *
- * @author Krzysztof Kozlowski ([email protected])
- */
 public class SkipOnFirstNonTriggeredRuleTest extends AbstractTest {
 
     @Before

easy-rules-mvel/src/main/java/org/jeasy/rules/mvel/MVELRuleFactory.java

@@ -37,6 +37,7 @@ public class MVELRuleFactory {
 
     /**
      * Create a new {@link MVELRule} from a rule descriptor.
+     *
      * @param ruleDescriptor in yaml format
      * @return a new rule
      * @throws FileNotFoundException if the rule descriptor cannot be found