diff options
| -rw-r--r-- | src/audio_core/hle/filter.h | 2 | ||||
| -rw-r--r-- | src/audio_core/interpolate.h | 2 | ||||
| -rw-r--r-- | src/audio_core/sink.h | 2 | ||||
| -rw-r--r-- | src/audio_core/time_stretch.h | 2 | ||||
| -rw-r--r-- | src/citra_qt/game_list_p.h | 8 | ||||
| -rw-r--r-- | src/citra_qt/hotkeys.h | 2 | ||||
| -rw-r--r-- | src/core/file_sys/archive_extsavedata.h | 2 | ||||
| -rw-r--r-- | src/core/frontend/camera/factory.h | 4 | ||||
| -rw-r--r-- | src/core/gdbstub/gdbstub.cpp | 1 | ||||
| -rw-r--r-- | src/core/hle/ipc.h | 4 | ||||
| -rw-r--r-- | src/core/hle/kernel/server_session.h | 3 | ||||
| -rw-r--r-- | src/core/hle/service/cam/cam.h | 2 | ||||
| -rw-r--r-- | src/core/hle/service/gsp_gpu.cpp | 6 | ||||
| -rw-r--r-- | src/core/hle/service/ldr_ro/cro_helper.h | 4 | ||||
| -rw-r--r-- | src/core/loader/loader.h | 2 | ||||
| -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 |
18 files changed, 31 insertions, 23 deletions
diff --git a/src/audio_core/hle/filter.h b/src/audio_core/hle/filter.h index 4281a5898..5350e2857 100644 --- a/src/audio_core/hle/filter.h +++ b/src/audio_core/hle/filter.h @@ -27,7 +27,7 @@ public: * See also: SourceConfiguration::Configuration::simple_filter_enabled, * SourceConfiguration::Configuration::biquad_filter_enabled. * @param simple If true, enables the simple filter. If false, disables it. - * @param simple If true, enables the biquad filter. If false, disables it. + * @param biquad If true, enables the biquad filter. If false, disables it. */ void Enable(bool simple, bool biquad); diff --git a/src/audio_core/interpolate.h b/src/audio_core/interpolate.h index dd06fdda9..19a7b66cb 100644 --- a/src/audio_core/interpolate.h +++ b/src/audio_core/interpolate.h @@ -21,6 +21,7 @@ struct State { /** * No interpolation. This is equivalent to a zero-order hold. There is a two-sample predelay. + * @param state Interpolation state. * @param input Input buffer. * @param rate_multiplier Stretch factor. Must be a positive non-zero value. * rate_multiplier > 1.0 performs decimation and rate_multipler < 1.0 @@ -31,6 +32,7 @@ StereoBuffer16 None(State& state, const StereoBuffer16& input, float rate_multip /** * Linear interpolation. This is equivalent to a first-order hold. There is a two-sample predelay. + * @param state Interpolation state. * @param input Input buffer. * @param rate_multiplier Stretch factor. Must be a positive non-zero value. * rate_multiplier > 1.0 performs decimation and rate_multipler < 1.0 diff --git a/src/audio_core/sink.h b/src/audio_core/sink.h index 558c8c0fe..c69cb2c74 100644 --- a/src/audio_core/sink.h +++ b/src/audio_core/sink.h @@ -34,7 +34,7 @@ public: /** * Sets the desired output device. - * @paran device_id Id of the desired device. + * @param device_id ID of the desired device. */ virtual void SetDevice(int device_id) = 0; diff --git a/src/audio_core/time_stretch.h b/src/audio_core/time_stretch.h index e3e4dc353..c98b16705 100644 --- a/src/audio_core/time_stretch.h +++ b/src/audio_core/time_stretch.h @@ -25,7 +25,7 @@ public: /** * Add samples to be processed. * @param sample_buffer Buffer of samples in interleaved stereo PCM16 format. - * @param num_sample Number of samples. + * @param num_samples Number of samples. */ void AddSamples(const s16* sample_buffer, size_t num_samples); diff --git a/src/citra_qt/game_list_p.h b/src/citra_qt/game_list_p.h index a15f06c5f..3c11b6dd1 100644 --- a/src/citra_qt/game_list_p.h +++ b/src/citra_qt/game_list_p.h @@ -16,8 +16,8 @@ #include "video_core/utils.h" /** - * Gets game icon from SMDH - * @param sdmh SMDH data + * Gets the game icon from SMDH data. + * @param smdh SMDH data * @param large If true, returns large icon (48x48), otherwise returns small icon (24x24) * @return QPixmap game icon */ @@ -42,8 +42,8 @@ static QPixmap GetDefaultIcon(bool large) { } /** - * Gets the short game title fromn SMDH - * @param sdmh SMDH data + * Gets the short game title from SMDH data. + * @param smdh SMDH data * @param language title language * @return QString short title */ diff --git a/src/citra_qt/hotkeys.h b/src/citra_qt/hotkeys.h index 46f48c2d8..a4ccc193b 100644 --- a/src/citra_qt/hotkeys.h +++ b/src/citra_qt/hotkeys.h @@ -29,6 +29,8 @@ void RegisterHotkey(const QString& group, const QString& action, /** * Returns a QShortcut object whose activated() signal can be connected to other QObjects' slots. * + * @param group General group this hotkey belongs to (e.g. "Main Window", "Debugger"). + * @param action Name of the action (e.g. "Start Emulation", "Load Image"). * @param widget Parent widget of the returned QShortcut. * @warning If multiple QWidgets' call this function for the same action, the returned QShortcut * will be the same. Thus, you shouldn't rely on the caller really being the QShortcut's parent. diff --git a/src/core/file_sys/archive_extsavedata.h b/src/core/file_sys/archive_extsavedata.h index 6a3431e94..f705ade1c 100644 --- a/src/core/file_sys/archive_extsavedata.h +++ b/src/core/file_sys/archive_extsavedata.h @@ -52,7 +52,7 @@ private: /** * This holds the full directory path for this archive, it is only set after a successful call - * to Open, this is formed as <base extsavedatapath>/<type>/<high>/<low>. + * to Open, this is formed as `<base extsavedatapath>/<type>/<high>/<low>`. * See GetExtSaveDataPath for the code that extracts this data from an archive path. */ std::string mount_point; diff --git a/src/core/frontend/camera/factory.h b/src/core/frontend/camera/factory.h index d68be16e5..f46413fa7 100644 --- a/src/core/frontend/camera/factory.h +++ b/src/core/frontend/camera/factory.h @@ -16,8 +16,8 @@ public: /** * Creates a camera object based on the configuration string. - * @params config Configuration string to create the camera. The implementation can decide the - * meaning of this string. + * @param config Configuration string to create the camera. The implementation can decide the + * meaning of this string. * @returns a unique_ptr to the created camera object. */ virtual std::unique_ptr<CameraInterface> Create(const std::string& config) const = 0; diff --git a/src/core/gdbstub/gdbstub.cpp b/src/core/gdbstub/gdbstub.cpp index 5cf45ada5..123fe7cd4 100644 --- a/src/core/gdbstub/gdbstub.cpp +++ b/src/core/gdbstub/gdbstub.cpp @@ -230,6 +230,7 @@ static void GdbHexToMem(u8* dest, const u8* src, size_t len) { * Convert a u32 into a gdb-formatted hex string. * * @param dest Pointer to buffer to store output hex string characters. + * @param v Value to convert. */ static void IntToGdbHex(u8* dest, u32 v) { for (int i = 0; i < 8; i += 2) { diff --git a/src/core/hle/ipc.h b/src/core/hle/ipc.h index bbaae8b79..cd9a5863d 100644 --- a/src/core/hle/ipc.h +++ b/src/core/hle/ipc.h @@ -72,8 +72,8 @@ union Header { * through modifications and checks by the kernel. * The translate parameters are described by headers generated with the IPC::*Desc functions. * - * @note While #normal_params_size is equivalent to the number of normal parameters, - * #translate_params_size includes the size occupied by the translate parameters headers. + * @note While @p normal_params_size is equivalent to the number of normal parameters, + * @p translate_params_size includes the size occupied by the translate parameters headers. */ inline u32 MakeHeader(u16 command_id, unsigned int normal_params_size, unsigned int translate_params_size) { diff --git a/src/core/hle/kernel/server_session.h b/src/core/hle/kernel/server_session.h index 4ffe97b78..761fc4781 100644 --- a/src/core/hle/kernel/server_session.h +++ b/src/core/hle/kernel/server_session.h @@ -45,7 +45,8 @@ public: /** * Creates a pair of ServerSession and an associated ClientSession. - * @param name Optional name of the ports + * @param name Optional name of the ports. + * @param hle_handler Optional HLE handler for this server session. * @return The created session tuple */ static SessionPair CreateSessionPair( diff --git a/src/core/hle/service/cam/cam.h b/src/core/hle/service/cam/cam.h index f6bff8bc6..34a9c8479 100644 --- a/src/core/hle/service/cam/cam.h +++ b/src/core/hle/service/cam/cam.h @@ -518,7 +518,7 @@ void FlipImage(Service::Interface* self); void SetDetailSize(Service::Interface* self); /** - * Sets camera resolution from preset resolution parameters. . + * Sets camera resolution from preset resolution parameters. * Inputs: * 0: 0x001F00C0 * 1: u8 selected camera diff --git a/src/core/hle/service/gsp_gpu.cpp b/src/core/hle/service/gsp_gpu.cpp index 097ed87e4..a960778a7 100644 --- a/src/core/hle/service/gsp_gpu.cpp +++ b/src/core/hle/service/gsp_gpu.cpp @@ -119,10 +119,10 @@ static ResultCode WriteHWRegs(u32 base_address, u32 size_in_bytes, VAddr data_va * Updates sequential GSP GPU hardware registers using parallel arrays of source data and masks. * For each register, the value is updated only where the mask is high * - * @param base_address The address of the first register in the sequence + * @param base_address The address of the first register in the sequence * @param size_in_bytes The number of registers to update (size of data) - * @param data A pointer to the source data to use for updates - * @param masks A pointer to the masks + * @param data_vaddr A virtual address to the source data to use for updates + * @param masks_vaddr A virtual address to the masks * @return RESULT_SUCCESS if the parameters are valid, error code otherwise */ static ResultCode WriteHWRegsWithMask(u32 base_address, u32 size_in_bytes, VAddr data_vaddr, diff --git a/src/core/hle/service/ldr_ro/cro_helper.h b/src/core/hle/service/ldr_ro/cro_helper.h index 060d5a55f..3bc10dbdc 100644 --- a/src/core/hle/service/ldr_ro/cro_helper.h +++ b/src/core/hle/service/ldr_ro/cro_helper.h @@ -57,7 +57,7 @@ public: * @param is_crs true if the module itself is the static module * @returns ResultCode RESULT_SUCCESS on success, otherwise error code. */ - ResultCode Rebase(VAddr crs_address, u32 cro_size, VAddr data_segment_addresss, + ResultCode Rebase(VAddr crs_address, u32 cro_size, VAddr data_segment_address, u32 data_segment_size, VAddr bss_segment_address, u32 bss_segment_size, bool is_crs); @@ -102,7 +102,7 @@ public: /** * Registers this module and adds it to the module list. * @param crs_address the virtual address of the static module - * @auto_link whether to register as an auto link module + * @param auto_link whether to register as an auto link module */ void Register(VAddr crs_address, bool auto_link); diff --git a/src/core/loader/loader.h b/src/core/loader/loader.h index a6c2a745f..1d80766ae 100644 --- a/src/core/loader/loader.h +++ b/src/core/loader/loader.h @@ -54,7 +54,7 @@ FileType IdentifyFile(const std::string& file_name); * @return FileType of file. Note: this will return FileType::Unknown if it is unable to determine * a filetype, and will never return FileType::Error. */ -FileType GuessFromExtension(const std::string& extension_); +FileType GuessFromExtension(const std::string& extension); /** * Convert a FileType into a string which can be displayed to the user. 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); |