Skip to content

Commit 7c3190f

Browse files
committedJun 29, 2015
Added documentation and QgsServer to doxy template
1 parent df08281 commit 7c3190f

File tree

3 files changed

+32
-3
lines changed

3 files changed

+32
-3
lines changed
 

‎cmake_templates/Doxyfile.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -597,6 +597,7 @@ INPUT = @CMAKE_SOURCE_DIR@/doc \
597597
@CMAKE_SOURCE_DIR@/src/analysis/raster \
598598
@CMAKE_SOURCE_DIR@/src/analysis/vector \
599599
@CMAKE_SOURCE_DIR@/src/plugins \
600+
@CMAKE_SOURCE_DIR@/src/server/qgsserver.h \
600601
@CMAKE_SOURCE_DIR@/src/server/qgscapabilitiescache.h \
601602
@CMAKE_SOURCE_DIR@/src/server/qgsmapserviceexception.h \
602603
@CMAKE_SOURCE_DIR@/src/server/qgsrequesthandler.h \

‎src/server/qgsserver.h

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,15 +65,32 @@ class SERVER_EXPORT QgsServer
6565
* for testing purposes.
6666
* The query string is normally read from environment
6767
* but can be also passed in args and in this case overrides the environment
68-
* variable */
68+
* variable
69+
*
70+
* @param queryString optional QString containing the query string
71+
* @return the response QByteArray if called from python bindings, empty otherwise
72+
*/
6973
QByteArray handleRequest( const QString queryString = QString( ) );
7074
QByteArray handleRequest( const QString queryString,
7175
const bool returnHeaders,
7276
const bool returnBody );
77+
/**
78+
* Handles the request and returns only the body
79+
*
80+
* @param queryString optional QString containing the query string
81+
* @return the response body QByteArray if called from python bindings, empty otherwise
82+
*/
7383
QByteArray handleRequestGetBody( const QString queryString = QString( ) );
84+
85+
/**
86+
* Handles the request and returns only the headers
87+
*
88+
* @param queryString optional QString containing the query string
89+
* @return the response headers QByteArray if called from python bindings, empty otherwise
90+
*/
7491
QByteArray handleRequestGetHeaders( const QString queryString = QString( ) );
7592

76-
/** Returns the server context */
93+
/** Returns a pointer to the server interface */
7794
#ifdef HAVE_SERVER_PYTHON_PLUGINS
7895
QgsServerInterfaceImpl* serverInterface( ) { return mServerInterface; }
7996
#endif

‎src/server/qgsserverinterface.h

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,20 @@ class SERVER_EXPORT QgsServerInterface
7171
* @return QgsServerFiltersMap list of QgsServerFilter
7272
*/
7373
virtual QgsServerFiltersMap filters( ) = 0;
74-
//! Pass environment variables to python
74+
75+
//! Return an enrironment variable, used to pass environment variables to python
7576
virtual QString getEnv( const QString& name ) const = 0;
77+
78+
/**
79+
* Return the configuration file path
80+
* @return QString containing the configuration file path
81+
*/
7682
virtual QString configFilePath( ) = 0;
83+
84+
/**
85+
* Set the configuration file path
86+
* @param configFilePath QString with the configuration file path
87+
*/
7788
virtual void setConfigFilePath( QString configFilePath ) = 0;
7889

7990
private:

0 commit comments

Comments
 (0)
Please sign in to comment.