Added javadocs

This commit is contained in:
simon
2018-05-01 15:41:51 -04:00
parent 083af31b84
commit e97ecbe380
39 changed files with 352 additions and 181 deletions

View File

@@ -1,10 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<module org.jetbrains.idea.maven.project.MavenProjectsManager.isMavenModule="true" type="JAVA_MODULE" version="4">
<component name="FacetManager">
<facet type="Spring" name="Spring">
<configuration />
</facet>
</component>
<component name="NewModuleRootManager" LANGUAGE_LEVEL="JDK_1_8">
<output url="file://$MODULE_DIR$/target/classes" />
<output-test url="file://$MODULE_DIR$/target/test-classes" />

View File

@@ -21,5 +21,4 @@ public class Main {
(new Thread(GameServer.INSTANCE)).start();
}
}

View File

@@ -61,7 +61,7 @@ public class Assembler {
/**
* Check for and save the origin
*
* @param line Current line. Assuming that the comments & labels are removed
* @param line Current line. Assuming that the comments and labels are removed
* @param result Current line number
*/
private static void checkForORGInstruction(String line, AssemblyResult result, int currentLine)
@@ -121,7 +121,7 @@ public class Assembler {
/**
* Parse the DW instruction (Define word). Handles DUP operator
*
* @param line Current line. assuming that comments & labels are removed
* @param line Current line. assuming that comments and labels are removed
* @param currentLine Current line number
* @param labels Map of labels
* @return Encoded instruction, null if the line is not a DW instruction
@@ -258,7 +258,7 @@ public class Assembler {
/**
* Parse the DW instruction (Define word). Handles DUP operator
*
* @param line Current line. assuming that comments & labels are removed
* @param line Current line. assuming that comments and labels are removed
* @param currentLine Current line number
* @return Encoded instruction, null if the line is not a DW instruction
*/
@@ -267,7 +267,7 @@ public class Assembler {
}
/**
* Check for and handle section declarations (.text & .data)
* Check for and handle section declarations (.text and .data)
*
* @param line Current line
*/

View File

@@ -17,7 +17,7 @@ import java.util.HashMap;
/**
* CPU: Central Processing Unit. A CPU is capable of reading bytes from
* a Memory object and execute them. A CPU object holds registers objects &
* a Memory object and execute them. A CPU object holds registers objects and
* a Memory object.
*/
public class CPU implements MongoSerialisable {

View File

@@ -7,10 +7,11 @@ import net.simon987.server.assembly.Util;
/**
* AND two numbers together, the result is stored in the destination operand
* <p>
* <br>
* AND A, B
* A = A & B
* </p>
* <br>
* {@literal A = A & B @}
* <br>
* FLAGS: OF=0 S=* Z=* X=0
*/
public class AndInstruction extends Instruction {

View File

@@ -6,9 +6,9 @@ import net.simon987.server.assembly.Status;
import net.simon987.server.assembly.Target;
/**
* Send hardware interupt
* Used to interact with the World using hardware
* </p>
* Send hardware interrupt
* <br>Used to interact with the World using hardware
*
*/
public class HwiInstruction extends Instruction {

View File

@@ -6,9 +6,9 @@ import net.simon987.server.assembly.Status;
import net.simon987.server.assembly.Target;
/**
* +---------------------+
* | |
* CF < 0<0<0<0<0<0<0<0 <-+
*<br> +---------------------+
*<br> | |
*<br> {@literal CF < 0<0<0<0<0<0<0<0 <-+ @}
*/
public class RclInstruction extends Instruction {

View File

@@ -5,9 +5,9 @@ import net.simon987.server.assembly.Status;
import net.simon987.server.assembly.Target;
/**
* +---------------------+
* | |
* CF < 0<0<0<0<0<0<0<0 <-+
* <br> +---------------------+
* <br> | |
* <br> {@literal CF < 0<0<0<0<0<0<0<0 <-+ @}
*/
public class RcrInstruction extends Instruction {

View File

@@ -5,9 +5,9 @@ import net.simon987.server.assembly.Status;
import net.simon987.server.assembly.Target;
/**
* +-----------------+
* | |
* CF < 0<0<0<0<0<0<0<0 <-+
* <br> +-----------------+
* <br> | |
* <br> {@literal CF < 0<0<0<0<0<0<0<0 <-+ @}
*/
public class RolInstruction extends Instruction {

View File

@@ -5,9 +5,9 @@ import net.simon987.server.assembly.Status;
import net.simon987.server.assembly.Target;
/**
* +-----------------+
* | |
* +-> 0>0>0>0>0>0>0>0 > CF
* <br> +-----------------+
* <br> | |
* <br> {@literal +-> 0>0>0>0>0>0>0>0 > CF @}
*/
public class RorInstruction extends Instruction {

View File

@@ -6,7 +6,7 @@ public interface Enterable {
* Called when an object attempts to walk directly into a Enterable object
*
* @param object The game object that attempted to enter
* @return true if successful,
* @return true if successful, false to block the object
*/
boolean enter(GameObject object);

View File

@@ -37,6 +37,7 @@ public class WebServer {
LogManager.LOGGER.info("(Web) Enabled ssl");
}
socketServer = new SocketServer();
Spark.webSocket("/socket", socketServer);

View File

@@ -114,6 +114,7 @@
.bottom-panel {
min-height: 18px;
max-height: 100%;
height: 235px;
width: 100%;
position: fixed;

View File

@@ -329,7 +329,7 @@ class GameClient {
}
}
à
public requestObjects(): void {
if (DEBUG) {
console.log("[MAR] Requesting game objects");