Skip to content
Permalink
Browse files

Retval -> returns

  • Loading branch information
nyalldawson committed Feb 26, 2019
1 parent 3f73536 commit caff98d8bf203789fb44acea9e1020ee4b6924d5
@@ -144,7 +144,7 @@ Add a few example servers to the list.
%Docstring
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


@@ -135,7 +135,7 @@ class GUI_EXPORT QgsOWSSourceSelect : public QgsAbstractDataSourceWidget, protec
/**
* \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();

@@ -102,7 +102,7 @@ class QgsWcsCapabilities : public QObject
*
* \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
*/
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
* \param uri uri to prepare
* \retval prepared uri
* \returns prepared 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
*
* \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
*
* When this returns, "layers" will make sense.
@@ -204,7 +204,7 @@ class QgsWcsProvider : public QgsRasterDataProvider, QgsGdalProviderBase
/**
* \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
*/
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
* \param uri uri to prepare
* \retval prepared uri
* \returns prepared uri
*/
QString prepareUri( QString uri ) const;

@@ -639,7 +639,7 @@ class QgsWmsCapabilities
/**
* \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
*/
@@ -656,7 +656,7 @@ class QgsWmsCapabilities
/**
* \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; }

@@ -225,7 +225,7 @@ class QgsWmsProvider : public QgsRasterDataProvider
/**
* \brief Prepare the URI so that we can later simply append param=value
* \param uri uri to prepare
* \retval prepared uri
* \returns prepared 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
* 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
*
* 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
*
* \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
*/
bool calculateExtent() const;
@@ -137,7 +137,7 @@ class QgsWMSSourceSelect : public QgsAbstractDataSourceWidget, private Ui::QgsWM
/**
* \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
*/
bool populateLayerList( const QgsWmsCapabilities &capabilities );

0 comments on commit caff98d

Please sign in to comment.
You can’t perform that action at this time.