Fix javadocs

j-easy · May 17, 2020 · f36cbe3 · f36cbe3
1 parent 3899894
commit f36cbe3
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/easy-rules-mvel/src/main/java/org/jeasy/rules/mvel/MVELRuleFactory.java b/easy-rules-mvel/src/main/java/org/jeasy/rules/mvel/MVELRuleFactory.java
@@ -78,6 +78,7 @@ public MVELRuleFactory(RuleDefinitionReader reader, ParserContext parserContext)
      *
      * @param ruleDescriptor descriptor of rule definition
      * @return a new rule
+     * @throws Exception if unable to create the rule from the descriptor
      */
     public Rule createRule(Reader ruleDescriptor) throws Exception {
         List<RuleDefinition> ruleDefinitions = reader.read(ruleDescriptor);
@@ -92,6 +93,7 @@ public Rule createRule(Reader ruleDescriptor) throws Exception {
      *
      * @param rulesDescriptor descriptor of rule definitions
      * @return a set of rules
+     * @throws Exception if unable to create rules from the descriptor
      */
     public Rules createRules(Reader rulesDescriptor) throws Exception {
         Rules rules = new Rules();

diff --git a/easy-rules-spel/src/main/java/org/jeasy/rules/spel/SpELRuleFactory.java b/easy-rules-spel/src/main/java/org/jeasy/rules/spel/SpELRuleFactory.java
@@ -101,14 +101,15 @@ public SpELRuleFactory(RuleDefinitionReader reader, ParserContext parserContext,
     }
 
     /**
-     * Create a new {@link SpELRule from a Reader.
+     * Create a new {@link SpELRule} from a Reader.
      * 
      * The rule descriptor should contain a single rule definition.
      * If no rule definitions are found, a {@link IllegalArgumentException} will be thrown.
      * If more than a rule is defined in the descriptor, the first rule will be returned.
      *
      * @param ruleDescriptor descriptor of rule definition
      * @return a new rule
+     * @throws Exception if unable to create the rule from the descriptor
      */
     public Rule createRule(Reader ruleDescriptor) throws Exception {
         List<RuleDefinition> ruleDefinitions = reader.read(ruleDescriptor);
@@ -123,6 +124,7 @@ public Rule createRule(Reader ruleDescriptor) throws Exception {
      *
      * @param rulesDescriptor descriptor of rule definitions
      * @return a set of rules
+     * @throws Exception if unable to create rules from the descriptor
      */
     public Rules createRules(Reader rulesDescriptor) throws Exception {
         Rules rules = new Rules();