From 0cb52ee74a8255eb0320c882bc9e70700317d16a Mon Sep 17 00:00:00 2001 From: Mat M Date: Sun, 26 Feb 2017 20:58:51 -0500 Subject: 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. --- src/video_core/debug_utils/debug_utils.h | 2 +- src/video_core/shader/shader_interpreter.h | 3 ++- src/video_core/shader/shader_jit_x64_compiler.h | 3 ++- 3 files changed, 5 insertions(+), 3 deletions(-) (limited to 'src/video_core') 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: * @param data Optional data pointer (if unused, this is a nullptr) * @note This function will perform nothing unless it is overridden in the child class. */ - virtual void OnPicaBreakPointHit(Event, void*) {} + virtual void OnPicaBreakPointHit(Event event, void* data) {} /** * 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: /** * Produce debug information based on the given shader and input vertex - * @param input Input vertex into the shader + * @param setup Shader engine state + * @param input Input vertex into the shader * @param config Configuration object for the shader pipeline * @return Debug information for this shader with regards to the given vertex */ 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: /** * Assertion evaluated at compile-time, but only triggered if executed at runtime. - * @param msg Message to be logged if the assertion fails. + * @param condition Condition to be evaluated. + * @param msg Message to be logged if the assertion fails. */ void Compile_Assert(bool condition, const char* msg); -- cgit v1.2.3