From 0faf25f00b8957d307c1858acbceceeaa8cd7bf0 Mon Sep 17 00:00:00 2001
From: paul-loedige <paul@gve-loedige.de>
Date: Thu, 7 Jan 2021 19:24:07 +0100
Subject: [PATCH] added documentation

---
 .../aped/utils/ConfigurationHandler.java      | 27 ++++++++++++++-----
 1 file changed, 20 insertions(+), 7 deletions(-)

diff --git a/APED/app/src/main/java/com/example/aped/utils/ConfigurationHandler.java b/APED/app/src/main/java/com/example/aped/utils/ConfigurationHandler.java
index 9c89348..cf8e85d 100644
--- a/APED/app/src/main/java/com/example/aped/utils/ConfigurationHandler.java
+++ b/APED/app/src/main/java/com/example/aped/utils/ConfigurationHandler.java
@@ -117,13 +117,20 @@ public class ConfigurationHandler implements IFAVORITES {
         return deviceName;
     }
 
-    //cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
+    /**
+     * Method to get the name of the current view.
+     * @return the name of the current view
+     */
     public String getCurrentView() {
         return configurations.getCurrentView();
     }
 
-    //cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
-    public String setCurrentView(String viewName) {
+    /**
+     * Method to set the name of the current view.
+     * @param viewName the name to be set
+     * @return the name that has been set
+     */
+    public String setCurrentView(final String viewName) {
         configurations.setCurrentView(viewName);
         writeJsonFile();
         return getCurrentView();
@@ -205,14 +212,20 @@ public class ConfigurationHandler implements IFAVORITES {
         /** The names of the favorite devices. **/
         private List<String> favoriteNames = new ArrayList<>();
 
-        //cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
+        /**
+         * Getter for currentView.
+         * @return the name of the current view
+         */
         public String getCurrentView() {
             return currentView;
         }
 
-        //cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
-        public void setCurrentView(String currentView) {
-            this.currentView = currentView;
+        /**
+         * Setter for currentView.
+         * @param pCurrentView the name of the current view
+         */
+        public void setCurrentView(final String pCurrentView) {
+            this.currentView = pCurrentView;
         }
 
         /** The name of the current view. **/