Code layout and sip

qgis · Aug 6, 2020 · de83d28 · de83d28
1 parent 43ed8f6
commit de83d28
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 2 deletions.
diff --git a/python/server/auto_generated/qgsserverstatichandler.sip.in b/python/server/auto_generated/qgsserverstatichandler.sip.in
@@ -0,0 +1,55 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/server/qgsserverstatichandler.h                                  *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+class QgsServerStaticHandler: QgsServerOgcApiHandler
+{
+%Docstring
+The QgsServerStaticHandler class serves static files from the static path (resources/server/api/wfs3/static)
+
+.. seealso:: :py:func:`QgsServerOgcApiHandler.staticPath`
+
+.. versionadded:: 3.16
+%End
+
+%TypeHeaderCode
+#include "qgsserverstatichandler.h"
+%End
+  public:
+
+    QgsServerStaticHandler( const QString &pathRegExp = QStringLiteral( R"re(/static/(?<staticFilePath>.*)$)re" ), const QString &staticPathSuffix = QString( ) );
+%Docstring
+Creates QgsServerStaticHandler
+
+:param pathRegExp: optional regular expression to capture static file names, defaults to "/static/(?<staticFilePath>.*)$",
+                   note that the file path is captured in a named group "staticFilePath"
+:param staticPathSuffix: optional path suffix to use when static files are stored in a subdirectory of the default :py:func:`~QgsServerStaticHandler.staticPath`
+
+.. seealso:: :py:func:`QgsServerOgcApiHandler.staticPath`
+%End
+
+    virtual void handleRequest( const QgsServerApiContext &context ) const;
+
+
+    virtual QRegularExpression path() const;
+    virtual std::string operationId() const;
+    virtual std::string summary() const;
+    virtual std::string description() const;
+    virtual std::string linkTitle() const;
+    virtual QgsServerOgcApi::Rel linkType() const;
+
+};
+
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/server/qgsserverstatichandler.h                                  *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
diff --git a/python/server/server_auto.sip b/python/server/server_auto.sip
@@ -6,6 +6,7 @@
 %Include auto_generated/qgsserverlogger.sip
 %Include auto_generated/qgsserverogcapi.sip
 %Include auto_generated/qgsserverogcapihandler.sip
+%Include auto_generated/qgsserverstatichandler.sip
 %Include auto_generated/qgsserverparameters.sip
 %Include auto_generated/qgsserverquerystringparameter.sip
 %Include auto_generated/qgsserversettings.sip

diff --git a/src/server/qgsserverstatichandler.h b/src/server/qgsserverstatichandler.h
@@ -20,6 +20,7 @@
 #include "qgis_server.h"
 
 /**
+ * \ingroup server
  * The QgsServerStaticHandler class serves static files from the static path (resources/server/api/wfs3/static)
  * \see QgsServerOgcApiHandler::staticPath()
  * \since QGIS 3.16
@@ -32,8 +33,8 @@ class SERVER_EXPORT QgsServerStaticHandler: public QgsServerOgcApiHandler
      * Creates QgsServerStaticHandler
      * \param pathRegExp optional regular expression to capture static file names, defaults to "/static/(?<staticFilePath>.*)$",
      *        note that the file path is captured in a named group "staticFilePath"
-     * \param staticPathSuffix optional path suffix to use when static files are stored in a subpath of the default staticPath()
-     * \see staticPath()
+     * \param staticPathSuffix optional path suffix to use when static files are stored in a subdirectory of the default staticPath()
+     * \see QgsServerOgcApiHandler::staticPath()
      */
     QgsServerStaticHandler( const QString &pathRegExp = QStringLiteral( R"re(/static/(?<staticFilePath>.*)$)re" ), const QString &staticPathSuffix = QString( ) );