Răsfoiți Sursa

loader: Amend Doxygen comments

These weren't adjusted when VFS was introduced
Lioncash 8 ani în urmă
părinte
comite
50d08beed2
2 a modificat fișierele cu 5 adăugiri și 5 ștergeri
  1. 2 2
      src/core/loader/loader.cpp
  2. 3 3
      src/core/loader/loader.h

+ 2 - 2
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) {

+ 3 - 3
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);