Merge pull request #719 from lioncash/docs
loader: Amend Doxygen comments
This commit is contained in:
commit
b5c77313de
|
@ -87,8 +87,8 @@ const char* GetFileTypeString(FileType type) {
|
||||||
* Get a loader for a file with a specific type
|
* Get a loader for a file with a specific type
|
||||||
* @param file The file to load
|
* @param file The file to load
|
||||||
* @param type The type of the file
|
* @param type The type of the file
|
||||||
* @param filename the file name (without path)
|
* @param file the file to retrieve the loader for
|
||||||
* @param filepath the file full path (with name)
|
* @param type the file type
|
||||||
* @return std::unique_ptr<AppLoader> a pointer to a loader object; nullptr for unsupported type
|
* @return std::unique_ptr<AppLoader> a pointer to a loader object; nullptr for unsupported type
|
||||||
*/
|
*/
|
||||||
static std::unique_ptr<AppLoader> GetFileLoader(FileSys::VirtualFile file, FileType type) {
|
static std::unique_ptr<AppLoader> GetFileLoader(FileSys::VirtualFile file, FileType type) {
|
||||||
|
|
|
@ -154,7 +154,7 @@ public:
|
||||||
/**
|
/**
|
||||||
* Get the RomFS of the application
|
* Get the RomFS of the application
|
||||||
* Since the RomFS can be huge, we return a file reference instead of copying to a buffer
|
* Since the RomFS can be huge, we return a file reference instead of copying to a buffer
|
||||||
* @param file The file containing the RomFS
|
* @param dir The directory containing the RomFS
|
||||||
* @return ResultStatus result of function
|
* @return ResultStatus result of function
|
||||||
*/
|
*/
|
||||||
virtual ResultStatus ReadRomFS(FileSys::VirtualFile& dir) {
|
virtual ResultStatus ReadRomFS(FileSys::VirtualFile& dir) {
|
||||||
|
@ -193,8 +193,8 @@ extern const std::initializer_list<Kernel::AddressMapping> default_address_mappi
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Identifies a bootable file and return a suitable loader
|
* Identifies a bootable file and return a suitable loader
|
||||||
* @param filename String filename of bootable file
|
* @param file The bootable file
|
||||||
* @return best loader for this file
|
* @return the best loader for this file
|
||||||
*/
|
*/
|
||||||
std::unique_ptr<AppLoader> GetLoader(FileSys::VirtualFile file);
|
std::unique_ptr<AppLoader> GetLoader(FileSys::VirtualFile file);
|
||||||
|
|
||||||
|
|
Reference in New Issue