mirror of
				https://github.com/PabloMK7/citra.git
				synced 2025-10-31 13:50:03 +00:00 
			
		
		
		
	FileSys: Add forgotten docstrings.
This commit is contained in:
		
							parent
							
								
									44dabd0dec
								
							
						
					
					
						commit
						d34673990b
					
				
					 7 changed files with 35 additions and 4 deletions
				
			
		|  | @ -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()); | ||||
|  |  | |||
|  | @ -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(); | ||||
| 
 | ||||
|     /**
 | ||||
|  |  | |||
|  | @ -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; | ||||
|  |  | |||
|  | @ -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 { | ||||
|  |  | |||
|  | @ -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; | ||||
|  |  | |||
|  | @ -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<size_t>(file->GetSize()); | ||||
| } | ||||
| 
 | ||||
| /**
 | ||||
|  * Close the file | ||||
|  * @return true if the file closed correctly | ||||
|  */ | ||||
| bool File_SDMC::Close() const { | ||||
|     return file->Close(); | ||||
| } | ||||
|  |  | |||
|  | @ -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; | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue