Improve sip bindings

qgis · Mar 31, 2017 · 22272c6 · 22272c6
1 parent 6208986
commit 22272c6
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 3 deletions.
diff --git a/python/core/qgsactionscope.sip b/python/core/qgsactionscope.sip
@@ -4,9 +4,31 @@
  *****************************************************************/
 
 
-
 class QgsActionScope
 {
+%Docstring
+ \ingroup core
+ An action scope defines a "place" for an action to be shown and may add
+ additional expression variables.
+ Each QgsAction can be available in one or several action scopes.
+
+ Examples:
+ ---------
+
+ <dl>
+   <dt>Canvas</dt>
+   <dd>Show for canvas tools. Adds `@clicked_x` and `@clicked_y` in map coordinates.</dd>
+   <dt>Feature</dt>
+   <dd>Show in feature specific places like the attribute table or feature
+   form.</dd>
+   <dt>Field</dt>
+   <dd>Show in context menus for individual fields (e.g. attribute table). Adds `@field_index`, `@field_name` and `@field_value`.</dd>
+   <dt>Layer</dt>
+   <dd>Show in attribute table and work on the layer or selection.</dd>
+ </dl>
+
+ @note Added in QGIS 3.0
+%End
 
 %TypeHeaderCode
 #include "qgsactionscope.h"

diff --git a/src/core/qgsactionscope.h b/src/core/qgsactionscope.h
@@ -42,7 +42,6 @@
  *
  * @note Added in QGIS 3.0
  */
-
 class CORE_EXPORT QgsActionScope
 {
   public:
@@ -125,6 +124,6 @@ class CORE_EXPORT QgsActionScope
     QgsExpressionContextScope mExpressionContextScope;
 };
 
-CORE_EXPORT uint qHash( const QgsActionScope &key, uint seed = 0 ); // SIP_SKIP
+CORE_EXPORT uint qHash( const QgsActionScope &key, uint seed = 0 ) SIP_SKIP;
 
 #endif // QGSACTIONSCOPE_H