Skip to content

Commit f756671

Browse files
rldhontrldhont
committed
[Doc] Update QgsMapLayer documentation
Add documentation string to 10 QgsMapLayer methods.
1 parent 7afa9e3 commit f756671

File tree

3 files changed

+195
-3
lines changed

3 files changed

+195
-3
lines changed

‎python/core/qgsmaplayer.sip‎

Lines changed: 97 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,36 +71,132 @@ class QgsMapLayer : QObject
7171
*/
7272
QString name() const;
7373

74-
/** Get the original name of the layer */
74+
/** Get the original name of the layer
75+
* @return the original layer name
76+
*/
7577
QString originalName() const;
7678

79+
/** Set the title of the layer
80+
* used by QGIS Server in GetCapabilities request
81+
* @return the layer title
82+
*/
7783
void setTitle( const QString& title );
84+
/** Get the title of the layer
85+
* used by QGIS Server in GetCapabilities request
86+
* @return the layer title
87+
*/
7888
QString title() const;
7989

90+
/** Set the abstract of the layer
91+
* used by QGIS Server in GetCapabilities request
92+
* @return the layer abstract
93+
*/
8094
void setAbstract( const QString& abstract );
95+
/** Get the abstract of the layer
96+
* used by QGIS Server in GetCapabilities request
97+
* @return the layer abstract
98+
*/
8199
QString abstract() const;
82100

101+
/** Set the keyword list of the layer
102+
* used by QGIS Server in GetCapabilities request
103+
* @return the layer keyword list
104+
*/
83105
void setKeywordList( const QString& keywords );
106+
/** Get the keyword list of the layer
107+
* used by QGIS Server in GetCapabilities request
108+
* @return the layer keyword list
109+
*/
84110
QString keywordList() const;
85111

86112
/* Layer dataUrl information */
113+
/** Set the DataUrl of the layer
114+
* used by QGIS Server in GetCapabilities request
115+
* DataUrl is a a link to the underlying data represented by a particular layer
116+
* @return the layer DataUrl
117+
*/
87118
void setDataUrl( const QString& dataUrl );
119+
/** Get the DataUrl of the layer
120+
* used by QGIS Server in GetCapabilities request
121+
* DataUrl is a a link to the underlying data represented by a particular layer
122+
* @return the layer DataUrl
123+
*/
88124
QString dataUrl() const;
125+
/** Set the DataUrl format of the layer
126+
* used by QGIS Server in GetCapabilities request
127+
* DataUrl is a a link to the underlying data represented by a particular layer
128+
* @return the layer DataUrl format
129+
*/
89130
void setDataUrlFormat( const QString& dataUrlFormat );
131+
/** Get the DataUrl format of the layer
132+
* used by QGIS Server in GetCapabilities request
133+
* DataUrl is a a link to the underlying data represented by a particular layer
134+
* @return the layer DataUrl format
135+
*/
90136
QString dataUrlFormat() const;
91137

92138
/* Layer attribution information */
139+
/** Set the attribution of the layer
140+
* used by QGIS Server in GetCapabilities request
141+
* Attribution indicates the provider of a Layer or collection of Layers.
142+
* @return the layer attribution
143+
*/
93144
void setAttribution( const QString& attrib );
145+
/** Get the attribution of the layer
146+
* used by QGIS Server in GetCapabilities request
147+
* Attribution indicates the provider of a Layer or collection of Layers.
148+
* @return the layer attribution
149+
*/
94150
QString attribution() const;
151+
/** Set the attribution URL of the layer
152+
* used by QGIS Server in GetCapabilities request
153+
* Attribution indicates the provider of a Layer or collection of Layers.
154+
* @return the layer attribution URL
155+
*/
95156
void setAttributionUrl( const QString& attribUrl );
157+
/** Get the attribution URL of the layer
158+
* used by QGIS Server in GetCapabilities request
159+
* Attribution indicates the provider of a Layer or collection of Layers.
160+
* @return the layer attribution URL
161+
*/
96162
QString attributionUrl() const;
97163

98164
/* Layer metadataUrl information */
165+
/** Set the metadata URL of the layer
166+
* used by QGIS Server in GetCapabilities request
167+
* MetadataUrl is a a link to the detailed, standardized metadata about the data.
168+
* @return the layer metadata URL
169+
*/
99170
void setMetadataUrl( const QString& metaUrl );
171+
/** Get the metadata URL of the layer
172+
* used by QGIS Server in GetCapabilities request
173+
* MetadataUrl is a a link to the detailed, standardized metadata about the data.
174+
* @return the layer metadata URL
175+
*/
100176
QString metadataUrl() const;
177+
/** Set the metadata type of the layer
178+
* used by QGIS Server in GetCapabilities request
179+
* MetadataUrlType indicates the standard to which the metadata complies.
180+
* @return the layer metadata type
181+
*/
101182
void setMetadataUrlType( const QString& metaUrlType );
183+
/** Get the metadata type of the layer
184+
* used by QGIS Server in GetCapabilities request
185+
* MetadataUrlType indicates the standard to which the metadata complies.
186+
* @return the layer metadata type
187+
*/
102188
QString metadataUrlType() const;
189+
/** Set the metadata format of the layer
190+
* used by QGIS Server in GetCapabilities request
191+
* MetadataUrlType indicates how the metadata is structured.
192+
* @return the layer metadata format
193+
*/
103194
void setMetadataUrlFormat( const QString& metaUrlFormat );
195+
/** Get the metadata format of the layer
196+
* used by QGIS Server in GetCapabilities request
197+
* MetadataUrlType indicates how the metadata is structured.
198+
* @return the layer metadata format
199+
*/
104200
QString metadataUrlFormat() const;
105201

106202
/** Set the blending mode used for rendering a layer */

‎src/core/qgsmaplayer.h‎

Lines changed: 97 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,36 +87,132 @@ class CORE_EXPORT QgsMapLayer : public QObject
8787
*/
8888
QString name() const;
8989

90-
/** Get the original name of the layer */
90+
/** Get the original name of the layer
91+
* @return the original layer name
92+
*/
9193
QString originalName() const { return mLayerOrigName; }
9294

95+
/** Set the title of the layer
96+
* used by QGIS Server in GetCapabilities request
97+
* @return the layer title
98+
*/
9399
void setTitle( const QString& title ) { mTitle = title; }
100+
/** Get the title of the layer
101+
* used by QGIS Server in GetCapabilities request
102+
* @return the layer title
103+
*/
94104
QString title() const { return mTitle; }
95105

106+
/** Set the abstract of the layer
107+
* used by QGIS Server in GetCapabilities request
108+
* @return the layer abstract
109+
*/
96110
void setAbstract( const QString& abstract ) { mAbstract = abstract; }
111+
/** Get the abstract of the layer
112+
* used by QGIS Server in GetCapabilities request
113+
* @return the layer abstract
114+
*/
97115
QString abstract() const { return mAbstract; }
98116

117+
/** Set the keyword list of the layer
118+
* used by QGIS Server in GetCapabilities request
119+
* @return the layer keyword list
120+
*/
99121
void setKeywordList( const QString& keywords ) { mKeywordList = keywords; }
122+
/** Get the keyword list of the layer
123+
* used by QGIS Server in GetCapabilities request
124+
* @return the layer keyword list
125+
*/
100126
QString keywordList() const { return mKeywordList; }
101127

102128
/* Layer dataUrl information */
129+
/** Set the DataUrl of the layer
130+
* used by QGIS Server in GetCapabilities request
131+
* DataUrl is a a link to the underlying data represented by a particular layer
132+
* @return the layer DataUrl
133+
*/
103134
void setDataUrl( const QString& dataUrl ) { mDataUrl = dataUrl; }
135+
/** Get the DataUrl of the layer
136+
* used by QGIS Server in GetCapabilities request
137+
* DataUrl is a a link to the underlying data represented by a particular layer
138+
* @return the layer DataUrl
139+
*/
104140
QString dataUrl() const { return mDataUrl; }
141+
/** Set the DataUrl format of the layer
142+
* used by QGIS Server in GetCapabilities request
143+
* DataUrl is a a link to the underlying data represented by a particular layer
144+
* @return the layer DataUrl format
145+
*/
105146
void setDataUrlFormat( const QString& dataUrlFormat ) { mDataUrlFormat = dataUrlFormat; }
147+
/** Get the DataUrl format of the layer
148+
* used by QGIS Server in GetCapabilities request
149+
* DataUrl is a a link to the underlying data represented by a particular layer
150+
* @return the layer DataUrl format
151+
*/
106152
QString dataUrlFormat() const { return mDataUrlFormat; }
107153

108154
/* Layer attribution information */
155+
/** Set the attribution of the layer
156+
* used by QGIS Server in GetCapabilities request
157+
* Attribution indicates the provider of a Layer or collection of Layers.
158+
* @return the layer attribution
159+
*/
109160
void setAttribution( const QString& attrib ) { mAttribution = attrib; }
161+
/** Get the attribution of the layer
162+
* used by QGIS Server in GetCapabilities request
163+
* Attribution indicates the provider of a Layer or collection of Layers.
164+
* @return the layer attribution
165+
*/
110166
QString attribution() const { return mAttribution; }
167+
/** Set the attribution URL of the layer
168+
* used by QGIS Server in GetCapabilities request
169+
* Attribution indicates the provider of a Layer or collection of Layers.
170+
* @return the layer attribution URL
171+
*/
111172
void setAttributionUrl( const QString& attribUrl ) { mAttributionUrl = attribUrl; }
173+
/** Get the attribution URL of the layer
174+
* used by QGIS Server in GetCapabilities request
175+
* Attribution indicates the provider of a Layer or collection of Layers.
176+
* @return the layer attribution URL
177+
*/
112178
QString attributionUrl() const { return mAttributionUrl; }
113179

114180
/* Layer metadataUrl information */
181+
/** Set the metadata URL of the layer
182+
* used by QGIS Server in GetCapabilities request
183+
* MetadataUrl is a a link to the detailed, standardized metadata about the data.
184+
* @return the layer metadata URL
185+
*/
115186
void setMetadataUrl( const QString& metaUrl ) { mMetadataUrl = metaUrl; }
187+
/** Get the metadata URL of the layer
188+
* used by QGIS Server in GetCapabilities request
189+
* MetadataUrl is a a link to the detailed, standardized metadata about the data.
190+
* @return the layer metadata URL
191+
*/
116192
QString metadataUrl() const { return mMetadataUrl; }
193+
/** Set the metadata type of the layer
194+
* used by QGIS Server in GetCapabilities request
195+
* MetadataUrlType indicates the standard to which the metadata complies.
196+
* @return the layer metadata type
197+
*/
117198
void setMetadataUrlType( const QString& metaUrlType ) { mMetadataUrlType = metaUrlType; }
199+
/** Get the metadata type of the layer
200+
* used by QGIS Server in GetCapabilities request
201+
* MetadataUrlType indicates the standard to which the metadata complies.
202+
* @return the layer metadata type
203+
*/
118204
QString metadataUrlType() const { return mMetadataUrlType; }
205+
/** Set the metadata format of the layer
206+
* used by QGIS Server in GetCapabilities request
207+
* MetadataUrlType indicates how the metadata is structured.
208+
* @return the layer metadata format
209+
*/
119210
void setMetadataUrlFormat( const QString& metaUrlFormat ) { mMetadataUrlFormat = metaUrlFormat; }
211+
/** Get the metadata format of the layer
212+
* used by QGIS Server in GetCapabilities request
213+
* MetadataUrlType indicates how the metadata is structured.
214+
* @return the layer metadata format
215+
*/
120216
QString metadataUrlFormat() const { return mMetadataUrlFormat; }
121217

122218
/** Set the blending mode used for rendering a layer */

‎tests/src/python/test_qgsdoccoverage.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
# DON'T RAISE THIS THRESHOLD!!!
2828
# (changes which lower this threshold are welcomed though!)
2929

30-
ACCEPTABLE_MISSING_DOCS = 3827
30+
ACCEPTABLE_MISSING_DOCS = 3807
3131

3232

3333
class TestQgsDocCoverage(TestCase):

0 commit comments

Comments
 (0)