Skip to content

Commit b68958a

Browse files
committed
Updated Javadocs in the header of the JCalc class
1 parent a657f89 commit b68958a

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

jcalc/src/main/java/cu/lt/joe/jcalc/JCalc.java

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,16 @@
55
import cu.lt.joe.jcalc.exceptions.NotNumericResultException;
66

77
/**
8-
* This class is the entry point of this library. It is, indeed, the class intended to solve Math
9-
* expressions and configure all the parameters required to do so by passing a Math expression and a
10-
* {@link ConfigurationBuilder} instance with all the parameters set as you wish to the
11-
* {@link #solveMathExpression(String, ConfigurationBuilder)} method.
8+
* This class is intended to solve Math expressions. For general purposes, you just have to use the
9+
* method {@link #solveMathExpression(String)}. If you want to also configure some of the parameters
10+
* used to do so, then call the alternative method {@link #solveMathExpression(String, ConfigurationBuilder)}
11+
* and pass an instance of the {@link ConfigurationBuilder} class, setting the parameters you wish
12+
* to use through that instance.
1213
*
1314
* @author <a href="https://github.com/jr20xx">jr20xx</a>
15+
* @see #solveMathExpression(String)
1416
* @see #solveMathExpression(String, ConfigurationBuilder)
15-
* @since 3.0.0
17+
* @since 3.0.1
1618
*/
1719
public class JCalc
1820
{

0 commit comments

Comments
 (0)