From 16c916b7231f36d40a9ac7a57b862bfa2da17569 Mon Sep 17 00:00:00 2001 From: Julien Cabieces Date: Tue, 3 Aug 2021 14:19:49 +0200 Subject: [PATCH] fix typos and doc --- python/gui/auto_generated/qgsexternalresourcewidget.sip.in | 2 +- python/gui/auto_generated/qgsfilewidget.sip.in | 2 +- src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.h | 4 +++- src/gui/qgsexternalresourcewidget.h | 2 +- src/gui/qgsfilewidget.h | 2 +- tests/src/gui/testqgsfilewidget.cpp | 2 +- 6 files changed, 8 insertions(+), 6 deletions(-) diff --git a/python/gui/auto_generated/qgsexternalresourcewidget.sip.in b/python/gui/auto_generated/qgsexternalresourcewidget.sip.in index 332fdbf0d67..7f10e1c766a 100644 --- a/python/gui/auto_generated/qgsexternalresourcewidget.sip.in +++ b/python/gui/auto_generated/qgsexternalresourcewidget.sip.in @@ -147,7 +147,7 @@ null QString if there is no storage defined, only file selection. QString storageType() const; %Docstring -Get storage type unique identifier as defined in :py:class:`QgsExternalStorageRegistry`. +Returns storage type unique identifier as defined in :py:class:`QgsExternalStorageRegistry`. Returns null QString if there is no storage defined, only file selection. .. seealso:: :py:func:`setStorageType` diff --git a/python/gui/auto_generated/qgsfilewidget.sip.in b/python/gui/auto_generated/qgsfilewidget.sip.in index 746142a5a4d..a80b087c64c 100644 --- a/python/gui/auto_generated/qgsfilewidget.sip.in +++ b/python/gui/auto_generated/qgsfilewidget.sip.in @@ -93,7 +93,7 @@ selected files. QString storageType() const; %Docstring -Get storage type unique identifier as defined in :py:class:`QgsExternalStorageRegistry`. +Returns storage type unique identifier as defined in :py:class:`QgsExternalStorageRegistry`. Returns null QString if there is no storage defined, only file selection. .. seealso:: :py:func:`setStorageType` diff --git a/src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.h b/src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.h index d6a75d8a030..7b301da8f70 100644 --- a/src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.h +++ b/src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.h @@ -66,7 +66,9 @@ class GUI_EXPORT QgsExternalResourceWidgetWrapper : public QgsEditorWidgetWrappe void initWidget( QWidget *editor ) override; bool valid() const override; - // update file widget current expression context according to layer, feature, and parent feature + /** + * Update file widget current expression context according to layer, feature, and parent feature + */ void updateFileWidgetExpressionContext(); public slots: diff --git a/src/gui/qgsexternalresourcewidget.h b/src/gui/qgsexternalresourcewidget.h index 756344e4a48..e2d4b1e2a4f 100644 --- a/src/gui/qgsexternalresourcewidget.h +++ b/src/gui/qgsexternalresourcewidget.h @@ -153,7 +153,7 @@ class GUI_EXPORT QgsExternalResourceWidget : public QWidget void setStorageType( const QString &storageType ); /** - * Get storage type unique identifier as defined in QgsExternalStorageRegistry. + * Returns storage type unique identifier as defined in QgsExternalStorageRegistry. * Returns null QString if there is no storage defined, only file selection. * \see setStorageType * \since QGIS 3.22 diff --git a/src/gui/qgsfilewidget.h b/src/gui/qgsfilewidget.h index 7a235d2dc19..a6a47df274b 100644 --- a/src/gui/qgsfilewidget.h +++ b/src/gui/qgsfilewidget.h @@ -136,7 +136,7 @@ class GUI_EXPORT QgsFileWidget : public QWidget void setStorageType( const QString &storageType ); /** - * Get storage type unique identifier as defined in QgsExternalStorageRegistry. + * Returns storage type unique identifier as defined in QgsExternalStorageRegistry. * Returns null QString if there is no storage defined, only file selection. * \see setStorageType * \since QGIS 3.22 diff --git a/tests/src/gui/testqgsfilewidget.cpp b/tests/src/gui/testqgsfilewidget.cpp index e19f394fe1e..e3518552c51 100644 --- a/tests/src/gui/testqgsfilewidget.cpp +++ b/tests/src/gui/testqgsfilewidget.cpp @@ -587,7 +587,7 @@ void TestQgsFileWidget::testStoringSeveralFilesError_data() void TestQgsFileWidget::testStoringSeveralFilesError() { - // test widget when storing several files with an external storage and an error occured + // test widget when storing several files with an external storage and an error occurred QEventLoop loop; QFETCH( bool, useLink );