diff options
| author | 2017-02-26 20:58:51 -0500 | |
|---|---|---|
| committer | 2017-02-26 17:58:51 -0800 | |
| commit | 0cb52ee74a8255eb0320c882bc9e70700317d16a (patch) | |
| tree | 800920c60df4d183d20d94465e0886e5655216a0 /src/video_core | |
| parent | Merge pull request #2587 from yuriks/status-bar (diff) | |
| download | yuzu-0cb52ee74a8255eb0320c882bc9e70700317d16a.tar.gz yuzu-0cb52ee74a8255eb0320c882bc9e70700317d16a.tar.xz yuzu-0cb52ee74a8255eb0320c882bc9e70700317d16a.zip | |
Doxygen: Amend minor issues (#2593)
Corrects a few issues with regards to Doxygen documentation, for example:
- Incorrect parameter referencing.
- Missing @param tags.
- Typos in @param tags.
and a few minor other issues.
Diffstat (limited to 'src/video_core')
| -rw-r--r-- | src/video_core/debug_utils/debug_utils.h | 2 | ||||
| -rw-r--r-- | src/video_core/shader/shader_interpreter.h | 3 | ||||
| -rw-r--r-- | src/video_core/shader/shader_jit_x64_compiler.h | 3 |
3 files changed, 5 insertions, 3 deletions
diff --git a/src/video_core/debug_utils/debug_utils.h b/src/video_core/debug_utils/debug_utils.h index 89e418e27..c1f29c527 100644 --- a/src/video_core/debug_utils/debug_utils.h +++ b/src/video_core/debug_utils/debug_utils.h | |||
| @@ -87,7 +87,7 @@ public: | |||
| 87 | * @param data Optional data pointer (if unused, this is a nullptr) | 87 | * @param data Optional data pointer (if unused, this is a nullptr) |
| 88 | * @note This function will perform nothing unless it is overridden in the child class. | 88 | * @note This function will perform nothing unless it is overridden in the child class. |
| 89 | */ | 89 | */ |
| 90 | virtual void OnPicaBreakPointHit(Event, void*) {} | 90 | virtual void OnPicaBreakPointHit(Event event, void* data) {} |
| 91 | 91 | ||
| 92 | /** | 92 | /** |
| 93 | * Action to perform when emulation is resumed from a breakpoint. | 93 | * Action to perform when emulation is resumed from a breakpoint. |
diff --git a/src/video_core/shader/shader_interpreter.h b/src/video_core/shader/shader_interpreter.h index 5682b3a39..50fd7c69d 100644 --- a/src/video_core/shader/shader_interpreter.h +++ b/src/video_core/shader/shader_interpreter.h | |||
| @@ -18,7 +18,8 @@ public: | |||
| 18 | 18 | ||
| 19 | /** | 19 | /** |
| 20 | * Produce debug information based on the given shader and input vertex | 20 | * Produce debug information based on the given shader and input vertex |
| 21 | * @param input Input vertex into the shader | 21 | * @param setup Shader engine state |
| 22 | * @param input Input vertex into the shader | ||
| 22 | * @param config Configuration object for the shader pipeline | 23 | * @param config Configuration object for the shader pipeline |
| 23 | * @return Debug information for this shader with regards to the given vertex | 24 | * @return Debug information for this shader with regards to the given vertex |
| 24 | */ | 25 | */ |
diff --git a/src/video_core/shader/shader_jit_x64_compiler.h b/src/video_core/shader/shader_jit_x64_compiler.h index 599e43ffd..f27675560 100644 --- a/src/video_core/shader/shader_jit_x64_compiler.h +++ b/src/video_core/shader/shader_jit_x64_compiler.h | |||
| @@ -93,7 +93,8 @@ private: | |||
| 93 | 93 | ||
| 94 | /** | 94 | /** |
| 95 | * Assertion evaluated at compile-time, but only triggered if executed at runtime. | 95 | * Assertion evaluated at compile-time, but only triggered if executed at runtime. |
| 96 | * @param msg Message to be logged if the assertion fails. | 96 | * @param condition Condition to be evaluated. |
| 97 | * @param msg Message to be logged if the assertion fails. | ||
| 97 | */ | 98 | */ |
| 98 | void Compile_Assert(bool condition, const char* msg); | 99 | void Compile_Assert(bool condition, const char* msg); |
| 99 | 100 | ||