mirror of
https://github.com/citra-emu/citra.git
synced 2024-11-23 04:30:10 +00:00
FileSys: Add forgotten docstrings.
This commit is contained in:
parent
ee7cfc71bd
commit
0fafb3046e
@ -24,6 +24,10 @@ Archive_SDMC::Archive_SDMC(const std::string& mount_point) {
|
|||||||
Archive_SDMC::~Archive_SDMC() {
|
Archive_SDMC::~Archive_SDMC() {
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initialize the archive.
|
||||||
|
* @return true if it initialized successfully
|
||||||
|
*/
|
||||||
bool Archive_SDMC::Initialize() {
|
bool Archive_SDMC::Initialize() {
|
||||||
if (!FileUtil::IsDirectory(mount_point)) {
|
if (!FileUtil::IsDirectory(mount_point)) {
|
||||||
WARN_LOG(FILESYS, "Directory %s not found, disabling SDMC.", mount_point.c_str());
|
WARN_LOG(FILESYS, "Directory %s not found, disabling SDMC.", mount_point.c_str());
|
||||||
|
@ -20,6 +20,10 @@ public:
|
|||||||
Archive_SDMC(const std::string& mount_point);
|
Archive_SDMC(const std::string& mount_point);
|
||||||
~Archive_SDMC() override;
|
~Archive_SDMC() override;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initialize the archive.
|
||||||
|
* @return true if it initialized successfully
|
||||||
|
*/
|
||||||
bool Initialize();
|
bool Initialize();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -39,11 +39,26 @@ File_SDMC::~File_SDMC() {
|
|||||||
Close();
|
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 {
|
size_t File_SDMC::Read(const u64 offset, const u32 length, u8* buffer) const {
|
||||||
file->Seek(offset, SEEK_SET);
|
file->Seek(offset, SEEK_SET);
|
||||||
return file->ReadBytes(buffer, length);
|
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 {
|
size_t File_SDMC::Write(const u64 offset, const u32 length, const u32 flush, const u8* buffer) const {
|
||||||
file->Seek(offset, SEEK_SET);
|
file->Seek(offset, SEEK_SET);
|
||||||
size_t written = file->WriteBytes(buffer, length);
|
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;
|
return written;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the size of the file in bytes
|
||||||
|
* @return Size of the file in bytes
|
||||||
|
*/
|
||||||
size_t File_SDMC::GetSize() const {
|
size_t File_SDMC::GetSize() const {
|
||||||
return file->GetSize();
|
return file->GetSize();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Close the file
|
||||||
|
* @return true if the file closed correctly
|
||||||
|
*/
|
||||||
bool File_SDMC::Close() const {
|
bool File_SDMC::Close() const {
|
||||||
return file->Close();
|
return file->Close();
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user