Add JavaDocs

This commit is contained in:
2024-07-28 23:11:22 +01:00
parent 1187bedc5b
commit 0198ba6e56
4 changed files with 345 additions and 6 deletions
@@ -1,6 +1,7 @@
package com.shr4pnel.minesweeper;
import java.io.IOException;
import javafx.application.Application;
import javafx.fxml.FXML;
import javafx.fxml.FXMLLoader;
@@ -9,6 +10,12 @@ import javafx.scene.image.Image;
import javafx.stage.Stage;
public class Main extends Application {
/**
* JavaFX opening method. Creates the stage and bootstraps the application.
*
* @param stage The stage object passed in by JavaFX.
* @throws IOException If the FXML template or app icon are not found in resources.
*/
@Override
public void start(Stage stage) throws IOException {
Image icon = new Image(String.valueOf(getClass().getResource("winmine.png")));
@@ -21,10 +28,19 @@ public class Main extends Application {
stage.show();
}
/**
* Application opening method. Calls the JavaFX start method.
*
* @param args Optional commandline parameters, unimplemented.
* @see #start(Stage)
*/
public static void main(String[] args) {
launch();
}
/**
* Cancels the timer on application stop.
*/
@Override
@FXML
public void stop() {