From 0fafb3046e57543adf44092dfc3714d9d455fa26 Mon Sep 17 00:00:00 2001
From: Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
Date: Sat, 27 Sep 2014 19:09:04 +0000
Subject: [PATCH] FileSys: Add forgotten docstrings.

---
 src/core/file_sys/archive_sdmc.cpp |  4 ++++
 src/core/file_sys/archive_sdmc.h   |  4 ++++
 src/core/file_sys/file_sdmc.cpp    | 23 +++++++++++++++++++++++
 3 files changed, 31 insertions(+)

diff --git a/src/core/file_sys/archive_sdmc.cpp b/src/core/file_sys/archive_sdmc.cpp
index 30d33be5f..8d0827380 100644
--- a/src/core/file_sys/archive_sdmc.cpp
+++ b/src/core/file_sys/archive_sdmc.cpp
@@ -24,6 +24,10 @@ Archive_SDMC::Archive_SDMC(const std::string& mount_point) {
 Archive_SDMC::~Archive_SDMC() {
 }
 
+/**
+ * Initialize the archive.
+ * @return true if it initialized successfully
+ */
 bool Archive_SDMC::Initialize() {
     if (!FileUtil::IsDirectory(mount_point)) {
         WARN_LOG(FILESYS, "Directory %s not found, disabling SDMC.", mount_point.c_str());
diff --git a/src/core/file_sys/archive_sdmc.h b/src/core/file_sys/archive_sdmc.h
index 946f8b957..f68648e6f 100644
--- a/src/core/file_sys/archive_sdmc.h
+++ b/src/core/file_sys/archive_sdmc.h
@@ -20,6 +20,10 @@ public:
     Archive_SDMC(const std::string& mount_point);
     ~Archive_SDMC() override;
 
+    /**
+     * Initialize the archive.
+     * @return true if it initialized successfully
+     */
     bool Initialize();
 
     /**
diff --git a/src/core/file_sys/file_sdmc.cpp b/src/core/file_sys/file_sdmc.cpp
index 76adc6403..709c4cb17 100644
--- a/src/core/file_sys/file_sdmc.cpp
+++ b/src/core/file_sys/file_sdmc.cpp
@@ -39,11 +39,26 @@ File_SDMC::~File_SDMC() {
     Close();
 }
 
+/**
+ * Read data from the file
+ * @param offset Offset in bytes to start reading data from
+ * @param length Length in bytes of data to read from file
+ * @param buffer Buffer to read data into
+ * @return Number of bytes read
+ */
 size_t File_SDMC::Read(const u64 offset, const u32 length, u8* buffer) const {
     file->Seek(offset, SEEK_SET);
     return file->ReadBytes(buffer, length);
 }
 
+/**
+ * Write data to the file
+ * @param offset Offset in bytes to start writing data to
+ * @param length Length in bytes of data to write to file
+ * @param buffer Buffer to write data from
+ * @param flush The flush parameters (0 == do not flush)
+ * @return Number of bytes written
+ */
 size_t File_SDMC::Write(const u64 offset, const u32 length, const u32 flush, const u8* buffer) const {
     file->Seek(offset, SEEK_SET);
     size_t written = file->WriteBytes(buffer, length);
@@ -52,10 +67,18 @@ size_t File_SDMC::Write(const u64 offset, const u32 length, const u32 flush, con
     return written;
 }
 
+/**
+ * Get the size of the file in bytes
+ * @return Size of the file in bytes
+ */
 size_t File_SDMC::GetSize() const {
     return file->GetSize();
 }
 
+/**
+ * Close the file
+ * @return true if the file closed correctly
+ */
 bool File_SDMC::Close() const {
     return file->Close();
 }