Skip to content

Commit

Permalink
Remove invalid return from API doc, remove some redundant inclusions
Browse files Browse the repository at this point in the history
  • Loading branch information
nyalldawson committed Aug 2, 2017
1 parent fa1d2be commit 820e342
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 10 deletions.
6 changes: 1 addition & 5 deletions python/core/qgsmaplayer.sip
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -90,8 +90,7 @@ Returns the layer's unique ID, which is used to access this layer from QgsProjec


void setName( const QString &name ); void setName( const QString &name );
%Docstring %Docstring
Set the display name of the layer Set the display ``name`` of the layer.
\param name new name for the layer
.. versionadded:: 2.16 .. versionadded:: 2.16
.. seealso:: name() .. seealso:: name()
%End %End
Expand All @@ -114,7 +113,6 @@ Returns the layer's unique ID, which is used to access this layer from QgsProjec
QString originalName() const; QString originalName() const;
%Docstring %Docstring
Returns the original name of the layer. Returns the original name of the layer.
:return: the original layer name
:rtype: str :rtype: str
%End %End


Expand All @@ -130,7 +128,6 @@ Returns the layer's unique ID, which is used to access this layer from QgsProjec
%Docstring %Docstring
Returns the short name of the layer Returns the short name of the layer
used by QGIS Server to identify the layer. used by QGIS Server to identify the layer.
:return: the layer short name
.. seealso:: setShortName() .. seealso:: setShortName()
:rtype: str :rtype: str
%End %End
Expand All @@ -139,7 +136,6 @@ Returns the layer's unique ID, which is used to access this layer from QgsProjec
%Docstring %Docstring
Sets the title of the layer Sets the title of the layer
used by QGIS Server in GetCapabilities request. used by QGIS Server in GetCapabilities request.
:return: the layer title
.. seealso:: title() .. seealso:: title()
%End %End


Expand Down
6 changes: 1 addition & 5 deletions src/core/qgsmaplayer.h
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -125,8 +125,7 @@ class CORE_EXPORT QgsMapLayer : public QObject
QString id() const; QString id() const;


/** /**
* Set the display name of the layer * Set the display \a name of the layer.
* \param name new name for the layer
* \since QGIS 2.16 * \since QGIS 2.16
* \see name() * \see name()
*/ */
Expand All @@ -150,7 +149,6 @@ class CORE_EXPORT QgsMapLayer : public QObject
virtual const QgsDataProvider *dataProvider() const SIP_SKIP; virtual const QgsDataProvider *dataProvider() const SIP_SKIP;


/** Returns the original name of the layer. /** Returns the original name of the layer.
* \returns the original layer name
*/ */
QString originalName() const; QString originalName() const;


Expand All @@ -163,14 +161,12 @@ class CORE_EXPORT QgsMapLayer : public QObject


/** Returns the short name of the layer /** Returns the short name of the layer
* used by QGIS Server to identify the layer. * used by QGIS Server to identify the layer.
* \returns the layer short name
* \see setShortName() * \see setShortName()
*/ */
QString shortName() const { return mShortName; } QString shortName() const { return mShortName; }


/** Sets the title of the layer /** Sets the title of the layer
* used by QGIS Server in GetCapabilities request. * used by QGIS Server in GetCapabilities request.
* \returns the layer title
* \see title() * \see title()
*/ */
void setTitle( const QString &title ) { mTitle = title; } void setTitle( const QString &title ) { mTitle = title; }
Expand Down

0 comments on commit 820e342

Please sign in to comment.