-added documentation

Author: darkpositive

.idea/dictionaries/Vladislav.xml

@@ -536,7 +536,7 @@ protected Void call() throws Exception {
                     long leftoverTime = FRAMETIME - (System.currentTimeMillis() - taskTime);
                     if (leftoverTime > 0) {
                         // Wait until next frame.
-                        // TODO: This lags behind by around 1/30th of a second every loop, fix!
+
                         //noinspection BusyWait
                         Thread.sleep(leftoverTime);
                     }

src/main/java/stl/threebodysimulation/CanvasPanelFXMLController.java

@@ -6,8 +6,6 @@
 import javafx.scene.text.Font;
 import javafx.scene.transform.Rotate;
 
-// TODO documentation
-
 /**
  * A wrapper that manages the graphics of a canvas UI object.
  */
@@ -275,6 +273,7 @@ private void printHorizontalGridlines(double interval) {
                 gridGC.setStroke(Color.DARKGRAY);
             }
 
+            // Draws the vertical gridlines on the canvas
             double relativeCurrentGridline = returnRelativePosition(new double[]{0, currentGridline})[1];
             gridGC.strokeLine(-20, relativeCurrentGridline, 850, relativeCurrentGridline);
             gridGC.fillText(String.format("%g", currentGridline), 10, relativeCurrentGridline - 10);
@@ -289,10 +288,13 @@ private void printHorizontalGridlines(double interval) {
      * @return The grid interval.
      */
     private double calculateGridInterval() {
+
+        // Calculates the grid interval coefficient for determining the actual interval
         double rawGridInterval = 100 * particleScale;
         double base = Math.pow(10, Math.floor(Math.log10(rawGridInterval)));
         double coefficient = rawGridInterval / base;
 
+        // Determines the interval based on the coefficient
         if (coefficient <= 1.75) {
             return 1.0 * base;
         } else if (coefficient <= 4) {
@@ -438,7 +440,7 @@ void updateCanvas() {
             oldCanvasPos[i][0] = canvasPos[0];
             oldCanvasPos[i][1] = canvasPos[1];
 
-            // Conditionally draws the off-canvas position indicator TODO not displaying
+            // Conditionally draws the off-canvas position indicator
             if ((canvasPos[0] < 0 || canvasPos[0] > 800) || (canvasPos[1] < 0 || canvasPos[1] > 720)) {
                 double[] indicatorArgs = findIndicatorArguments(canvasPos);
                 drawRotatedText(particlesGC, "^", indicatorArgs[0], indicatorArgs[1], indicatorArgs[2]);
@@ -492,9 +494,10 @@ void clearCanvas() {
      */
     private double[] findIndicatorArguments(double[] canvasPos) {
 
-        final int OFFSET = 17; // Offset: artifically center indicators.
+        final int OFFSET = 17; // Offset: artificially center indicators.
         final int LOCK = 25; // Prevents indicators from drifting past corners.
 
+        // Declares the cases for drawing the indicators.
         final double[] UPPER_LEFT = {315, 20, 50};
         final double[] UPPER_RIGHT = {45, 750, 20};
         final double[] LOWER_LEFT = {225, 50, 700};

src/main/java/stl/threebodysimulation/CanvasWrapper.java

@@ -140,7 +140,7 @@ void setSettings(SimulationSettings settings) {
             }
         });
 
-        // Everything has 2 decimal places. TODO: Make sure things fit!
+        // Everything has 2 decimal places.
         timeskipLabel.setText(String.format("%.2f", settings.getSkip()));
         speedLabel.setText(String.format("%.2f", settings.getSpeed()));
         Particle[] particles = settings.getParticles();

src/main/java/stl/threebodysimulation/DefaultSavePreviewFXMLController.java

@@ -162,7 +162,7 @@ public void refreshSaves(String searchPrompt) {
                 if (!(searchPrompt.equals("") || filename.toLowerCase().contains(searchPrompt.toLowerCase()))) {
                     continue;
                 }
-                // TODO Documentation
+
                 // Reads a file and saves it as a node.
                 ArrayList<String> serializedForm = new ArrayList<>();
 

src/main/java/stl/threebodysimulation/SavesPanelFXMLController.java

@@ -6,25 +6,40 @@
 import javafx.scene.text.Font;
 import javafx.scene.text.FontWeight;
 import javafx.scene.text.Text;
-import javafx.scene.text.TextAlignment;
 import javafx.scene.text.TextFlow;
 
 import java.net.URL;
 import java.util.ResourceBundle;
 
-// TODO documentation
-
+/**
+ * A controller for the user manual popup.
+ */
 public class UserManualFXMLController implements Initializable {
 
+    /**
+     * The manual tab UI object in the user manual.
+     */
     @FXML
     TextFlow manualTextFlow;
 
+    /**
+     * The credits tab UI object in the user manual.
+     */
     @FXML
     TextFlow creditsTextFlow;
 
+    /**
+     * Constructor, for use by the FXML loader.
+     */
     public UserManualFXMLController() {
     }
 
+    /**
+     * Method that generates formatted heading text.
+     *
+     * @param s String to be formatted.
+     * @return Formatted string.
+     */
     private Text generateHeadingText(String s) {
         Text text = new Text();
         text.setFont(Font.font("System", FontWeight.BOLD, 20));
@@ -34,6 +49,12 @@ private Text generateHeadingText(String s) {
         return text;
     }
 
+    /**
+     * Method that generates formatted body text.
+     *
+     * @param s String to be formatted.
+     * @return Formatted string.
+     */
     private Text generateBodyText(String s) {
         Text text = new Text();
         text.setFont(Font.font("System", FontWeight.NORMAL, 16));
@@ -42,17 +63,28 @@ private Text generateBodyText(String s) {
         return text;
     }
 
+    /**
+     * Method that generates a formatted line of space.
+     *
+     * @return Line of space.
+     */
     private Text generateSpace() {
         Text text = new Text();
         text.setFont(Font.font("System", 4));
         text.setText("\n");
         return text;
     }
 
+    /**
+     * Main method for printing text on the user manual UI object.
+     *
+     * @param url Unused.
+     * @param resourceBundle Unused.
+     */
     @Override
     public void initialize(URL url, ResourceBundle resourceBundle) {
-        // Displays the text
 
+        // Displays the text
         Text[] manualTexts = new Text[] {
                 generateHeadingText("HOW TO RUN A SIMULATION:\n"),
                 generateSpace(),
@@ -97,6 +129,7 @@ public void initialize(URL url, ResourceBundle resourceBundle) {
                         " - Ikonli for UI icons\n\n")
         };
 
+        // Outputs the text onto the each UI tab
         for (Text text : manualTexts) {
             manualTextFlow.getChildren().add(text);
         }