From 820e3422c81abc80ff4bab756cad1e868969250a Mon Sep 17 00:00:00 2001 From: Nyall Dawson Date: Thu, 3 Aug 2017 06:46:41 +1000 Subject: [PATCH] Remove invalid return from API doc, remove some redundant inclusions --- python/core/qgsmaplayer.sip | 6 +----- src/core/qgsmaplayer.h | 6 +----- 2 files changed, 2 insertions(+), 10 deletions(-) diff --git a/python/core/qgsmaplayer.sip b/python/core/qgsmaplayer.sip index dce8007cc78..e6e45cdebaa 100644 --- a/python/core/qgsmaplayer.sip +++ b/python/core/qgsmaplayer.sip @@ -90,8 +90,7 @@ Returns the layer's unique ID, which is used to access this layer from QgsProjec void setName( const QString &name ); %Docstring - Set the display name of the layer - \param name new name for the layer + Set the display ``name`` of the layer. .. versionadded:: 2.16 .. seealso:: name() %End @@ -114,7 +113,6 @@ Returns the layer's unique ID, which is used to access this layer from QgsProjec QString originalName() const; %Docstring Returns the original name of the layer. - :return: the original layer name :rtype: str %End @@ -130,7 +128,6 @@ Returns the layer's unique ID, which is used to access this layer from QgsProjec %Docstring Returns the short name of the layer used by QGIS Server to identify the layer. - :return: the layer short name .. seealso:: setShortName() :rtype: str %End @@ -139,7 +136,6 @@ Returns the layer's unique ID, which is used to access this layer from QgsProjec %Docstring Sets the title of the layer used by QGIS Server in GetCapabilities request. - :return: the layer title .. seealso:: title() %End diff --git a/src/core/qgsmaplayer.h b/src/core/qgsmaplayer.h index 5a4ca525b4b..d2e5f1f10a9 100644 --- a/src/core/qgsmaplayer.h +++ b/src/core/qgsmaplayer.h @@ -125,8 +125,7 @@ class CORE_EXPORT QgsMapLayer : public QObject QString id() const; /** - * Set the display name of the layer - * \param name new name for the layer + * Set the display \a name of the layer. * \since QGIS 2.16 * \see name() */ @@ -150,7 +149,6 @@ class CORE_EXPORT QgsMapLayer : public QObject virtual const QgsDataProvider *dataProvider() const SIP_SKIP; /** Returns the original name of the layer. - * \returns the original layer name */ QString originalName() const; @@ -163,14 +161,12 @@ class CORE_EXPORT QgsMapLayer : public QObject /** Returns the short name of the layer * used by QGIS Server to identify the layer. - * \returns the layer short name * \see setShortName() */ QString shortName() const { return mShortName; } /** Sets the title of the layer * used by QGIS Server in GetCapabilities request. - * \returns the layer title * \see title() */ void setTitle( const QString &title ) { mTitle = title; }