Skip to content

Commit de00748

Browse files
committed
Missed a few documentation methods
1 parent 0886476 commit de00748

3 files changed

Lines changed: 14 additions & 0 deletions

File tree

src/main/java/jaci/openrio/toast/core/ToastBootstrap.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,12 @@ public class ToastBootstrap {
5555
public static long startTimeMS;
5656
public static long endTimeMS;
5757

58+
/**
59+
* The Main Method. Called when the Toast Program is started. This contains multiple arguments, such as
60+
* -sim, -verify, -groovy, -groovyClass, -core and any others that are required. More of these are outlined in
61+
* the Whitepaper and various Loaders. Modules may also add their own arguments by retrieving 'runtime_args' from
62+
* the GlobalBlackboard
63+
*/
5864
public static void main(String[] args) {
5965
startTimeNS = System.nanoTime();
6066
startTimeMS = System.currentTimeMillis();

src/main/java/jaci/openrio/toast/core/loader/groovy/GroovyLoader.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,10 @@ public static void loadFiles(File[] files) {
138138
}
139139
}
140140

141+
/**
142+
* Get a class with the given name. This is used when a Groovy File is already in the classpath and doesn't need to be
143+
* loaded from an external file, and so only the class name is required to load and register the Groovy File.
144+
*/
141145
public static GroovyObject loadClassName(String name) throws ClassNotFoundException, IllegalAccessException, InstantiationException {
142146
Class groovyClass = loader.loadClass(name);
143147
GroovyObject object = (GroovyObject) groovyClass.newInstance();

src/main/java/jaci/openrio/toast/core/network/LoggerDelegate.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,10 @@ public void run() {
9898
}.start();
9999
}
100100

101+
/**
102+
* Called when a message is logged. This is delegated to this network connection and broadcasted to
103+
* all listening clients. This is directly called from the {@link Logger} class
104+
*/
101105
@Override
102106
public void onLog(String level, String message, String formatted, Logger logger) {
103107
broadcast(formatted);

0 commit comments

Comments
 (0)