Skip to content

Commit 2e769b9

Browse files
committed
documentation and comments corrected
1 parent e09605b commit 2e769b9

37 files changed

Lines changed: 159 additions & 91 deletions

src/main/java/com/scriptbasic/Function.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
* <p>
1616
* Each {@code public static} method that is supposed to be reachable from BASIC
1717
* should have the annotation {@code @Function}. The implementation of the
18-
* interface {@see Interpreter} provides method that registers all the such
18+
* interface {@link Interpreter} provides method that registers all the such
1919
* annotated methods of the class specified.
2020
*
2121
* @author Peter Verhas date July 22, 2012
@@ -94,7 +94,7 @@
9494

9595
/**
9696
* Using this parameter you can specify an alternative method instead of the
97-
* annotated one. See the documentation of {@see #substituteClass()}.
97+
* annotated one. See the documentation of {@link #substituteClass()}.
9898
*/
9999
String substituteMethod() default "";
100100
}

src/main/java/com/scriptbasic/classification/Constant.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
* Functions that let the BASIC program to access some special constant values
88
* should be annotated using this interface as classification parameter.
99
* <p>
10-
* The best example of these functions is the {@see
10+
* The best example of these functions is the {@link
1111
* RuntimeUtility#nullFunction()} that returns a {@code null} values.
1212
* <p>
1313
* Functions classified using these value should be considered exceptionally

src/main/java/com/scriptbasic/executors/leftvalues/BasicLeftValue.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ private static RightValue handleAccessModifier(RightValue variable,
131131

132132
/**
133133
* Handle variable access modifier in case when the modifier is object field
134-
* access. {@see #handleAccessModifier(RightValue, LeftValueModifier,
134+
* access. {@link #handleAccessModifier(RightValue, LeftValueModifier,
135135
* boolean, RightValue)}.
136136
*
137137
* @param variable
@@ -166,7 +166,7 @@ private static RightValue handleObjectFieldAccess(RightValue variable,
166166

167167
/**
168168
* Handle variable access modifier in case when the modifier is array
169-
* element access. {@see #handleAccessModifier(RightValue,
169+
* element access. {@link #handleAccessModifier(RightValue,
170170
* LeftValueModifier, boolean, RightValue)}.
171171
*
172172
* @param variable

src/main/java/com/scriptbasic/executors/rightvalues/BasicArrayValue.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public class BasicArrayValue extends AbstractRightValue {
2121
* for extension methods and is not used by the interpreter. This method can
2222
* be used when the array is available from some calculation and it would be
2323
* waste of resource to copy the elements of the array one by one calling
24-
* {@ref #set(Integer, Object)}.
24+
* {@link #set(Integer, Object)}.
2525
*
2626
* @param array
2727
* the array

src/main/java/com/scriptbasic/factories/BasicFactory.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
import com.scriptbasic.interfaces.FactoryManaged;
99

1010
/**
11-
* Implementing the interface {@see com.scriptbasic.interfaces.Factory} this
12-
* class instantiates the objects using the JDK standard {@see
11+
* Implementing the interface {@link com.scriptbasic.interfaces.Factory} this
12+
* class instantiates the objects using the JDK standard {@link
1313
* java.util.ServiceLoader}. A single factory instance will maintain a single
1414
* instance of each class and subsequent call on the same factory object to the
15-
* method {@see #get(Class)} will return the same class instance for the same
15+
* method {@link #get(Class)} will return the same class instance for the same
1616
* interface.
1717
* <p>
1818
* The implementation also checks that the argument passed to the method is an

src/main/java/com/scriptbasic/factories/FactoryFactory.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
import com.scriptbasic.interfaces.Factory;
55

66
/**
7-
* This utility class manages instances of the {@see BasicFactory} class.
7+
* This utility class manages instances of the {@link BasicFactory} class.
88
* <p>
9-
* The class {@see BasicFactory} is not singleton, however this class creates a
9+
* The class {@link BasicFactory} is not singleton, however this class creates a
1010
* single instance and manages that single instance.
1111
*
1212
* @author Peter Verhas

src/main/java/com/scriptbasic/factories/FactoryServiceLoader.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
import com.scriptbasic.interfaces.Factory;
88

99
/**
10-
* Using the standard {@see java.util.ServiceLoader} this utility class loads a
11-
* new instance of the implementation of the interface {@see Factory}.
10+
* Using the standard {@link java.util.ServiceLoader} this utility class loads a
11+
* new instance of the implementation of the interface {@link Factory}.
1212
* <p>
1313
*
1414
* @author Peter Verhas
@@ -24,12 +24,12 @@ private FactoryServiceLoader() {
2424

2525
/**
2626
* Load and create a new instance of the implementation of the interface
27-
* {@see Factory}. If there are multiple implementations then the first one
27+
* {@link Factory}. If there are multiple implementations then the first one
2828
* will be loaded. (The first as it is loaded by the standard Java
2929
* ServiceLoader class.)
3030
*
31-
* @return a new {@see Factory} instance or {@code null} if there is no
32-
* implementation of the interface {@see Factory}.
31+
* @return a new {@link Factory} instance or {@code null} if there is no
32+
* implementation of the interface {@link Factory}.
3333
*/
3434
public static Factory loadFactory() {
3535
ServiceLoader<Factory> loader = ServiceLoader.load(Factory.class);

src/main/java/com/scriptbasic/factories/SingletonFactoryFactory.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
/**
77
* This utility class manages a single instance of an implementation of the
8-
* {@see Factory} interface.
8+
* {@link Factory} interface.
99
* <p>
10-
* The class {@see BasicFactory} is not singleton, however this class creates a
10+
* The class {@link BasicFactory} is not singleton, however this class creates a
1111
* single instance and manages that single instance.
1212
*
1313
* @author Peter Verhas

src/main/java/com/scriptbasic/factories/ThreadLocalFactoryFactory.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
* Implements a factory factory that returns a new instance for each thread.
88
* <p>
99
* When the thread does not have an instance then the code uses the utility
10-
* class {@see FactoryFactory} to get a new instance.
10+
* class {@link FactoryFactory} to get a new instance.
1111
*
1212
* @author Peter Verhas
1313
* date Aug 1, 2012

src/main/java/com/scriptbasic/interfaces/Configuration.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,12 @@ public interface Configuration extends FactoryManaged {
5050
String getConfigValue(String key);
5151

5252
/**
53-
* Complimentary method calling {@see #getConfigValue(String)} but returning
53+
* Complimentary method calling {@link #getConfigValue(String)} but returning
5454
* the {@code defaultValue} instead of {@code null} if the {@code key} is
5555
* not configured.
5656
*
5757
* @param key
58-
* the configuration key, same as in {@see
58+
* the configuration key, same as in {@link
5959
* #getConfigValue(String)}.
6060
* @param defaultValue
6161
* is the default value string to return if the configuration key

0 commit comments

Comments
 (0)