Doxygen documentation for RishkaVM::ensureSystemDirectories()

nthnn · May 13, 2024 · 24c6613 · 24c6613
1 parent a994cdb
commit 24c6613
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/src/rishka_vm.h b/src/rishka_vm.h
@@ -274,6 +274,17 @@ class RishkaVM final {
      */
     String getWorkingDirectory();
 
+    /**
+     * @brief Ensures the existence of system directories on the SD card.
+     *
+     * This method creates essential system directories such as /bin, /home, /etc, /man, and /tmp
+     * on the SD card if they do not already exist.
+     *
+     * The system directories are crucial for organizing and managing files and resources used by
+     * the Rishka virtual machine.
+     *
+     * @note If the directories already exist, this method does nothing.
+     */
     void ensureSystemDirectories();
 
     /**