Skip to content

Commit ffddc9a

Browse files
committedJul 23, 2018
Update doc for QgsServerParameters
1 parent 32256bc commit ffddc9a

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed
 

‎python/server/auto_generated/qgsserverparameters.sip.in

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,13 @@ Removes a parameter.
142142
%End
143143

144144
void remove( QgsServerParameter::Name name );
145+
%Docstring
146+
Removes a parameter.
147+
148+
:param name: The name of the parameter
149+
150+
.. versionadded:: 3.4
151+
%End
145152

146153
QString value( const QString &key ) const;
147154
%Docstring
@@ -201,7 +208,12 @@ defined.
201208
%End
202209

203210
protected:
211+
204212
virtual bool loadParameter( const QString &name, const QString &value );
213+
%Docstring
214+
Loads a parameter with a specific value. This method should be
215+
implemented in subclasses.
216+
%End
205217

206218

207219
};

‎src/server/qgsserverparameters.h

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,11 @@ class SERVER_EXPORT QgsServerParameters
131131
*/
132132
void remove( const QString &key );
133133

134+
/**
135+
* Removes a parameter.
136+
* \param name The name of the parameter
137+
* \since QGIS 3.4
138+
*/
134139
void remove( QgsServerParameter::Name name );
135140

136141
/**
@@ -185,6 +190,11 @@ class SERVER_EXPORT QgsServerParameters
185190
QString version() const;
186191

187192
protected:
193+
194+
/**
195+
* Loads a parameter with a specific value. This method should be
196+
* implemented in subclasses.
197+
*/
188198
virtual bool loadParameter( const QString &name, const QString &value );
189199

190200
QMap<QString, QString> mUnmanagedParameters;

0 commit comments

Comments
 (0)
Please sign in to comment.