aboutsummaryrefslogtreecommitdiff
path: root/src/core/loader
diff options
context:
space:
mode:
authorbunnei <bunneidev@gmail.com>2018-07-19 16:11:09 -0700
committerGitHub <noreply@github.com>2018-07-19 16:11:09 -0700
commitfdf72b6b60a4905c8c855ee7dd6a72a3b65aa906 (patch)
tree26dedf2326e99a0180aa97053a83704dbcbb0d4b /src/core/loader
parentb4e1375e78daf24ce84c150df2fbc58ff06a5b66 (diff)
parentebefc0f0808cc84cf457f1296f778f3f895f52da (diff)
Merge pull request #719 from lioncash/docs
loader: Amend Doxygen comments
Diffstat (limited to 'src/core/loader')
-rw-r--r--src/core/loader/loader.cpp4
-rw-r--r--src/core/loader/loader.h6
2 files changed, 5 insertions, 5 deletions
diff --git a/src/core/loader/loader.cpp b/src/core/loader/loader.cpp
index 1574345a17..e70f376777 100644
--- a/src/core/loader/loader.cpp
+++ b/src/core/loader/loader.cpp
@@ -87,8 +87,8 @@ const char* GetFileTypeString(FileType type) {
* Get a loader for a file with a specific type
* @param file The file to load
* @param type The type of the file
- * @param filename the file name (without path)
- * @param filepath the file full path (with name)
+ * @param file the file to retrieve the loader for
+ * @param type the file 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) {
diff --git a/src/core/loader/loader.h b/src/core/loader/loader.h
index 1da9e8099f..6f517ca8c2 100644
--- a/src/core/loader/loader.h
+++ b/src/core/loader/loader.h
@@ -154,7 +154,7 @@ public:
/**
* Get the RomFS of the application
* 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
*/
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
- * @param filename String filename of bootable file
- * @return best loader for this file
+ * @param file The bootable file
+ * @return the best loader for this file
*/
std::unique_ptr<AppLoader> GetLoader(FileSys::VirtualFile file);