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.
This commit is contained in:
parent
b250ce21b9
commit
0cb52ee74a
18 changed files with 31 additions and 23 deletions
|
@ -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
|
||||
*/
|
||||
|
|
|
@ -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.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue