diff options
| author | 2015-09-10 11:07:33 -0400 | |
|---|---|---|
| committer | 2015-09-10 11:20:21 -0400 | |
| commit | d3efa637b448f1be84397deab0b1355bbc901e3b (patch) | |
| tree | 0e9d245bb4509b26c9544012a3d38bd5329e7e55 /src/core | |
| parent | Merge pull request #1131 from lioncash/uninit (diff) | |
| download | yuzu-d3efa637b448f1be84397deab0b1355bbc901e3b.tar.gz yuzu-d3efa637b448f1be84397deab0b1355bbc901e3b.tar.xz yuzu-d3efa637b448f1be84397deab0b1355bbc901e3b.zip | |
General: Fix up doxygen comments
Diffstat (limited to 'src/core')
| -rw-r--r-- | src/core/hle/kernel/mutex.h | 7 | ||||
| -rw-r--r-- | src/core/hle/kernel/semaphore.h | 1 | ||||
| -rw-r--r-- | src/core/hle/kernel/thread.h | 1 | ||||
| -rw-r--r-- | src/core/hle/service/fs/archive.h | 2 | ||||
| -rw-r--r-- | src/core/loader/loader.cpp | 2 | ||||
| -rw-r--r-- | src/core/loader/ncch.h | 4 | ||||
| -rw-r--r-- | 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 d6d5328be..1746360e4 100644 --- a/src/core/hle/kernel/mutex.h +++ b/src/core/hle/kernel/mutex.h | |||
| @@ -38,10 +38,9 @@ public: | |||
| 38 | void Acquire() override; | 38 | void Acquire() override; |
| 39 | 39 | ||
| 40 | /** | 40 | /** |
| 41 | * Acquires the specified mutex for the specified thread | 41 | * Acquires the specified mutex for the specified thread |
| 42 | * @param mutex Mutex that is to be acquired | 42 | * @param thread Thread that will acquire the mutex |
| 43 | * @param thread Thread that will acquire the mutex | 43 | */ |
| 44 | */ | ||
| 45 | void Acquire(SharedPtr<Thread> thread); | 44 | void Acquire(SharedPtr<Thread> thread); |
| 46 | void Release(); | 45 | void Release(); |
| 47 | 46 | ||
diff --git a/src/core/hle/kernel/semaphore.h b/src/core/hle/kernel/semaphore.h index d8dc1fd78..390f5e495 100644 --- a/src/core/hle/kernel/semaphore.h +++ b/src/core/hle/kernel/semaphore.h | |||
| @@ -17,7 +17,6 @@ class Semaphore final : public WaitObject { | |||
| 17 | public: | 17 | public: |
| 18 | /** | 18 | /** |
| 19 | * Creates a semaphore. | 19 | * Creates a semaphore. |
| 20 | * @param handle Pointer to the handle of the newly created object | ||
| 21 | * @param initial_count Number of slots reserved for other threads | 20 | * @param initial_count Number of slots reserved for other threads |
| 22 | * @param max_count Maximum number of slots the semaphore can have | 21 | * @param max_count Maximum number of slots the semaphore can have |
| 23 | * @param name Optional name of semaphore | 22 | * @param name Optional name of semaphore |
diff --git a/src/core/hle/kernel/thread.h b/src/core/hle/kernel/thread.h index 1ff1d9b97..97ba57fc5 100644 --- a/src/core/hle/kernel/thread.h +++ b/src/core/hle/kernel/thread.h | |||
| @@ -57,7 +57,6 @@ public: | |||
| 57 | * @param arg User data to pass to the thread | 57 | * @param arg User data to pass to the thread |
| 58 | * @param processor_id The ID(s) of the processors on which the thread is desired to be run | 58 | * @param processor_id The ID(s) of the processors on which the thread is desired to be run |
| 59 | * @param stack_top The address of the thread's stack top | 59 | * @param stack_top The address of the thread's stack top |
| 60 | * @param stack_size The size of the thread's stack | ||
| 61 | * @return A shared pointer to the newly created thread | 60 | * @return A shared pointer to the newly created thread |
| 62 | */ | 61 | */ |
| 63 | static ResultVal<SharedPtr<Thread>> Create(std::string name, VAddr entry_point, s32 priority, | 62 | static ResultVal<SharedPtr<Thread>> 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 f61125953..6f7048710 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); | |||
| 87 | 87 | ||
| 88 | /** | 88 | /** |
| 89 | * Registers an Archive type, instances of which can later be opened using its IdCode. | 89 | * Registers an Archive type, instances of which can later be opened using its IdCode. |
| 90 | * @param backend File system backend interface to the archive | 90 | * @param factory File system backend interface to the archive |
| 91 | * @param id_code Id code used to access this type of archive | 91 | * @param id_code Id code used to access this type of archive |
| 92 | */ | 92 | */ |
| 93 | ResultCode RegisterArchiveType(std::unique_ptr<FileSys::ArchiveFactory>&& factory, ArchiveIdCode id_code); | 93 | ResultCode RegisterArchiveType(std::unique_ptr<FileSys::ArchiveFactory>&& factory, ArchiveIdCode id_code); |
diff --git a/src/core/loader/loader.cpp b/src/core/loader/loader.cpp index 062291006..74eb6e871 100644 --- a/src/core/loader/loader.cpp +++ b/src/core/loader/loader.cpp | |||
| @@ -50,7 +50,7 @@ static FileType IdentifyFile(FileUtil::IOFile& file) { | |||
| 50 | 50 | ||
| 51 | /** | 51 | /** |
| 52 | * Guess the type of a bootable file from its extension | 52 | * Guess the type of a bootable file from its extension |
| 53 | * @param extension String extension of bootable file | 53 | * @param extension_ String extension of bootable file |
| 54 | * @return FileType of file | 54 | * @return FileType of file |
| 55 | */ | 55 | */ |
| 56 | static FileType GuessFromExtension(const std::string& extension_) { | 56 | static FileType GuessFromExtension(const std::string& extension_) { |
diff --git a/src/core/loader/ncch.h b/src/core/loader/ncch.h index b4374a476..d875e4cf3 100644 --- a/src/core/loader/ncch.h +++ b/src/core/loader/ncch.h | |||
| @@ -209,7 +209,9 @@ public: | |||
| 209 | 209 | ||
| 210 | /** | 210 | /** |
| 211 | * Get the RomFS of the application | 211 | * Get the RomFS of the application |
| 212 | * @param buffer Reference to buffer to store data | 212 | * @param romfs_file Reference to buffer to store data |
| 213 | * @param offset Offset in the file to the RomFS | ||
| 214 | * @param size Size of the RomFS in bytes | ||
| 213 | * @return ResultStatus result of function | 215 | * @return ResultStatus result of function |
| 214 | */ | 216 | */ |
| 215 | ResultStatus ReadRomFS(std::shared_ptr<FileUtil::IOFile>& romfs_file, u64& offset, u64& size) override; | 217 | ResultStatus ReadRomFS(std::shared_ptr<FileUtil::IOFile>& romfs_file, u64& offset, u64& size) override; |
diff --git a/src/core/tracer/recorder.h b/src/core/tracer/recorder.h index 6e4b70015..a42ccc45f 100644 --- a/src/core/tracer/recorder.h +++ b/src/core/tracer/recorder.h | |||
| @@ -32,8 +32,7 @@ public: | |||
| 32 | 32 | ||
| 33 | /** | 33 | /** |
| 34 | * Recorder constructor | 34 | * Recorder constructor |
| 35 | * @param default_attributes Pointer to an array of 32-bit-aligned 24-bit floating point values. | 35 | * @param initial_state Initial recorder state |
| 36 | * @param vs_float_uniforms Pointer to an array of 32-bit-aligned 24-bit floating point values. | ||
| 37 | */ | 36 | */ |
| 38 | Recorder(const InitialState& initial_state); | 37 | Recorder(const InitialState& initial_state); |
| 39 | 38 | ||