mirror of
https://github.com/DanilaFe/abacus
synced 2024-12-23 16:00:09 -08:00
Add numerous documentation fixes.
This commit is contained in:
parent
6a29851618
commit
9b37794d04
|
@ -26,6 +26,7 @@ public class Operator {
|
||||||
* Creates a new operator with the given parameters.
|
* Creates a new operator with the given parameters.
|
||||||
*
|
*
|
||||||
* @param associativity the associativity of the operator.
|
* @param associativity the associativity of the operator.
|
||||||
|
* @param operatorType the type of this operator, like binary infix or unary postfix.
|
||||||
* @param precedence the precedence of the operator.
|
* @param precedence the precedence of the operator.
|
||||||
* @param function the function that the operator calls.
|
* @param function the function that the operator calls.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -15,7 +15,7 @@ public class ValueNode<T> extends PatternNode<T> {
|
||||||
/**
|
/**
|
||||||
* Creates a new node that matches the given character.
|
* Creates a new node that matches the given character.
|
||||||
*
|
*
|
||||||
* @param value
|
* @param value the character value of the node.
|
||||||
*/
|
*/
|
||||||
public ValueNode(char value) {
|
public ValueNode(char value) {
|
||||||
this.value = value;
|
this.value = value;
|
||||||
|
|
|
@ -82,14 +82,14 @@ public interface NumberInterface {
|
||||||
/**
|
/**
|
||||||
* Returns the least integer greater than or equal to the number.
|
* Returns the least integer greater than or equal to the number.
|
||||||
*
|
*
|
||||||
* @return the least integer >= the number, if int can hold the value.
|
* @return the least integer bigger or equal to the number, if int can hold the value.
|
||||||
*/
|
*/
|
||||||
NumberInterface ceiling();
|
NumberInterface ceiling();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return the greatest integer less than or equal to the number.
|
* Return the greatest integer less than or equal to the number.
|
||||||
*
|
*
|
||||||
* @return the greatest int >= the number, if int can hold the value.
|
* @return the greatest integer smaller or equal the number, if int can hold the value.
|
||||||
*/
|
*/
|
||||||
NumberInterface floor();
|
NumberInterface floor();
|
||||||
|
|
||||||
|
@ -104,7 +104,7 @@ public interface NumberInterface {
|
||||||
* Returns the integer representation of this number, discarding any fractional part,
|
* Returns the integer representation of this number, discarding any fractional part,
|
||||||
* if int can hold the value.
|
* if int can hold the value.
|
||||||
*
|
*
|
||||||
* @return
|
* @return the integer value of this number.
|
||||||
*/
|
*/
|
||||||
int intValue();
|
int intValue();
|
||||||
|
|
||||||
|
|
|
@ -28,7 +28,7 @@ public abstract class NumberImplementation {
|
||||||
* Creates a new number implementation with the given data.
|
* Creates a new number implementation with the given data.
|
||||||
*
|
*
|
||||||
* @param implementation the implementation class.
|
* @param implementation the implementation class.
|
||||||
* @param priority the priority, higher -> more likely to be converted into.
|
* @param priority the priority, higher means more likely to be converted into.
|
||||||
*/
|
*/
|
||||||
public NumberImplementation(Class<? extends NumberInterface> implementation, int priority) {
|
public NumberImplementation(Class<? extends NumberInterface> implementation, int priority) {
|
||||||
this.implementation = implementation;
|
this.implementation = implementation;
|
||||||
|
|
|
@ -70,6 +70,8 @@ public class PluginManager {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a new plugin manager.
|
* Creates a new plugin manager.
|
||||||
|
*
|
||||||
|
* @param abacus the abacus instance.
|
||||||
*/
|
*/
|
||||||
public PluginManager(Abacus abacus) {
|
public PluginManager(Abacus abacus) {
|
||||||
this.abacus = abacus;
|
this.abacus = abacus;
|
||||||
|
|
Loading…
Reference in New Issue
Block a user