Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Javadoc issues #454

Merged
merged 1 commit into from
Mar 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
import com.ezylang.evalex.parser.Token;
import java.math.RoundingMode;

/** Rounds the given value an integer using the rounding mode {@link RoundingMode#CEILING} */
/** Rounds the given value to an integer using the rounding mode {@link RoundingMode#CEILING} */
@FunctionParameter(name = "value")
public class CeilingFunction extends AbstractFunction {
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
import com.ezylang.evalex.parser.Token;
import java.math.RoundingMode;

/** Rounds the given value an integer using the rounding mode {@link RoundingMode#FLOOR} */
/** Rounds the given value to an integer using the rounding mode {@link RoundingMode#FLOOR} */
@FunctionParameter(name = "value")
public class FloorFunction extends AbstractFunction {
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* Function to format a DATE_TIME vale. Required parameter is the DATE_TIME value to format. First
* optional parameter is the format to use, using a pattern used by {@link DateTimeFormatter}. If no
* format is given, the first format defined in the configured formats is used. Second optional
* parameter is the zone-id to use wit formatting. Default is the configured zone-id.
* parameter is the zone-id to use with formatting. Default is the configured zone-id.
*/
@FunctionParameter(name = "parameters", isVarArg = true)
public class DateTimeFormatFunction extends AbstractFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@
import java.util.TimeZone;

/**
* Creates a new DATE_TIME value with the given parameters. IIf only one parameter is given, it is
* treated as th time in milliseconds from the epoch of 1970-01-01T00:00:00Z and a corresponding
* Creates a new DATE_TIME value with the given parameters. If only one parameter is given, it is
* treated as the time in milliseconds from the epoch of 1970-01-01T00:00:00Z and a corresponding
* date/time value is created. Else, A minimum of three parameters (year, month, day) must be
* specified. Optionally the hour, minute, second and nanosecond can be specified. If the last
* parameter is a string value, it is treated as a zone ID. If no zone ID is specified, the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

import com.ezylang.evalex.EvaluationException;
import com.ezylang.evalex.Expression;
import com.ezylang.evalex.config.ExpressionConfiguration;
import com.ezylang.evalex.data.EvaluationValue;
import com.ezylang.evalex.data.conversion.DateTimeConverter;
import com.ezylang.evalex.functions.AbstractFunction;
Expand All @@ -31,10 +32,11 @@
/**
* Parses a date-time string to a {@link EvaluationValue.DataType#DATE_TIME} value.
*
* <p>Optional arguments is the time zone and a list of {@link java.time.format.DateTimeFormatter}
* <p>Optional arguments are the time zone and a list of {@link java.time.format.DateTimeFormatter}
* patterns. Each pattern will be tried to convert the string to a date-time. The first matching
* pattern will be used. If <code>NULL</code> is specified for the time zone, the currently
* configured zone is used. If no formatters a
* configured zone is used. If no formatter is specified, the function will use the formatters
* defined at the {@link ExpressionConfiguration}.
*/
@FunctionParameter(name = "parameters", isVarArg = true)
public class DateTimeParseFunction extends AbstractFunction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import com.ezylang.evalex.functions.FunctionParameter;
import com.ezylang.evalex.parser.Token;

/** Function to convert a DATE_TIME value to milliseconds sind the epoch of 1970-01-01T00:00:00Z. */
/** Function to convert a DATE_TIME value to milliseconds in the epoch of 1970-01-01T00:00:00Z. */
@FunctionParameter(name = "value")
public class DateTimeToEpochFunction extends AbstractFunction {
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import com.ezylang.evalex.functions.FunctionParameter;
import com.ezylang.evalex.parser.Token;

/** Converts a DURATION value to teh amount of milliseconds. */
/** Converts a DURATION value to the amount of milliseconds. */
@FunctionParameter(name = "value")
public class DurationToMillisFunction extends AbstractFunction {
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import com.ezylang.evalex.functions.FunctionParameter;
import com.ezylang.evalex.parser.Token;

/** Returns true, if the string contains the substring (case-insensitive). */
/** Returns true if the string contains the substring (case-insensitive). */
@FunctionParameter(name = "string")
@FunctionParameter(name = "substring")
public class StringContains extends AbstractFunction {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/ezylang/evalex/parser/Token.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import lombok.Value;

/**
* A token represents a singe part of an expression, like an operator, number literal, or a brace.
* A token represents a single part of an expression, like an operator, number literal, or a brace.
* Each token has a unique type, a value (its representation) and a position (starting with 1) in
* the original expression string.
*
Expand Down
Loading