Update JavaDoc
This commit is contained in:
parent
004fe776eb
commit
7708654bdb
@ -22,6 +22,11 @@ import javafx.scene.input.MouseEvent;
|
|||||||
import javafx.scene.layout.GridPane;
|
import javafx.scene.layout.GridPane;
|
||||||
import javafx.stage.Stage;
|
import javafx.stage.Stage;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The JavaFX controller for minesweeper.fxml.
|
||||||
|
* Handles all operations performed within the GUI.
|
||||||
|
* @author shrapnelnet admin@shr4pnel.com
|
||||||
|
*/
|
||||||
public class Controller {
|
public class Controller {
|
||||||
/**
|
/**
|
||||||
* The grid within the FXML holding all the tiles.
|
* The grid within the FXML holding all the tiles.
|
||||||
@ -347,7 +352,7 @@ public class Controller {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* If a tile is surrounded by tiles with no adjacent bombs, open all of the tiles recursively
|
* If a tile is surrounded by tiles with no adjacent bombs, open all the tiles recursively
|
||||||
*
|
*
|
||||||
* @param column The column that was clicked
|
* @param column The column that was clicked
|
||||||
* @param row The row that was clicked
|
* @param row The row that was clicked
|
||||||
@ -497,7 +502,7 @@ public class Controller {
|
|||||||
* Create a flag on a tile, representing a tile that the user suspects has a bomb behind it.
|
* Create a flag on a tile, representing a tile that the user suspects has a bomb behind it.
|
||||||
* This prevents the tile being clicked on.
|
* This prevents the tile being clicked on.
|
||||||
*
|
*
|
||||||
* @param tileClicked
|
* @param tileClicked The tile that the user clicks.
|
||||||
*/
|
*/
|
||||||
private void flag(Node tileClicked) {
|
private void flag(Node tileClicked) {
|
||||||
Button tileAsButton = (Button) tileClicked;
|
Button tileAsButton = (Button) tileClicked;
|
||||||
|
@ -2,7 +2,14 @@ package com.shr4pnel.minesweeper;
|
|||||||
|
|
||||||
import java.util.concurrent.ThreadLocalRandom;
|
import java.util.concurrent.ThreadLocalRandom;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Used to fill the GridWrapper with bombs. Planned to merge into GridWrapper.
|
||||||
|
* @since 1.0.0
|
||||||
|
*/
|
||||||
public class Grid {
|
public class Grid {
|
||||||
|
/**
|
||||||
|
* An instance of GridWrapper used to check generation of bombs.
|
||||||
|
*/
|
||||||
final GridWrapper grid = new GridWrapper();
|
final GridWrapper grid = new GridWrapper();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
package com.shr4pnel.minesweeper;
|
package com.shr4pnel.minesweeper;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Simplifies operations on the bomb array. Preventing direct access leads to cleaner code.
|
||||||
|
* @since 1.0.0
|
||||||
|
*/
|
||||||
public class GridWrapper {
|
public class GridWrapper {
|
||||||
/**
|
/**
|
||||||
* Number of columns.
|
* Number of columns.
|
||||||
|
@ -9,6 +9,10 @@ import javafx.scene.Scene;
|
|||||||
import javafx.scene.image.Image;
|
import javafx.scene.image.Image;
|
||||||
import javafx.stage.Stage;
|
import javafx.stage.Stage;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The application opening point, used to bootstrap JavaFX and open to the GUI.
|
||||||
|
* @since 1.0.0
|
||||||
|
*/
|
||||||
public class Main extends Application {
|
public class Main extends Application {
|
||||||
/**
|
/**
|
||||||
* JavaFX opening method. Creates the stage and bootstraps the application.
|
* JavaFX opening method. Creates the stage and bootstraps the application.
|
||||||
|
@ -1,3 +1,8 @@
|
|||||||
|
/**
|
||||||
|
* The main module for the program. Required to launch to JavaFX as well as bundle into a native binary.
|
||||||
|
* @author shrapnelnet admin@shr4pnel.com
|
||||||
|
* @since 1.0.0
|
||||||
|
*/
|
||||||
module libremines {
|
module libremines {
|
||||||
requires javafx.controls;
|
requires javafx.controls;
|
||||||
requires javafx.fxml;
|
requires javafx.fxml;
|
||||||
|
Loading…
x
Reference in New Issue
Block a user