From d34673990b5176c7ab71c239694737a9ac8df14e Mon Sep 17 00:00:00 2001 From: Emmanuel Gil Peyrot Date: Sat, 27 Sep 2014 19:09:04 +0000 Subject: 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.h | 2 +- src/core/file_sys/file_romfs.cpp | 2 +- src/core/file_sys/file_romfs.h | 2 +- src/core/file_sys/file_sdmc.cpp | 23 +++++++++++++++++++++++ src/core/file_sys/file_sdmc.h | 2 +- 7 files changed, 35 insertions(+), 4 deletions(-) diff --git a/src/core/file_sys/archive_sdmc.cpp b/src/core/file_sys/archive_sdmc.cpp index 30d33be5..8d082738 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 946f8b95..f68648e6 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.h b/src/core/file_sys/file.h index f7b009f5..3749e4fc 100644 --- a/src/core/file_sys/file.h +++ b/src/core/file_sys/file.h @@ -31,8 +31,8 @@ public: * 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) + * @param buffer Buffer to read data from * @return Number of bytes written */ virtual size_t Write(const u64 offset, const u32 length, const u32 flush, const u8* buffer) const = 0; diff --git a/src/core/file_sys/file_romfs.cpp b/src/core/file_sys/file_romfs.cpp index 00f3c2ea..0709e98f 100644 --- a/src/core/file_sys/file_romfs.cpp +++ b/src/core/file_sys/file_romfs.cpp @@ -32,8 +32,8 @@ size_t File_RomFS::Read(const u64 offset, const u32 length, u8* buffer) const { * 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) + * @param buffer Buffer to read data from * @return Number of bytes written */ size_t File_RomFS::Write(const u64 offset, const u32 length, const u32 flush, const u8* buffer) const { diff --git a/src/core/file_sys/file_romfs.h b/src/core/file_sys/file_romfs.h index 5db43d4a..28b4f115 100644 --- a/src/core/file_sys/file_romfs.h +++ b/src/core/file_sys/file_romfs.h @@ -32,8 +32,8 @@ public: * 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) + * @param buffer Buffer to read data from * @return Number of bytes written */ size_t Write(const u64 offset, const u32 length, const u32 flush, const u8* buffer) const override; diff --git a/src/core/file_sys/file_sdmc.cpp b/src/core/file_sys/file_sdmc.cpp index 07951c9f..76e7f5d3 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 flush The flush parameters (0 == do not flush) + * @param buffer Buffer to read data from + * @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 static_cast(file->GetSize()); } +/** + * Close the file + * @return true if the file closed correctly + */ bool File_SDMC::Close() const { return file->Close(); } diff --git a/src/core/file_sys/file_sdmc.h b/src/core/file_sys/file_sdmc.h index b2e46f44..d2302049 100644 --- a/src/core/file_sys/file_sdmc.h +++ b/src/core/file_sys/file_sdmc.h @@ -35,8 +35,8 @@ public: * 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) + * @param buffer Buffer to read data from * @return Number of bytes written */ size_t Write(const u64 offset, const u32 length, const u32 flush, const u8* buffer) const override; -- cgit v1.2.3