VFS comments

Author: pschatzmann

src/AudioTools/Disk/VFS.h

@@ -3,8 +3,11 @@
 namespace audio_tools {
 
 /***
- * Base class which represents an ESP32 Virtual File System. After initializing
+ * @brief Abstract Base class which represents an ESP32 Virtual File System. After initializing
  * the VFS the regular c file operations are supported.
+ * @ingroup player
+ * @author Phil Schatzmann
+ * @copyright GPLv3
  */
 class VFS {
  public:

src/AudioTools/Disk/VFSFile.h

@@ -25,6 +25,7 @@ enum SeekMode { SeekSet = 0, SeekCur = 1, SeekEnd = 2 };
 /**
  * @brief Arduino File support using std::fstream
  * @author Phil Schatzmann
+ * @ingroup player
  * @copyright GPLv3
  */
 class VFSFile : public Stream {
@@ -177,6 +178,7 @@ class VFSFile : public Stream {
 /**
  * @brief Eumlate FS using C++ or Posix functions
  * @author Phil Schatzmann
+ * @ingroup player
  * @copyright GPLv3
  */
 class VFS_SDClass {

src/AudioTools/Disk/VFS_LittleFS.h

@@ -11,11 +11,9 @@
 namespace audio_tools {
 
 /**
- * @brief ESP32 Virtual File System for SPI SD. The default mount point is "/littlefs"
- * 
+ * @brief ESP32 Virtual File System for the LittleFS. The default mount point is "/littlefs"
  * DRAFT implementation: not tested
- * See
- * https://github.com/espressif/esp-idf/tree/master/examples/storage/sd_card/sdspi
+ * See https://github.com/espressif/esp-idf/tree/master/examples/storage/sd_card/sdspi
  * @ingroup player
  * @author Phil Schatzmann
  * @copyright GPLv3

src/AudioTools/Disk/VFS_SDMMC.h

@@ -37,10 +37,8 @@ namespace audio_tools {
 
 /**
  * @brief ESP32 Virtual File System for SDMMC. The default mount point is "/sdcard"
- * 
  * DRAFT implementation: not tested
- * see
- * https://github.com/espressif/esp-idf/blob/master/examples/storage/sd_card/sdmmc/README.md
+ * see https://github.com/espressif/esp-idf/blob/master/examples/storage/sd_card/sdmmc/README.md
  * @ingroup player
  * @author Phil Schatzmann
  * @copyright GPLv3

src/AudioTools/Disk/VFS_SDSPI.h

@@ -30,7 +30,6 @@ namespace audio_tools {
 
 /**
  * @brief ESP32 Virtual File System for SPI SD. The default mount point is "/sdcard"
- * 
  * DRAFT implementation: not tested
  * See https://github.com/espressif/esp-idf/tree/master/examples/storage/sd_card/sdspi
  * @ingroup player

src/AudioTools/Disk/VFS_SPFFS.h

@@ -10,11 +10,9 @@
 namespace audio_tools {
 
 /**
- * @brief ESP32 Virtual File System for SPI SD. The default mount point is "/spiffs"
- * 
+ * @brief ESP32 Virtual File System for the SPFFS. The default mount point is "/spiffs"
  * DRAFT implementation: not tested
- * See
- * https://github.com/espressif/esp-idf/tree/master/examples/storage/sd_card/sdspi
+ * See https://github.com/espressif/esp-idf/tree/master/examples/storage/sd_card/sdspi
  * @ingroup player
  * @author Phil Schatzmann
  * @copyright GPLv3