sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-04-18 00:03:05 -04:00
Code Issues Packages Projects Releases Wiki Activity

Retval -> returns

Browse Source
This commit is contained in:
Nyall Dawson 2019-02-26 21:05:33 +10:00
parent 3f735368f6
commit caff98d8bf
7 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
python/gui/auto_generated/qgsowssourceselect.sip.in
View File

@ -144,7 +144,7 @@ Add a few example servers to the list.
%Docstring %Docstring
Populate the layer list. Populate the layer list.
\retval ``False`` if the layers could not be retrieved or parsed :return: ``False`` if the layers could not be retrieved or parsed
%End %End

2
src/gui/qgsowssourceselect.h
View File

@ -135,7 +135,7 @@ class GUI_EXPORT QgsOWSSourceSelect : public QgsAbstractDataSourceWidget, protec
/** /**
* \brief Populate the layer list. * \brief Populate the layer list.
* *
* \retval FALSE if the layers could not be retrieved or parsed * \returns FALSE if the layers could not be retrieved or parsed
*/ */
virtual void populateLayerList(); virtual void populateLayerList();

6
src/providers/wcs/qgswcscapabilities.h
View File

@ -102,7 +102,7 @@ class QgsWcsCapabilities : public QObject
* *
* \param[out] layers The list of layers will be placed here. * \param[out] layers The list of layers will be placed here.
* *
* \retval false if the layers could not be retrieved or parsed - * \returns false if the layers could not be retrieved or parsed -
* see lastError() for more info * see lastError() for more info
*/ */
bool supportedCoverages( QVector<QgsWcsCoverageSummary> &coverageSummary ); bool supportedCoverages( QVector<QgsWcsCoverageSummary> &coverageSummary );
@ -121,7 +121,7 @@ class QgsWcsCapabilities : public QObject
/** /**
* \brief Prepare the URI so that we can later simply append param=value * \brief Prepare the URI so that we can later simply append param=value
* \param uri uri to prepare * \param uri uri to prepare
* \retval prepared uri * \returns prepared uri
*/ */
static QString prepareUri( QString uri ); static QString prepareUri( QString uri );
@ -247,7 +247,7 @@ class QgsWcsCapabilities : public QObject
* *
* \param preferredVersion - optional version, e.g. 1.0.0, 1.1.0 * \param preferredVersion - optional version, e.g. 1.0.0, 1.1.0
* *
* \retval false if the capabilities document could not be retrieved or parsed - * \returns false if the capabilities document could not be retrieved or parsed -
* see lastError() for more info * see lastError() for more info
* *
* When this returns, "layers" will make sense. * When this returns, "layers" will make sense.

4
src/providers/wcs/qgswcsprovider.h
View File

@ -204,7 +204,7 @@ class QgsWcsProvider : public QgsRasterDataProvider, QgsGdalProviderBase
/** /**
* \brief Calculates the combined extent of the layers selected by layersDrawn * \brief Calculates the combined extent of the layers selected by layersDrawn
* *
* \retval false if the capabilities document could not be retrieved or parsed - * \returns false if the capabilities document could not be retrieved or parsed -
* see lastError() for more info * see lastError() for more info
*/ */
bool calculateExtent() const; bool calculateExtent() const;
@ -222,7 +222,7 @@ class QgsWcsProvider : public QgsRasterDataProvider, QgsGdalProviderBase
/** /**
* \brief Prepare the URI so that we can later simply append param=value * \brief Prepare the URI so that we can later simply append param=value
* \param uri uri to prepare * \param uri uri to prepare
* \retval prepared uri * \returns prepared uri
*/ */
QString prepareUri( QString uri ) const; QString prepareUri( QString uri ) const;

4
src/providers/wms/qgswmscapabilities.h
View File

@ -639,7 +639,7 @@ class QgsWmsCapabilities
/** /**
* \brief Returns a list of the supported layers of the WMS server * \brief Returns a list of the supported layers of the WMS server
* *
* \retval The list of layers will be placed here. * \returns The list of layers will be placed here.
* *
* \todo Document this better * \todo Document this better
*/ */
@ -656,7 +656,7 @@ class QgsWmsCapabilities
/** /**
* \brief Returns a list of the supported tile layers of the WMS server * \brief Returns a list of the supported tile layers of the WMS server
* *
* \retval The list of tile sets will be placed here. * \returns The list of tile sets will be placed here.
*/ */
QList<QgsWmtsTileLayer> supportedTileLayers() const { return mTileLayersSupported; } QList<QgsWmtsTileLayer> supportedTileLayers() const { return mTileLayersSupported; }

6
src/providers/wms/qgswmsprovider.h
View File

@ -225,7 +225,7 @@ class QgsWmsProvider : public QgsRasterDataProvider
/** /**
* \brief Prepare the URI so that we can later simply append param=value * \brief Prepare the URI so that we can later simply append param=value
* \param uri uri to prepare * \param uri uri to prepare
* \retval prepared uri * \returns prepared uri
*/ */
static QString prepareUri( QString uri ); static QString prepareUri( QString uri );
@ -294,7 +294,7 @@ class QgsWmsProvider : public QgsRasterDataProvider
* *
* \param forceRefresh if true, ignores any previous response cached in memory * \param forceRefresh if true, ignores any previous response cached in memory
* and always contact the server for a new copy. * and always contact the server for a new copy.
* \retval false if the capabilities document could not be retrieved or parsed - * \returns false if the capabilities document could not be retrieved or parsed -
* see lastError() for more info * see lastError() for more info
* *
* When this returns, "layers" will make sense. * When this returns, "layers" will make sense.
@ -311,7 +311,7 @@ class QgsWmsProvider : public QgsRasterDataProvider
/** /**
* \brief Calculates the combined extent of the layers selected by layersDrawn * \brief Calculates the combined extent of the layers selected by layersDrawn
* *
* \retval false if the capabilities document could not be retrieved or parsed - * \returns false if the capabilities document could not be retrieved or parsed -
* see lastError() for more info * see lastError() for more info
*/ */
bool calculateExtent() const; bool calculateExtent() const;

2
src/providers/wms/qgswmssourceselect.h
View File

@ -137,7 +137,7 @@ class QgsWMSSourceSelect : public QgsAbstractDataSourceWidget, private Ui::QgsWM
/** /**
* \brief Populate the layer list - private for now. * \brief Populate the layer list - private for now.
* *
* \retval false if the layers could not be retrieved or parsed - * \returns FALSE if the layers could not be retrieved or parsed -
* see mWmsProvider->errorString() for more info * see mWmsProvider->errorString() for more info
*/ */
bool populateLayerList( const QgsWmsCapabilities &capabilities ); bool populateLayerList( const QgsWmsCapabilities &capabilities );