Docs

nyalldawson · nyalldawson · commit 4c1c6bec71cc · 2023-04-26T17:21:20.000+10:00
diff --git a/src/gui/qgsdbqueryhistoryprovider.h b/src/gui/qgsdbqueryhistoryprovider.h
@@ -45,10 +45,16 @@ class GUI_EXPORT QgsDatabaseQueryHistoryProvider : public QgsAbstractHistoryProv
     QgsHistoryEntryNode *createNodeForEntry( const QgsHistoryEntry &entry, const QgsHistoryWidgetContext &context ) override SIP_FACTORY;
     void updateNodeForEntry( QgsHistoryEntryNode *node, const QgsHistoryEntry &entry, const QgsHistoryWidgetContext &context ) override;
 
+    /**
+     * Causes the provider to emit the openSqlDialog() signal.
+     */
     void emitOpenSqlDialog( const QString &connectionUri, const QString &provider, const QString &sql );
 
   signals:
 
+    /**
+     * Emitted when the provider wants to trigger a SQL execution dialog.
+     */
     void openSqlDialog( const QString &connectionUri, const QString &provider, const QString &sql );
 
 };
