Added doc for javadoc

Signed-off-by: lubenard <lubenard@student.42.fr>
lubenard · Mar 3, 2024 · 4616116 · 4616116
1 parent 63306b9
commit 4616116
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/app/src/main/java/com/lubenard/oring_reminder/managers/BackupRestoreManager.java b/app/src/main/java/com/lubenard/oring_reminder/managers/BackupRestoreManager.java
@@ -77,7 +77,7 @@ private void startBackupIntoCSV() {
 
     /**
      * Start the file chooser intent
-     * @param dataToFileChooser
+     * @param dataToFileChooser launch given intent. Might be to create new file / select existing file
      */
     private void launchIntent(Intent dataToFileChooser) {
         try {

diff --git a/app/src/main/java/com/lubenard/oring_reminder/ui/adapters/CustomSpermoListAdapter.java b/app/src/main/java/com/lubenard/oring_reminder/ui/adapters/CustomSpermoListAdapter.java
@@ -16,7 +16,7 @@
 
 public class CustomSpermoListAdapter extends RecyclerView.Adapter<SpermoListViewHolder> {
 
-    private ArrayList<Spermograms> entryList;
+    private final ArrayList<Spermograms> entryList;
 
     private Context context;
     private onListItemClickListener onListItemClickListener;

diff --git a/app/src/main/java/com/lubenard/oring_reminder/utils/CsvWriter.java b/app/src/main/java/com/lubenard/oring_reminder/utils/CsvWriter.java
@@ -13,7 +13,7 @@ public class CsvWriter {
 
     /**
      * Constructor
-     * @param outputFileStream
+     * @param outputFileStream stream to output to
      */
     public CsvWriter(OutputStream outputFileStream) {
         fileWriter = new OutputStreamWriter(outputFileStream, StandardCharsets.UTF_8);
@@ -22,7 +22,7 @@ public CsvWriter(OutputStream outputFileStream) {
     /**
      * Write colum names
      * @param names column's name
-     * @throws IOException
+     * @throws IOException if error happens during write
      */
     public void writeColumnsName(String[] names) throws IOException {
         if (fileWriter != null) {