From 237d93f38b85628972d8c22ae2172dc966eb7158 Mon Sep 17 00:00:00 2001
From: Johannes Schmelz <johannes.schmelz@unibw.de>
Date: Wed, 16 Oct 2024 20:44:56 +0200
Subject: [PATCH] completed documentation

---
 .../src/main/java/pp/battleship/client/gui/GameMusic.java | 3 +++
 .../java/pp/battleship/client/gui/Shell2DControl.java     | 8 ++++++++
 .../main/java/pp/battleship/client/gui/ShellControl.java  | 8 ++++++++
 .../java/pp/battleship/client/gui/SinkingControl.java     | 8 ++++++++
 4 files changed, 27 insertions(+)

diff --git a/Projekte/battleship/client/src/main/java/pp/battleship/client/gui/GameMusic.java b/Projekte/battleship/client/src/main/java/pp/battleship/client/gui/GameMusic.java
index 8b3c44e..29e305e 100644
--- a/Projekte/battleship/client/src/main/java/pp/battleship/client/gui/GameMusic.java
+++ b/Projekte/battleship/client/src/main/java/pp/battleship/client/gui/GameMusic.java
@@ -14,6 +14,9 @@ import com.jme3.asset.AssetNotFoundException;
 import com.jme3.audio.AudioData;
 import com.jme3.audio.AudioNode;
 
+/**
+ * Handles the background music beeing played. Is able to start and stop the music. Set the Volume of the Audio.
+ */
 public class GameMusic extends AbstractAppState{
     private static final Logger LOGGER = System.getLogger(GameMusic.class.getName());
     private static final Preferences PREFERENCES = getPreferences(GameMusic.class);
diff --git a/Projekte/battleship/client/src/main/java/pp/battleship/client/gui/Shell2DControl.java b/Projekte/battleship/client/src/main/java/pp/battleship/client/gui/Shell2DControl.java
index 93ae2ad..676a3ed 100644
--- a/Projekte/battleship/client/src/main/java/pp/battleship/client/gui/Shell2DControl.java
+++ b/Projekte/battleship/client/src/main/java/pp/battleship/client/gui/Shell2DControl.java
@@ -42,6 +42,14 @@ public class Shell2DControl extends AbstractControl {
         spatial.setLocalTranslation(viewPos.getX() + MapView.FIELD_SIZE / 2, viewPos.getY() + MapView.FIELD_SIZE / 2, 0);
     }
 
+    /**
+     * This method is called during the rendering phase, but it does not perform any
+     * operations in this implementation as the control only influences the spatial's
+     * transformation, not its rendering process.
+     *
+     * @param rm the RenderManager rendering the controlled Spatial (not null)
+     * @param vp the ViewPort being rendered (not null)
+     */
     @Override
     protected void controlRender(RenderManager rm, ViewPort vp) {
         // No rendering-specific behavior required for this control
diff --git a/Projekte/battleship/client/src/main/java/pp/battleship/client/gui/ShellControl.java b/Projekte/battleship/client/src/main/java/pp/battleship/client/gui/ShellControl.java
index a551f6a..361f4b7 100644
--- a/Projekte/battleship/client/src/main/java/pp/battleship/client/gui/ShellControl.java
+++ b/Projekte/battleship/client/src/main/java/pp/battleship/client/gui/ShellControl.java
@@ -43,6 +43,14 @@ public class ShellControl extends AbstractControl {
         spatial.rotate(PI/2,0,0);
     }
 
+    /**
+     * This method is called during the rendering phase, but it does not perform any
+     * operations in this implementation as the control only influences the spatial's
+     * transformation, not its rendering process.
+     *
+     * @param rm the RenderManager rendering the controlled Spatial (not null)
+     * @param vp the ViewPort being rendered (not null)
+     */
     @Override
     protected void controlRender(RenderManager rm, ViewPort vp) {
         // No rendering-specific behavior required for this control
diff --git a/Projekte/battleship/client/src/main/java/pp/battleship/client/gui/SinkingControl.java b/Projekte/battleship/client/src/main/java/pp/battleship/client/gui/SinkingControl.java
index 845d50e..8c0b497 100644
--- a/Projekte/battleship/client/src/main/java/pp/battleship/client/gui/SinkingControl.java
+++ b/Projekte/battleship/client/src/main/java/pp/battleship/client/gui/SinkingControl.java
@@ -46,6 +46,14 @@ class SinkingControl extends AbstractControl {
         }
     }
 
+    /**
+     * This method is called during the rendering phase, but it does not perform any
+     * operations in this implementation as the control only influences the spatial's
+     * transformation, not its rendering process.
+     *
+     * @param rm the RenderManager rendering the controlled Spatial (not null)
+     * @param vp the ViewPort being rendered (not null)
+     */
     @Override
     protected void controlRender(RenderManager rm, ViewPort vp) {
         // No rendering-related code needed