Add documentation to chrootdir

MEGA65 · Sep 7, 2024 · 78318a0 · 78318a0
1 parent 7e5ec53
commit 78318a0
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/include/mega65/fileio.h b/include/mega65/fileio.h
@@ -75,7 +75,8 @@ chdir(char* filename);
 
 /**
  * @brief Change working directory to the root directory
- * @return Error code (currently unused)
+ * @return Error code from `hyppo_selectdrive`. 128 = no such drive.
+ * @todo Should probably be deprecated in favor of `cdrootdir()` to better reflect hyppo naming.
  */
 #ifdef __clang__
 __attribute__((leaf))