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/citra_qt/game_list_p.h | 8 ++++---- src/citra_qt/hotkeys.h | 2 ++ 2 files changed, 6 insertions(+), 4 deletions(-) (limited to 'src/citra_qt') 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. -- cgit v1.2.3