Skip to content
Permalink
Browse files

Added documentation and QgsServer to doxy template

  • Loading branch information
elpaso committed May 30, 2015
1 parent df08281 commit 7c3190fe12508fd5ef2426f040093170a76a6d6c
Showing with 32 additions and 3 deletions.
  1. +1 −0 cmake_templates/Doxyfile.in
  2. +19 −2 src/server/qgsserver.h
  3. +12 −1 src/server/qgsserverinterface.h
@@ -597,6 +597,7 @@ INPUT = @CMAKE_SOURCE_DIR@/doc \
@CMAKE_SOURCE_DIR@/src/analysis/raster \
@CMAKE_SOURCE_DIR@/src/analysis/vector \
@CMAKE_SOURCE_DIR@/src/plugins \
@CMAKE_SOURCE_DIR@/src/server/qgsserver.h \
@CMAKE_SOURCE_DIR@/src/server/qgscapabilitiescache.h \
@CMAKE_SOURCE_DIR@/src/server/qgsmapserviceexception.h \
@CMAKE_SOURCE_DIR@/src/server/qgsrequesthandler.h \
@@ -65,15 +65,32 @@ class SERVER_EXPORT QgsServer
* for testing purposes.
* The query string is normally read from environment
* but can be also passed in args and in this case overrides the environment
* variable */
* variable
*
* @param queryString optional QString containing the query string
* @return the response QByteArray if called from python bindings, empty otherwise
*/
QByteArray handleRequest( const QString queryString = QString( ) );
QByteArray handleRequest( const QString queryString,
const bool returnHeaders,
const bool returnBody );
/**
* Handles the request and returns only the body
*
* @param queryString optional QString containing the query string
* @return the response body QByteArray if called from python bindings, empty otherwise
*/
QByteArray handleRequestGetBody( const QString queryString = QString( ) );

/**
* Handles the request and returns only the headers
*
* @param queryString optional QString containing the query string
* @return the response headers QByteArray if called from python bindings, empty otherwise
*/
QByteArray handleRequestGetHeaders( const QString queryString = QString( ) );

/** Returns the server context */
/** Returns a pointer to the server interface */
#ifdef HAVE_SERVER_PYTHON_PLUGINS
QgsServerInterfaceImpl* serverInterface( ) { return mServerInterface; }
#endif
@@ -71,9 +71,20 @@ class SERVER_EXPORT QgsServerInterface
* @return QgsServerFiltersMap list of QgsServerFilter
*/
virtual QgsServerFiltersMap filters( ) = 0;
//! Pass environment variables to python

//! Return an enrironment variable, used to pass environment variables to python
virtual QString getEnv( const QString& name ) const = 0;

/**
* Return the configuration file path
* @return QString containing the configuration file path
*/
virtual QString configFilePath( ) = 0;

/**
* Set the configuration file path
* @param configFilePath QString with the configuration file path
*/
virtual void setConfigFilePath( QString configFilePath ) = 0;

private:

0 comments on commit 7c3190f

Please sign in to comment.
You can’t perform that action at this time.