Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions python/PyQt6/server/auto_generated/qgsserverogcapi.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ as instances of :py:class:`QgsServerOgcApiHandler`.
"""A handler, see QgsServerOgcApiHandler for an example"""
...

h = Handler1()
api = QgsServerOgcApi(serverInterface(), "/api1", "apione", "A firs API", "1.0")
api.registerHandler(h)
server.serverInterface().serviceRegistry().registerApi(api)
h = Handler1()
api = QgsServerOgcApi(serverInterface(), "/api1", "apione", "A first API", "1.0")
api.registerHandler(h)
server.serverInterface().serviceRegistry().registerApi(api)



Expand Down
20 changes: 10 additions & 10 deletions python/PyQt6/server/auto_generated/qgsserverogcapihandler.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -41,31 +41,31 @@ Optionally, override:
"""Example handler"""

def path(self):
return QtCore.QRegularExpression("/handlerone")
return QtCore.QRegularExpression("/handlerone")

def operationId(self):
return "handlerOne"
return "handlerOne"

def summary(self):
return "First of its name"
return "First of its name"

def description(self):
return "The first handler ever"
return "The first handler ever"

def linkTitle(self):
return "Handler One Link Title"
return "Handler One Link Title"

def linkType(self):
return QgsServerOgcApi.data
return QgsServerOgcApi.data

def handleRequest(self, context):
"""Simple mirror: returns the parameters"""
"""Simple mirror: returns the parameters"""

params = self.values(context)
self.write(params, context)
params = self.values(context)
self.write(params, context)

def parameters(self, context):
return [QgsServerQueryStringParameter("value1", True, QgsServerQueryStringParameter.Type.Double, "a double value")]
return [QgsServerQueryStringParameter("value1", True, QgsServerQueryStringParameter.Type.Double, "a double value")]



Expand Down
8 changes: 4 additions & 4 deletions python/server/auto_generated/qgsserverogcapi.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ as instances of :py:class:`QgsServerOgcApiHandler`.
"""A handler, see QgsServerOgcApiHandler for an example"""
...

h = Handler1()
api = QgsServerOgcApi(serverInterface(), "/api1", "apione", "A firs API", "1.0")
api.registerHandler(h)
server.serverInterface().serviceRegistry().registerApi(api)
h = Handler1()
api = QgsServerOgcApi(serverInterface(), "/api1", "apione", "A first API", "1.0")
api.registerHandler(h)
server.serverInterface().serviceRegistry().registerApi(api)



Expand Down
20 changes: 10 additions & 10 deletions python/server/auto_generated/qgsserverogcapihandler.sip.in
Original file line number Diff line number Diff line change
Expand Up @@ -41,31 +41,31 @@ Optionally, override:
"""Example handler"""

def path(self):
return QtCore.QRegularExpression("/handlerone")
return QtCore.QRegularExpression("/handlerone")

def operationId(self):
return "handlerOne"
return "handlerOne"

def summary(self):
return "First of its name"
return "First of its name"

def description(self):
return "The first handler ever"
return "The first handler ever"

def linkTitle(self):
return "Handler One Link Title"
return "Handler One Link Title"

def linkType(self):
return QgsServerOgcApi.data
return QgsServerOgcApi.data

def handleRequest(self, context):
"""Simple mirror: returns the parameters"""
"""Simple mirror: returns the parameters"""

params = self.values(context)
self.write(params, context)
params = self.values(context)
self.write(params, context)

def parameters(self, context):
return [QgsServerQueryStringParameter("value1", True, QgsServerQueryStringParameter.Type.Double, "a double value")]
return [QgsServerQueryStringParameter("value1", True, QgsServerQueryStringParameter.Type.Double, "a double value")]



Expand Down
2 changes: 1 addition & 1 deletion scripts/sipify.pl
Original file line number Diff line number Diff line change
Expand Up @@ -642,7 +642,7 @@ sub processDoxygenLine {
if ( $line =~ m/\\code(\{\.?(\w+)\})?/ ) {
my $codelang = "";
$codelang = " $2" if (defined $2);
$codelang =~ m/(cpp|py|unparsed)/ or exit_with_error("invalid code snippet format: $codelang");
$codelang =~ m/(cpp|html|py|unparsed)/ or exit_with_error("invalid code snippet format: $codelang");
$COMMENT_CODE_SNIPPET = CODE_SNIPPET;
$COMMENT_CODE_SNIPPET = CODE_SNIPPET_CPP if ($codelang =~ m/cpp/ );
$codelang =~ s/py/python/;
Expand Down
4 changes: 2 additions & 2 deletions src/analysis/processing/qgsalgorithmbatchgeocode.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class QgsGeocoderInterface;
* ### Example
*
* \code{.py}
* # create a class which implements the QgsGeocoderInterface interface:
* # create a class which implements the QgsGeocoderInterface interface
* class MyGeocoder(QgsGeocoderInterface):
*
* def geocodeString(self, string, context, feedback):
Expand All @@ -57,7 +57,7 @@ class QgsGeocoderInterface;
* def createInstance(self):
* return MyGeocoderAlgorithm()
*
* # optionally, the group(), groupId(), tags(), shortHelpString() and other metadata style methods can be overridden and customized:
* # optionally, the group(), groupId(), tags(), shortHelpString() and other metadata style methods can be overridden and customized
* def tags(self):
* return 'geocode,my service,batch'
*
Expand Down
30 changes: 18 additions & 12 deletions src/core/actions/qgsactionscope.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,23 @@
* Examples:
* ---------
*
* <dl>
* <dt>Canvas</dt>
* <dd>Show for canvas tools. Adds `@click_x` and `@click_y` in map coordinates.</dd>
* <dt>Feature</dt>
* <dd>Show in feature specific places like the attribute table or feature
* form.</dd>
* <dt>Field</dt>
* <dd>Show in context menus for individual fields (e.g. attribute table). Adds `@field_index`, `@field_name` and `@field_value`.</dd>
* <dt>Layer</dt>
* <dd>Show in attribute table and work on the layer or selection.</dd>
* </dl>
* \code{.html}
*
* <dl>
* <dt>Canvas</dt>
* <dd>Show for canvas tools. Adds `@click_x` and `@click_y` in map coordinates.</dd>
* <dt>Feature</dt>
* <dd>Show in feature specific places like the attribute table or feature
* form.</dd>
* <dt>Field</dt>
* <dd>Show in context menus for individual fields (e.g. attribute table). Adds `@field_index`, `@field_name` and `@field_value`.</dd>
* <dt>Layer</dt>
* <dd>Show in attribute table and work on the layer or selection.</dd>
* <dt>Form</dt>
* <dd>Show in a feature form designed using the drag-and-drop mode.</dd>
* </dl>
*
* \endcode
*
*/
class CORE_EXPORT QgsActionScope
Expand Down Expand Up @@ -72,7 +78,7 @@ class CORE_EXPORT QgsActionScope

/**
* An expression scope may offer additional variables for an action scope.
* This can be an `field_name` for the attribute which was clicked or
* This can be a `field_name` for the attribute which was clicked or
* `click_x` and `click_y` for actions which are available as map canvas clicks.
*
*/
Expand Down
8 changes: 4 additions & 4 deletions src/server/qgsserverogcapi.h
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ class QgsServerOgcApiHandler;
* """A handler, see QgsServerOgcApiHandler for an example"""
* ...
*
* h = Handler1()
* api = QgsServerOgcApi(serverInterface(), "/api1", "apione", "A firs API", "1.0")
* api.registerHandler(h)
* server.serverInterface().serviceRegistry().registerApi(api)
* h = Handler1()
* api = QgsServerOgcApi(serverInterface(), "/api1", "apione", "A first API", "1.0")
* api.registerHandler(h)
* server.serverInterface().serviceRegistry().registerApi(api)
*
* \endcode
*
Expand Down
20 changes: 10 additions & 10 deletions src/server/qgsserverogcapihandler.h
Original file line number Diff line number Diff line change
Expand Up @@ -56,34 +56,34 @@ class QgsServerApiContext;
*
* \code{.py}
*
* class Handler1(QgsServerOgcApiHandler):
* """Example handler"""
* class Handler1(QgsServerOgcApiHandler):
* """Example handler"""
*
* def path(self):
* def path(self):
* return QtCore.QRegularExpression("/handlerone")
*
* def operationId(self):
* def operationId(self):
* return "handlerOne"
*
* def summary(self):
* def summary(self):
* return "First of its name"
*
* def description(self):
* def description(self):
* return "The first handler ever"
*
* def linkTitle(self):
* def linkTitle(self):
* return "Handler One Link Title"
*
* def linkType(self):
* def linkType(self):
* return QgsServerOgcApi.data
*
* def handleRequest(self, context):
* def handleRequest(self, context):
* """Simple mirror: returns the parameters"""
*
* params = self.values(context)
* self.write(params, context)
*
* def parameters(self, context):
* def parameters(self, context):
* return [QgsServerQueryStringParameter("value1", True, QgsServerQueryStringParameter.Type.Double, "a double value")]
*
*
Expand Down