Skip to content

Commit 820e342

Browse files
committed
Remove invalid return from API doc, remove some redundant inclusions
1 parent fa1d2be commit 820e342

File tree

2 files changed

+2
-10
lines changed

2 files changed

+2
-10
lines changed

python/core/qgsmaplayer.sip

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,7 @@ Returns the layer's unique ID, which is used to access this layer from QgsProjec
9090

9191
void setName( const QString &name );
9292
%Docstring
93-
Set the display name of the layer
94-
\param name new name for the layer
93+
Set the display ``name`` of the layer.
9594
.. versionadded:: 2.16
9695
.. seealso:: name()
9796
%End
@@ -114,7 +113,6 @@ Returns the layer's unique ID, which is used to access this layer from QgsProjec
114113
QString originalName() const;
115114
%Docstring
116115
Returns the original name of the layer.
117-
:return: the original layer name
118116
:rtype: str
119117
%End
120118

@@ -130,7 +128,6 @@ Returns the layer's unique ID, which is used to access this layer from QgsProjec
130128
%Docstring
131129
Returns the short name of the layer
132130
used by QGIS Server to identify the layer.
133-
:return: the layer short name
134131
.. seealso:: setShortName()
135132
:rtype: str
136133
%End
@@ -139,7 +136,6 @@ Returns the layer's unique ID, which is used to access this layer from QgsProjec
139136
%Docstring
140137
Sets the title of the layer
141138
used by QGIS Server in GetCapabilities request.
142-
:return: the layer title
143139
.. seealso:: title()
144140
%End
145141

src/core/qgsmaplayer.h

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -125,8 +125,7 @@ class CORE_EXPORT QgsMapLayer : public QObject
125125
QString id() const;
126126

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

152151
/** Returns the original name of the layer.
153-
* \returns the original layer name
154152
*/
155153
QString originalName() const;
156154

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

164162
/** Returns the short name of the layer
165163
* used by QGIS Server to identify the layer.
166-
* \returns the layer short name
167164
* \see setShortName()
168165
*/
169166
QString shortName() const { return mShortName; }
170167

171168
/** Sets the title of the layer
172169
* used by QGIS Server in GetCapabilities request.
173-
* \returns the layer title
174170
* \see title()
175171
*/
176172
void setTitle( const QString &title ) { mTitle = title; }

0 commit comments

Comments
 (0)