fixed javadoc comments according to specs

Author: cristidragomir97

Diff for: src/Folder.cpp

@@ -264,18 +264,7 @@ bool Folder::moveTo(Folder destination, bool overwrite) {
 bool Folder::moveTo(const char* destination, bool overwrite) {
     std::string newPath = replaceFirstPathComponent(this->path.c_str(), destination);
 
-/*
-    DIR* dir = opendir(newPath.c_str());
-    if (dir != nullptr) {
-        if(!overwrite){
-            errno = EEXIST;
-            return false;
-        } else {
-            closedir(dir);
-            Folder(newPath.c_str()).remove();
-        }
-    }
-    */
+
 
     if (!this->copyTo(destination, overwrite)) {
         return false; // Return false if the copy operation fails

Diff for: src/Folder.h

@@ -14,144 +14,144 @@ class UFile;
 class Folder {
 
   public:
-    /*
+    /**
      * @brief Blank Constructor.
      */
     Folder();
 
-    /*
+    /**
      * @brief Constructor.
      * @param const char * dirname - The name of the directory.
      */
     Folder(const char * dirname);
 
-    /*
+    /**
      * @brief Constructor.
      * @param String dirname - The name of the directory.
      */
     Folder(String dirname);
 
-    /*
+    /**
      * @brief Creates a file inside the directory.
      * @param const char * fileName - The name of the file to create.
      * @return A File object if successfull, NULL if not. 
      */
     UFile createFile(const char * fileName, FileMode fmode);
 
-   /*
+    /**
      * @brief Creates a file inside the directory.
      * @param String fileName - The name of the file to create.
      * @return A File object if successfull, NULL if not. 
      */
     UFile createFile(String fileName, FileMode fmode);
 
-    /*
+    /**
      * @brief Removes a directory.
      * @param dirname The name of the directory to remove.
      * @return True if the directory was removed successfully, false otherwise.
      */
     bool remove();
 
-    /*
+    /**
      * @brief Renames a directory.
      * @param const char * newDirname The new name of the directory.
      * @return True if the directory was renamed successfully, false otherwise.
      */
     bool rename(const char * newDirname);
 
-    /*
+    /**
      * @brief Renames a directory.
      * @param String newDirname The new name of the directory.
      * @return True if the directory was renamed successfully, false otherwise.
      */
     bool rename(String newDirname);
 
-    /*
+    /**
      * @brief Checks if the directory exists.
      * @return True if the directory exists, false otherwise.
      */
     bool exists();
 
-    /*
+    /**
      * @brief Returns the path of the file.
      * @return The path of the file as a const char * 
      */
     const char * getPath();
 
-    /*
+    /**
      * @brief Returns the path of the file.
      * @return The path of the file as an Arduino String
     */
     String getPathString();
 
-    /*
+    /**
      * @brief Creates a subfolder in the directory.
      * @param const char * subfolderName - he name of the subfolder to create.
      * @param overwrite - behaviour in case the folder already exists, default is false
      * @return The created subfolder.
     */
     Folder createSubfolder(const char * subfolderName, bool overwrite = false);
 
-    /*
+    /**
      * @brief Creates a subfolder in the directory.
      * @param String subfolderName - he name of the subfolder to create.
      * @param overwrite - behaviour in case the folder already exists, default is false
      * @return The created subfolder.
      */
     Folder createSubfolder(String subfolderName, bool overwrite = false);
 
-    /*
+    /**
      * @brief Returns File objects for all files in the current dirctory.
      * @return A std::vector of File objects representing the files in the directory.
      */
     std::vector<UFile> getFiles();
 
-   /*
+    /**
      * @brief Returns Folder objects for all files in the current dirctory.
      * @return A std::vector of Folder objects representing the files in the directory.
      */
     std::vector<Folder>  getFolders();
 
-    /*
+    /**
      * @brief Copies the current directory
      * @param Folder destination - a Folder object representing the destination
      * @return True upon success, false otherwise. 
      */
     bool copyTo(Folder destination, bool overwrite = false);
 
-    /*
+    /**
      * @brief Copies the current directory
      * @param const char * destination - the path of the destination location
      * @param overwrite - behaviour in case the folder already exists, default is false
      * @return True upon success, false otherwise. 
      */
     bool copyTo(const char * destination, bool overwrite = false);
 
-    /*
+    /**
      * @brief Copies the current directory
      * @param String destination - the path of the destination location
      * @param overwrite - behaviour in case the folder already exists, default is false
      * @return True upon success, false otherwise. 
      */
     bool copyTo(String destination, bool overwrite = false);
 
-    /*
+    /**
      * @brief Moves the current directory
      * @param Folder destination - a Folder object representing the destination
      * @param overwrite - behaviour in case the folder already exists, default is false
      * @return True upon success, false otherwise. 
      */
     bool moveTo(Folder destination, bool overwrite = false);
 
-    /*
+    /**
      * @brief Moves the current directory
      * @param const char * destination - the path of the destination location
      * @param overwrite - behaviour in case the folder already exists, default is false
      * @return True upon success, false otherwise. 
     */
     bool moveTo(const char * destination, bool overwrite = false);
 
-    /*
+    /**
      * @brief Move the current directory
      * @param String destination - the path of the destination location
      * @param overwrite - behaviour in case the folder already exists, default is false

Diff for: src/InternalStorage.h

@@ -10,7 +10,7 @@ class InternalStorage : public Arduino_UnifiedStorage {
 public:
     /**
      * Default constructor for the InternalStorage class.
-    */
+     */
     InternalStorage();
 
     /**
@@ -19,71 +19,71 @@ class InternalStorage : public Arduino_UnifiedStorage {
      * @param partition The partition number.
      * @param name The name of the partition.
      * @param fs The desired file system (FS_FAT or FS_LITTLEFS).
-    */
+     */
     InternalStorage(int partition, const char *name, FileSystems fs);
 
     /**
      * Initializes the internal storage.
      * 
      * @return 1 if successful, 0 if failed.
-    */
+     */
     int begin() override;
 
     /**
      * Initializes the internal storage with the specified file system.
      * 
      * @param fs The desired file system (FS_FAT or FS_LITTLEFS).
      * @return 1 if successful, 0 if failed.
-    */
+     */
     int begin(FileSystems fs) override;
 
     /**
      * Unmounts the internal storage.
      * 
      * @return 1 if successful, 0 if failed.
-    */
+     */
     int unmount() override;
 
     /**
      * Retrieves the root folder of the internal storage.
      * 
      * @return The root folder as a Folder object.
-    */
+     */
     Folder getRootFolder() override;
 
     /**
      * Sets the QSPI partition number.
      * 
      * @param partition The partition number.
-    */
+     */
     void setQSPIPartition(int partition);
 
     /**
      * Sets the QSPI partition name.
      * 
      * @param name The name of the partition.
-    */
+     */
     void setQSPIPartitionName(const char *name);
 
     /**
      * Formats the internal storage with the FAT file system.
      * 
      * @return 1 if successful, 0 if failed.
-    */
+     */
     int formatFAT();
 
     /**
      * Formats the internal storage with the LittleFS file system.
      * 
      * @return 1 if successful, 0 if failed.
-    */
+     */
     int formatLittleFS();
 
     /**
      * Retrieves the block device associated with the internal storage.
      * 
      * @return The block device as a BlockDevice object.
-    */
+     */
     #if defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_OPTA)
         mbed::BlockDevice *getBlockDevice();
     #endif

Diff for: src/SDStorage.h

@@ -13,37 +13,37 @@
 class SDStorage: public Arduino_UnifiedStorage  {
     public:
         /**
-        * Default constructor for the SDStorage class.
-        */
+         * Default constructor for the SDStorage class.
+         */
         SDStorage();
 
         /**
-        * Initializes the SD card storage.
-        * 
-        * @return 1 if successful, 0 if failed.
-        */
+         * Initializes the SD card storage.
+         * 
+         * @return 1 if successful, 0 if failed.
+         */
         int begin() override ;
 
         /**
          * Initializes the SD card storage with the specified file system.
          * 
          * @param fs The desired file system (FS_FAT or FS_LITTLEFS).
          * @return 1 if successful, 0 if failed.
-        */
+         */
         int begin(FileSystems fs) override;
 
         /**
          * Unmounts the SD card storage.
          * 
          * @return 1 if successful, 0 if failed.
-        */
+         */
         int unmount() override;
 
         /**
          * Retrieves the root folder of the SD card storage.
          * 
          * @return The root folder as a Folder object.
-        */
+         */
         Folder getRootFolder() override;
 
         /**
@@ -57,8 +57,7 @@ class SDStorage: public Arduino_UnifiedStorage  {
          * Formats the SD card storage with the LittleFS file system.
          * 
          * @return 1 if successful, 0 if failed.
-        */
-
+         */
         int formatLittleFS() override;
     private:
         FileSystems fs = FS_FAT;