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

General: Fix up doxygen comments

Lioncash 11 лет назад
Родитель
Сommit
d3efa637b4

+ 3 - 4
src/core/hle/kernel/mutex.h

@@ -38,10 +38,9 @@ public:
     void Acquire() override;
     void Acquire() override;
 
 
     /**
     /**
-    * Acquires the specified mutex for the specified thread
-    * @param mutex Mutex that is to be acquired
-    * @param thread Thread that will acquire the mutex
-    */
+     * Acquires the specified mutex for the specified thread
+     * @param thread Thread that will acquire the mutex
+     */
     void Acquire(SharedPtr<Thread> thread);
     void Acquire(SharedPtr<Thread> thread);
     void Release();
     void Release();
 
 

+ 0 - 1
src/core/hle/kernel/semaphore.h

@@ -17,7 +17,6 @@ class Semaphore final : public WaitObject {
 public:
 public:
     /**
     /**
      * Creates a semaphore.
      * Creates a semaphore.
-     * @param handle Pointer to the handle of the newly created object
      * @param initial_count Number of slots reserved for other threads
      * @param initial_count Number of slots reserved for other threads
      * @param max_count Maximum number of slots the semaphore can have
      * @param max_count Maximum number of slots the semaphore can have
      * @param name Optional name of semaphore
      * @param name Optional name of semaphore

+ 0 - 1
src/core/hle/kernel/thread.h

@@ -57,7 +57,6 @@ public:
      * @param arg User data to pass to the thread
      * @param arg User data to pass to the thread
      * @param processor_id The ID(s) of the processors on which the thread is desired to be run
      * @param processor_id The ID(s) of the processors on which the thread is desired to be run
      * @param stack_top The address of the thread's stack top
      * @param stack_top The address of the thread's stack top
-     * @param stack_size The size of the thread's stack
      * @return A shared pointer to the newly created thread
      * @return A shared pointer to the newly created thread
      */
      */
     static ResultVal<SharedPtr<Thread>> Create(std::string name, VAddr entry_point, s32 priority,
     static ResultVal<SharedPtr<Thread>> Create(std::string name, VAddr entry_point, s32 priority,

+ 1 - 1
src/core/hle/service/fs/archive.h

@@ -87,7 +87,7 @@ ResultCode CloseArchive(ArchiveHandle handle);
 
 
 /**
 /**
  * Registers an Archive type, instances of which can later be opened using its IdCode.
  * Registers an Archive type, instances of which can later be opened using its IdCode.
- * @param backend File system backend interface to the archive
+ * @param factory File system backend interface to the archive
  * @param id_code Id code used to access this type of archive
  * @param id_code Id code used to access this type of archive
  */
  */
 ResultCode RegisterArchiveType(std::unique_ptr<FileSys::ArchiveFactory>&& factory, ArchiveIdCode id_code);
 ResultCode RegisterArchiveType(std::unique_ptr<FileSys::ArchiveFactory>&& factory, ArchiveIdCode id_code);

+ 1 - 1
src/core/loader/loader.cpp

@@ -50,7 +50,7 @@ static FileType IdentifyFile(FileUtil::IOFile& file) {
 
 
 /**
 /**
  * Guess the type of a bootable file from its extension
  * Guess the type of a bootable file from its extension
- * @param extension String extension of bootable file
+ * @param extension_ String extension of bootable file
  * @return FileType of file
  * @return FileType of file
  */
  */
 static FileType GuessFromExtension(const std::string& extension_) {
 static FileType GuessFromExtension(const std::string& extension_) {

+ 3 - 1
src/core/loader/ncch.h

@@ -209,7 +209,9 @@ public:
 
 
     /**
     /**
      * Get the RomFS of the application
      * Get the RomFS of the application
-     * @param buffer Reference to buffer to store data
+     * @param romfs_file Reference to buffer to store data
+     * @param offset     Offset in the file to the RomFS
+     * @param size       Size of the RomFS in bytes
      * @return ResultStatus result of function
      * @return ResultStatus result of function
      */
      */
     ResultStatus ReadRomFS(std::shared_ptr<FileUtil::IOFile>& romfs_file, u64& offset, u64& size) override;
     ResultStatus ReadRomFS(std::shared_ptr<FileUtil::IOFile>& romfs_file, u64& offset, u64& size) override;

+ 1 - 2
src/core/tracer/recorder.h

@@ -32,8 +32,7 @@ public:
 
 
     /**
     /**
      * Recorder constructor
      * Recorder constructor
-     * @param default_attributes Pointer to an array of 32-bit-aligned 24-bit floating point values.
-     * @param vs_float_uniforms Pointer to an array of 32-bit-aligned 24-bit floating point values.
+     * @param initial_state Initial recorder state
      */
      */
     Recorder(const InitialState& initial_state);
     Recorder(const InitialState& initial_state);