From af51ed63f32e553eb7cb915cc94fa8dd47f5a082 Mon Sep 17 00:00:00 2001 From: h7x4 Date: Mon, 26 Apr 2021 22:59:53 +0200 Subject: [PATCH] Update docs --- src/main/java/app/controllers/MenubarController.java | 2 +- src/main/java/app/controllers/ModelineController.java | 2 +- src/main/java/app/events/SaveFileEvent.java | 3 +++ src/main/java/app/service/FileOperations.java | 3 +++ src/main/java/app/service/FiletreeOperations.java | 3 +++ 5 files changed, 11 insertions(+), 2 deletions(-) diff --git a/src/main/java/app/controllers/MenubarController.java b/src/main/java/app/controllers/MenubarController.java index 4952a72..06f8c87 100644 --- a/src/main/java/app/controllers/MenubarController.java +++ b/src/main/java/app/controllers/MenubarController.java @@ -35,7 +35,7 @@ import javafx.scene.control.ToggleGroup; import javafx.stage.Stage; /** - * A FXML controller that controls the menubar component of the UI + * A FXML controller that controls the MenuBar */ public class MenubarController implements Initializable, Controller { diff --git a/src/main/java/app/controllers/ModelineController.java b/src/main/java/app/controllers/ModelineController.java index fc1cd6f..2c8df1f 100644 --- a/src/main/java/app/controllers/ModelineController.java +++ b/src/main/java/app/controllers/ModelineController.java @@ -15,7 +15,7 @@ import javafx.fxml.Initializable; import javafx.scene.control.Label; /** - * A FXML controller that controls the modeline component of the UI + * A FXML controller that controls the Modeline */ public class ModelineController implements Initializable, Controller { diff --git a/src/main/java/app/events/SaveFileEvent.java b/src/main/java/app/events/SaveFileEvent.java index 6dd19e6..8c05fce 100644 --- a/src/main/java/app/events/SaveFileEvent.java +++ b/src/main/java/app/events/SaveFileEvent.java @@ -2,6 +2,9 @@ package app.events; import app.model.Model; +/** + * Event signalizing that the current file should be saved to disk + */ public class SaveFileEvent extends Event { private boolean isNewFile; diff --git a/src/main/java/app/service/FileOperations.java b/src/main/java/app/service/FileOperations.java index 2e150f7..7be4290 100644 --- a/src/main/java/app/service/FileOperations.java +++ b/src/main/java/app/service/FileOperations.java @@ -11,6 +11,9 @@ import java.util.Scanner; import app.model.Model; import javafx.stage.Stage; +/** + * A class containing operations and logic for choosing, reading and writing to files. + */ public class FileOperations { private FileOperations() {} diff --git a/src/main/java/app/service/FiletreeOperations.java b/src/main/java/app/service/FiletreeOperations.java index 5be3087..1f3458c 100644 --- a/src/main/java/app/service/FiletreeOperations.java +++ b/src/main/java/app/service/FiletreeOperations.java @@ -16,6 +16,9 @@ import javafx.scene.control.TreeItem; import javafx.scene.image.Image; import javafx.scene.image.ImageView; +/** + * A class containing operations for handling files withing a GUI filetree + */ public class FiletreeOperations { private static int iconSize = 20;