Even More documentation updates

Author: Brandon Lax

Autograder.java

@@ -26,7 +26,7 @@
 import org.junit.runner.JUnitCore;
 
 /**
-   Classs representing an autograder.
+   Classs representing an autograder.\n
    It's main method is the running of the autograder
    and instances can be made to store all important information.
    @author Brandon Lax
@@ -55,7 +55,7 @@ public class Autograder {
    public static final String CHECKSTYLE_XML = "/autograder/source/checkstyle/check112.xml";
 
    /**
-      The Autograder class constructor.
+      The Autograder class constructor.\n
       Initializes the list of all tests.
       @param visible The visibility of the result to students see {@link #setVisibility(int) setvisibility}
       @param score The amount of points a test is worth
@@ -68,16 +68,16 @@ public Autograder(int visible, double score) {
    }
 
    /**
-      The Autograder class constructor.
-      Initializes the list of all tests.
+      The Autograder class constructor.\n
+      Initializes the list of all tests.\n
       Also sets the visibility to hidden and 
       the score to 0.1
    */
    public Autograder() {
       this(1, 0.1);
    }
 
-   /** Method to add a seperately made test to the results.
+   /** Method to add a seperately made test to the results.\n
        This allows for people to make child classes of the autograder
        if they need tests that dont currently exist that they would 
        prefer to avoid adding to this class. For an example see
@@ -89,8 +89,8 @@ public void addTestResult(TestResult t) {
    }
 
 
-   /** This is the wrap-up code of the autograder.
-       <b>Must be the last line of the main method.</b> It
+   /** This is the wrap-up code of the autograder.\n
+       <b>Must be the last line of the main method.</b> \nIt
        prints all of the results in a JSON format to 
        standard out.
        @throws Exception fails to create json for a test 
@@ -108,7 +108,7 @@ public void testRunFinished() throws Exception {
    }
 
    /**
-    * Test to check if source file exists.
+    * Test to check if source file exists.\n
     * Will output whether the file exists as well as 
     * add a junit test for it.
     * @param programName the program name (can include or not include the .java)

README.md

@@ -1,12 +1,5 @@
-This repo contains a basic autograder.
+# A Java Gradescope Autograder
 
- 
-It basically moves all the files into the source folder.
-Then it compiles and runs Autograder.java which checks
-for existance, compilation and checkstyle compliance.
-It also runs a set of diff tests for each program.
-It takes arguments in pairs: programName #ofDiffTests
-For autograder to run it must have at least one file to
-run and test
+This repo contains the autograder used in EN.500.112 Gateway Computing: JAVA at Johns Hopkins University.
 
-NOTE:  Still being Edited
+The design of the autograder allows for a large number of options

examples/classwork/README.md

@@ -1,11 +1,12 @@
+# Classwork
 This is an example version of the autograder that works with Gateway Computing classwork activity.
 
 The processing is split into two parts:
 1. run_autograder
 2. AutograderMain.java
 
 
-# run_autograder
+## run_autograder
 run_autograder copies the users Proj2B.java file from the submission directory to the source directory.
 This is done so that the user code is in the same place as all of the running code.
 This class does not use packages as it is an intro class so we cant rely on packages to know locations.
@@ -15,7 +16,7 @@ Then it calls AutograderMain
 
 It then redirects the output of the method into results/results.json which is what junit uses to check test results.
 
-# AutograderMain.java
+## AutograderMain.java
 
 1. It compiles Point.java, DataSet.java, and StatisticsSample.java to use later
 2. It checks if the source file exists and whether it compiles

examples/project_2/README.md

@@ -1,11 +1,12 @@
+# Project 2
 This is an example version of the autograder that works with Gateway Computing Project 2. 
 
 The processing is split into two parts:
 1. run_autograder
 2. AutograderMain.java
 
 
-# run_autograder
+## run_autograder
 run_autograder copies the users Proj2B.java file from the submission directory to the source directory.
 This is done so that the user code is in the same place as all of the running code.
 This class does not use packages as it is an intro class so we cant rely on packages to know locations.
@@ -16,7 +17,7 @@ java_class_name #difftests #comparisontests
 
 It then redirects the output of the method into results/results.json which is what junit uses to check test results.
 
-# AutograderMain.java
+## AutograderMain.java
 
 1. It takes the information provided and turns it into a program object
 2. It tests whether the source file exists