Просмотр исходного кода

Loader: Don’t duplicate the docstring into the cpp file.

Emmanuel Gil Peyrot 11 лет назад
Родитель
Сommit
43e699d849
4 измененных файлов с 0 добавлено и 56 удалено
  1. 0 4
      src/core/loader/3dsx.cpp
  2. 0 6
      src/core/loader/elf.cpp
  3. 0 5
      src/core/loader/loader.cpp
  4. 0 41
      src/core/loader/ncch.cpp

+ 0 - 4
src/core/loader/3dsx.cpp

@@ -213,10 +213,6 @@ AppLoader_THREEDSX::AppLoader_THREEDSX(const std::string& filename) : filename(f
 AppLoader_THREEDSX::~AppLoader_THREEDSX() {
 }
 
-/**
-* Loads a 3DSX file
-* @return Success on success, otherwise Error
-*/
 ResultStatus AppLoader_THREEDSX::Load() {
     LOG_INFO(Loader, "Loading 3DSX file %s...", filename.c_str());
     FileUtil::IOFile file(filename, "rb");

+ 0 - 6
src/core/loader/elf.cpp

@@ -339,12 +339,6 @@ AppLoader_ELF::AppLoader_ELF(const std::string& filename) : is_loaded(false) {
 AppLoader_ELF::~AppLoader_ELF() {
 }
 
-/**
- * Loads an NCCH file (e.g. from a CCI, or the first NCCH in a CXI)
- * @param error_string Pointer to string to put error message if an error has occurred
- * @todo Move NCSD parsing out of here and create a separate function for loading these
- * @return True on success, otherwise false
- */
 ResultStatus AppLoader_ELF::Load() {
     LOG_INFO(Loader, "Loading ELF file %s...", filename.c_str());
 

+ 0 - 5
src/core/loader/loader.cpp

@@ -53,11 +53,6 @@ FileType IdentifyFile(const std::string &filename) {
     return FileType::Unknown;
 }
 
-/**
- * Identifies and loads a bootable file
- * @param filename String filename of bootable file
- * @return ResultStatus result of function
- */
 ResultStatus LoadFile(const std::string& filename) {
     LOG_INFO(Loader, "Loading file %s...", filename.c_str());
 

+ 0 - 41
src/core/loader/ncch.cpp

@@ -113,10 +113,6 @@ AppLoader_NCCH::AppLoader_NCCH(const std::string& filename) {
 AppLoader_NCCH::~AppLoader_NCCH() {
 }
 
-/**
- * Loads .code section into memory for booting
- * @return ResultStatus result of function
- */
 ResultStatus AppLoader_NCCH::LoadExec() const {
     if (!is_loaded)
         return ResultStatus::ErrorNotLoaded;
@@ -130,12 +126,6 @@ ResultStatus AppLoader_NCCH::LoadExec() const {
     return ResultStatus::Error;
 }
 
-/**
- * Reads an application ExeFS section of an NCCH file into AppLoader (e.g. .code, .logo, etc.)
- * @param name Name of section to read out of NCCH file
- * @param buffer Vector to read data into
- * @return ResultStatus result of function
- */
 ResultStatus AppLoader_NCCH::LoadSectionExeFS(const char* name, std::vector<u8>& buffer) const {
     // Iterate through the ExeFs archive until we find the .code file...
     FileUtil::IOFile file(filename, "rb");
@@ -187,12 +177,6 @@ ResultStatus AppLoader_NCCH::LoadSectionExeFS(const char* name, std::vector<u8>&
     return ResultStatus::ErrorNotUsed;
 }
 
-/**
- * Loads an NCCH file (e.g. from a CCI, or the first NCCH in a CXI)
- * @param error_string Pointer to string to put error message if an error has occurred
- * @todo Move NCSD parsing out of here and create a separate function for loading these
- * @return True on success, otherwise false
- */
 ResultStatus AppLoader_NCCH::Load() {
     LOG_INFO(Loader, "Loading NCCH file %s...", filename.c_str());
 
@@ -248,47 +232,22 @@ ResultStatus AppLoader_NCCH::Load() {
     return ResultStatus::Error;
 }
 
-/**
- * Get the code (typically .code section) of the application
- * @param buffer Reference to buffer to store data
- * @return ResultStatus result of function
- */
 ResultStatus AppLoader_NCCH::ReadCode(std::vector<u8>& buffer) const {
     return LoadSectionExeFS(".code", buffer);
 }
 
-/**
- * Get the icon (typically icon section) of the application
- * @param buffer Reference to buffer to store data
- * @return ResultStatus result of function
- */
 ResultStatus AppLoader_NCCH::ReadIcon(std::vector<u8>& buffer) const {
     return LoadSectionExeFS("icon", buffer);
 }
 
-/**
- * Get the banner (typically banner section) of the application
- * @param buffer Reference to buffer to store data
- * @return ResultStatus result of function
- */
 ResultStatus AppLoader_NCCH::ReadBanner(std::vector<u8>& buffer) const {
     return LoadSectionExeFS("banner", buffer);
 }
 
-/**
- * Get the logo (typically logo section) of the application
- * @param buffer Reference to buffer to store data
- * @return ResultStatus result of function
- */
 ResultStatus AppLoader_NCCH::ReadLogo(std::vector<u8>& buffer) const {
     return LoadSectionExeFS("logo", buffer);
 }
 
-/**
- * Get the RomFS of the application
- * @param buffer Reference to buffer to store data
- * @return ResultStatus result of function
- */
 ResultStatus AppLoader_NCCH::ReadRomFS(std::vector<u8>& buffer) const {
     FileUtil::IOFile file(filename, "rb");
     if (file.IsOpen()) {