fix typo

qgis · Nov 29, 2018 · e03537a · e03537a
1 parent f24daa2
commit e03537a
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 6 deletions.
diff --git a/python/core/auto_generated/locator/qgslocatorfilter.sip.in b/python/core/auto_generated/locator/qgslocatorfilter.sip.in
@@ -55,7 +55,14 @@ Constructor for QgsLocatorResult.
 %Docstring
 Constructor for ResultAction
 %End
+
         ResultAction( int id, QString text, QString iconPath = QString() );
+%Docstring
+Constructor for ResultAction
+The ``id`` used to recognized the action when the result is triggered.
+It should be 0 or greater as otherwise, the result will be triggered
+normally.
+%End
         int id;
         QString text;
         QString iconPath;

diff --git a/src/core/locator/qgslocatorfilter.h b/src/core/locator/qgslocatorfilter.h
@@ -94,19 +94,23 @@ class CORE_EXPORT QgsLocatorResult
     QString group = QString();
 
     /**
-     * The ResultActions stores basic informations for additional
-     * actions to be used in a locator widget, in a context menu
-     * for instance.
-     * The \a id used to recognized the action when the result is triggered.
-     * It should be 0 or greater as otherwise, the result will be triggered
-     * normally.
+     * The ResultAction stores basic information for additional
+     * actions to be used in a locator widget for the result.
+     * They could be used in a context menu for instance.
      * \since QGIS 3.6
      */
     struct CORE_EXPORT ResultAction
     {
       public:
         //! Constructor for ResultAction
         ResultAction() = default;
+
+        /**
+         * Constructor for ResultAction
+         * The \a id used to recognized the action when the result is triggered.
+         * It should be 0 or greater as otherwise, the result will be triggered
+         * normally.
+         */
         ResultAction( int id, QString text, QString iconPath = QString() )
           : id( id )
           , text( text )