diff --git a/APED/app/src/main/java/com/example/aped/MainActivity.java b/APED/app/src/main/java/com/example/aped/MainActivity.java index 5c7a1b7..568fe9b 100644 --- a/APED/app/src/main/java/com/example/aped/MainActivity.java +++ b/APED/app/src/main/java/com/example/aped/MainActivity.java @@ -42,6 +42,10 @@ import java.io.FileOutputStream; import java.io.InputStream; import static android.content.pm.PackageManager.PERMISSION_GRANTED; +/** + * The {@link MainActivity} of the application. + * @author Marius Brölemann & Paul Lödige + */ public class MainActivity extends AppCompatActivity { /** permission code for the storage permisson.*/ private static final int STORAGE_PERMISSION_CODE = 42; diff --git a/APED/app/src/main/java/com/example/aped/communication/Communicator.java b/APED/app/src/main/java/com/example/aped/communication/Communicator.java index d9012aa..0e74634 100644 --- a/APED/app/src/main/java/com/example/aped/communication/Communicator.java +++ b/APED/app/src/main/java/com/example/aped/communication/Communicator.java @@ -29,6 +29,7 @@ import java.io.IOException; /** * Class that handles communication with the raspberry pi. + * @author Paul Lödige */ public class Communicator { diff --git a/APED/app/src/main/java/com/example/aped/communication/FileOutputVolleyRequest.java b/APED/app/src/main/java/com/example/aped/communication/FileOutputVolleyRequest.java index ab108a9..00009a2 100644 --- a/APED/app/src/main/java/com/example/aped/communication/FileOutputVolleyRequest.java +++ b/APED/app/src/main/java/com/example/aped/communication/FileOutputVolleyRequest.java @@ -20,6 +20,7 @@ import java.util.Map; /** * Custom {@link Request} to send xml files to the raspberry pi. + * @author Paul Lödige */ public class FileOutputVolleyRequest extends Request { diff --git a/APED/app/src/main/java/com/example/aped/communication/InputStreamVolleyRequest.java b/APED/app/src/main/java/com/example/aped/communication/InputStreamVolleyRequest.java index 090a2c1..cd18d23 100644 --- a/APED/app/src/main/java/com/example/aped/communication/InputStreamVolleyRequest.java +++ b/APED/app/src/main/java/com/example/aped/communication/InputStreamVolleyRequest.java @@ -10,6 +10,7 @@ import java.util.Map; /** * Custom {@link Request} to enable recieving files from the raspberry pi. * Credit: https://mobikul.com/downloading-files-using-volley/ + * @author Paul Lödige */ public class InputStreamVolleyRequest extends Request { diff --git a/APED/app/src/main/java/com/example/aped/ui/all_IOs/AllIOsFragment.java b/APED/app/src/main/java/com/example/aped/ui/all_IOs/AllIOsFragment.java index 78cc8b4..1c47379 100644 --- a/APED/app/src/main/java/com/example/aped/ui/all_IOs/AllIOsFragment.java +++ b/APED/app/src/main/java/com/example/aped/ui/all_IOs/AllIOsFragment.java @@ -12,7 +12,10 @@ import com.example.aped.R; import com.example.aped.ui.visualization.MainListViewAdapter; - +/** + * Fragment for displaying all the current data available. + * @author Marius Brölemann + */ public class AllIOsFragment extends Fragment { /** Include the MainActivity.*/ private MainActivity mainActivity; diff --git a/APED/app/src/main/java/com/example/aped/ui/favorite_IOs/FavoriteIOsFragment.java b/APED/app/src/main/java/com/example/aped/ui/favorite_IOs/FavoriteIOsFragment.java index 42d0c2b..4cd8a6d 100644 --- a/APED/app/src/main/java/com/example/aped/ui/favorite_IOs/FavoriteIOsFragment.java +++ b/APED/app/src/main/java/com/example/aped/ui/favorite_IOs/FavoriteIOsFragment.java @@ -13,6 +13,10 @@ import com.example.aped.MainActivity; import com.example.aped.R; import com.example.aped.ui.visualization.MainListViewAdapter; +/** + * Fragment for displaying the data chosen by the user. + * @author Marius Brölemann + */ public class FavoriteIOsFragment extends Fragment { /** Include the MainActivity.*/ private MainActivity mainActivity; diff --git a/APED/app/src/main/java/com/example/aped/ui/plots/PlotFragment.java b/APED/app/src/main/java/com/example/aped/ui/plots/PlotFragment.java index 48b34fb..e3ee92d 100644 --- a/APED/app/src/main/java/com/example/aped/ui/plots/PlotFragment.java +++ b/APED/app/src/main/java/com/example/aped/ui/plots/PlotFragment.java @@ -22,6 +22,10 @@ import java.util.ArrayList; import java.util.List; import java.util.Random; +/** + * Fragment for displaying the buffered data. + * @author Marius Brölemann & Paul Lödige + */ public class PlotFragment extends Fragment { /** Include the MainActivity.*/ diff --git a/APED/app/src/main/java/com/example/aped/ui/visualization/MainListViewAdapter.java b/APED/app/src/main/java/com/example/aped/ui/visualization/MainListViewAdapter.java index 4fac387..380d510 100644 --- a/APED/app/src/main/java/com/example/aped/ui/visualization/MainListViewAdapter.java +++ b/APED/app/src/main/java/com/example/aped/ui/visualization/MainListViewAdapter.java @@ -12,7 +12,10 @@ import com.example.aped.R; import java.util.ArrayList; import java.util.List; - +/** + * List View Adapter for the Main List View. + * @author Marius Brölemann + */ public class MainListViewAdapter extends BaseAdapter { /** Include the MainActivity.*/ private MainActivity mainActivity; diff --git a/APED/app/src/main/java/com/example/aped/ui/visualization/PinView.java b/APED/app/src/main/java/com/example/aped/ui/visualization/PinView.java index a86e9d5..57b163b 100644 --- a/APED/app/src/main/java/com/example/aped/ui/visualization/PinView.java +++ b/APED/app/src/main/java/com/example/aped/ui/visualization/PinView.java @@ -15,6 +15,10 @@ import org.json.JSONObject; import java.util.ArrayList; import java.util.List; +/** + * Linear Layout for displaying single GPIO pin information. + * @author Marius Brölemann + */ public class PinView { /** Include the MainActivity.*/ private MainActivity mainActivity; 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 19d1da4..85b27fd 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 @@ -18,6 +18,7 @@ import java.util.List; /** * handles the read and write operations for the configuration file. + * @author Paul Lödige */ public class ConfigurationHandler implements IFAVORITES { diff --git a/APED/app/src/main/java/com/example/aped/utils/ExternalStorageHandler.java b/APED/app/src/main/java/com/example/aped/utils/ExternalStorageHandler.java index 886478b..c7aea06 100644 --- a/APED/app/src/main/java/com/example/aped/utils/ExternalStorageHandler.java +++ b/APED/app/src/main/java/com/example/aped/utils/ExternalStorageHandler.java @@ -8,6 +8,7 @@ import java.io.FileNotFoundException; /** * Utility for getting information related to the external storage. + * @author Paul Lödige */ public final class ExternalStorageHandler { diff --git a/APED/app/src/main/java/com/example/aped/utils/IFAVORITES.java b/APED/app/src/main/java/com/example/aped/utils/IFAVORITES.java index 8e5eca6..a248bcc 100644 --- a/APED/app/src/main/java/com/example/aped/utils/IFAVORITES.java +++ b/APED/app/src/main/java/com/example/aped/utils/IFAVORITES.java @@ -4,6 +4,7 @@ import java.util.List; /** * Interface for managing the favorites. + * @author Paul Lödige */ public interface IFAVORITES { diff --git a/APED/app/src/main/java/com/example/aped/utils/IXML.java b/APED/app/src/main/java/com/example/aped/utils/IXML.java index c825bfe..fab7d53 100644 --- a/APED/app/src/main/java/com/example/aped/utils/IXML.java +++ b/APED/app/src/main/java/com/example/aped/utils/IXML.java @@ -3,6 +3,10 @@ package com.example.aped.utils; import java.util.Dictionary; import java.util.List; +/** + * Interface for accessing the configurations from the XML files. + * @author Paul Lödige + */ public interface IXML { /** diff --git a/APED/app/src/test/java/com/example/aped/XMLHandlerUnitTest.java b/APED/app/src/test/java/com/example/aped/XMLHandlerUnitTest.java index 4c8fcbe..94f608a 100644 --- a/APED/app/src/test/java/com/example/aped/XMLHandlerUnitTest.java +++ b/APED/app/src/test/java/com/example/aped/XMLHandlerUnitTest.java @@ -14,10 +14,17 @@ import javax.xml.parsers.ParserConfigurationException; import static org.junit.Assert.*; +/** + * Unit Test for the {@link XMLHandler}. + * @author Paul Lödige + */ public class XMLHandlerUnitTest { private String xmlPath="src/main/assets/XML/Test.xml"; private File xmlFile = new File(xmlPath); + /** + * Test to test the test xml file for validity. + */ @Test public void TestFiles_AreValid(){ try{ @@ -28,6 +35,9 @@ public class XMLHandlerUnitTest { } } + /** + * Test for reading the device names from the test xml file. + */ @Test public void Test_getDeviceNames(){ XMLHandler xmlHandler = new XMLHandler(xmlFile); @@ -35,6 +45,9 @@ public class XMLHandlerUnitTest { assertArrayEquals(new String[]{"example","PWM_example","sensorarray"},deviceNames.toArray()); } + /** + * Test for reading the port info for the example device. + */ @Test public void TestInput_SimplePort(){ XMLHandler xmlHandler = new XMLHandler(xmlFile); @@ -42,6 +55,9 @@ public class XMLHandlerUnitTest { assertEquals("{pins=[GPIO_2], frequency=, protocol=DI}",port.toString()); } + /** + * Test for reading the port info for the sensorarray device. + */ @Test public void TestInput_ComplexPort(){ XMLHandler xmlHandler = new XMLHandler(xmlFile); @@ -49,6 +65,9 @@ public class XMLHandlerUnitTest { assertEquals("{pins=[GPIO_3, GPIO_4, GPIO_5, GPIO_6], frequency=, protocol=DI}",port.toString()); } + /** + * Test for reading the buffer size for the PWM_example device. + */ @Test public void TestInput_BufferSize(){ XMLHandler xmlHandler = new XMLHandler(xmlFile); @@ -56,6 +75,9 @@ public class XMLHandlerUnitTest { assertEquals(1000,bufferSize); } + /** + * Test for reading the buffer size for the example device. + */ @Test public void TestInput_NoBufferSize(){ XMLHandler xmlHandler = new XMLHandler(xmlFile);