From d3efa637b448f1be84397deab0b1355bbc901e3b Mon Sep 17 00:00:00 2001 From: Lioncash Date: Thu, 10 Sep 2015 11:07:33 -0400 Subject: [PATCH] General: Fix up doxygen comments --- src/core/hle/kernel/mutex.h | 7 +++---- src/core/hle/kernel/semaphore.h | 1 - src/core/hle/kernel/thread.h | 1 - src/core/hle/service/fs/archive.h | 2 +- src/core/loader/loader.cpp | 2 +- src/core/loader/ncch.h | 4 +++- src/core/tracer/recorder.h | 3 +-- 7 files changed, 9 insertions(+), 11 deletions(-) diff --git a/src/core/hle/kernel/mutex.h b/src/core/hle/kernel/mutex.h index d6d5328bee..1746360e4b 100644 --- a/src/core/hle/kernel/mutex.h +++ b/src/core/hle/kernel/mutex.h @@ -38,10 +38,9 @@ public: 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); void Release(); diff --git a/src/core/hle/kernel/semaphore.h b/src/core/hle/kernel/semaphore.h index d8dc1fd78a..390f5e4954 100644 --- a/src/core/hle/kernel/semaphore.h +++ b/src/core/hle/kernel/semaphore.h @@ -17,7 +17,6 @@ class Semaphore final : public WaitObject { public: /** * 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 max_count Maximum number of slots the semaphore can have * @param name Optional name of semaphore diff --git a/src/core/hle/kernel/thread.h b/src/core/hle/kernel/thread.h index 1ff1d9b979..97ba57fc5a 100644 --- a/src/core/hle/kernel/thread.h +++ b/src/core/hle/kernel/thread.h @@ -57,7 +57,6 @@ public: * @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 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 */ static ResultVal> Create(std::string name, VAddr entry_point, s32 priority, diff --git a/src/core/hle/service/fs/archive.h b/src/core/hle/service/fs/archive.h index f611259537..6f70487101 100644 --- a/src/core/hle/service/fs/archive.h +++ b/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. - * @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 */ ResultCode RegisterArchiveType(std::unique_ptr&& factory, ArchiveIdCode id_code); diff --git a/src/core/loader/loader.cpp b/src/core/loader/loader.cpp index 0622910067..74eb6e871b 100644 --- a/src/core/loader/loader.cpp +++ b/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 - * @param extension String extension of bootable file + * @param extension_ String extension of bootable file * @return FileType of file */ static FileType GuessFromExtension(const std::string& extension_) { diff --git a/src/core/loader/ncch.h b/src/core/loader/ncch.h index b4374a4760..d875e4cf3f 100644 --- a/src/core/loader/ncch.h +++ b/src/core/loader/ncch.h @@ -209,7 +209,9 @@ public: /** * 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 */ ResultStatus ReadRomFS(std::shared_ptr& romfs_file, u64& offset, u64& size) override; diff --git a/src/core/tracer/recorder.h b/src/core/tracer/recorder.h index 6e4b700156..a42ccc45ff 100644 --- a/src/core/tracer/recorder.h +++ b/src/core/tracer/recorder.h @@ -32,8 +32,7 @@ public: /** * 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);