Skip to content

Commit e03537a

Browse files
committed
fix typo
1 parent f24daa2 commit e03537a

File tree

2 files changed

+17
-6
lines changed

2 files changed

+17
-6
lines changed

python/core/auto_generated/locator/qgslocatorfilter.sip.in

+7
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,14 @@ Constructor for QgsLocatorResult.
5555
%Docstring
5656
Constructor for ResultAction
5757
%End
58+
5859
ResultAction( int id, QString text, QString iconPath = QString() );
60+
%Docstring
61+
Constructor for ResultAction
62+
The ``id`` used to recognized the action when the result is triggered.
63+
It should be 0 or greater as otherwise, the result will be triggered
64+
normally.
65+
%End
5966
int id;
6067
QString text;
6168
QString iconPath;

src/core/locator/qgslocatorfilter.h

+10-6
Original file line numberDiff line numberDiff line change
@@ -94,19 +94,23 @@ class CORE_EXPORT QgsLocatorResult
9494
QString group = QString();
9595

9696
/**
97-
* The ResultActions stores basic informations for additional
98-
* actions to be used in a locator widget, in a context menu
99-
* for instance.
100-
* The \a id used to recognized the action when the result is triggered.
101-
* It should be 0 or greater as otherwise, the result will be triggered
102-
* normally.
97+
* The ResultAction stores basic information for additional
98+
* actions to be used in a locator widget for the result.
99+
* They could be used in a context menu for instance.
103100
* \since QGIS 3.6
104101
*/
105102
struct CORE_EXPORT ResultAction
106103
{
107104
public:
108105
//! Constructor for ResultAction
109106
ResultAction() = default;
107+
108+
/**
109+
* Constructor for ResultAction
110+
* The \a id used to recognized the action when the result is triggered.
111+
* It should be 0 or greater as otherwise, the result will be triggered
112+
* normally.
113+
*/
110114
ResultAction( int id, QString text, QString iconPath = QString() )
111115
: id( id )
112116
, text( text )

0 commit comments

Comments
 (0)