From 527e27525d2e793c010b323dd37027e2584f9727 Mon Sep 17 00:00:00 2001 From: Robin Jones Date: Tue, 5 Nov 2024 23:10:29 +0000 Subject: [PATCH] Further header documentation improvements --- src/flashcart/64drive/README.md | 2 +- src/flashcart/sc64/README.md | 2 +- src/menu/disk_info.h | 12 +++++++++++- 3 files changed, 13 insertions(+), 3 deletions(-) diff --git a/src/flashcart/64drive/README.md b/src/flashcart/64drive/README.md index 6809afcc..6c6859c0 100644 --- a/src/flashcart/64drive/README.md +++ b/src/flashcart/64drive/README.md @@ -1,4 +1,4 @@ -## 64drive developer notes +# 64drive developer notes ### Official documentation diff --git a/src/flashcart/sc64/README.md b/src/flashcart/sc64/README.md index 5071466f..fe313411 100644 --- a/src/flashcart/sc64/README.md +++ b/src/flashcart/sc64/README.md @@ -1,4 +1,4 @@ -## SummerCart64 developer notes +# SummerCart64 developer notes ### Official documentation diff --git a/src/menu/disk_info.h b/src/menu/disk_info.h index fe5175ec..656768ff 100644 --- a/src/menu/disk_info.h +++ b/src/menu/disk_info.h @@ -52,7 +52,17 @@ typedef struct { } disk_info_t; +/** + * @brief Loads disk information from the specified path. + * + * This function reads the disk information from the given path and populates + * the provided disk_info structure with the relevant data. + * + * @param path A pointer to a path_t structure that specifies the path to the disk. + * @param disk_info A pointer to a disk_info_t structure where the disk information will be stored. + * @return A disk_err_t value indicating the success or failure of the operation. + */ disk_err_t disk_info_load (path_t *path, disk_info_t *disk_info); -#endif +#endif /* DISK_INFO_H__ */