From 86804c3d54d555e12328749122606413b666ae42 Mon Sep 17 00:00:00 2001 From: Jonne Nauha Date: Wed, 2 Jan 2013 01:49:12 +0200 Subject: [PATCH 01/67] Make windows builds generate a .lib file by setting dll exports in qhttpserverapi.h, does nothing on non-windows platforms. Made a forward declaration file so could remove duplicated typedefs and other forward declarations. Changed the http_parser settings to be a ptr so we dont have to include the http_parser.h in the header files, so you dont have to ship this header to apps using this library. Some OCD 2 space indendations to 4 intendations etc. :) --- src/qhttpconnection.cpp | 29 ++++++++----- src/qhttpconnection.h | 17 +++----- src/qhttprequest.h | 92 +++++++++++++++++++--------------------- src/qhttpresponse.cpp | 4 +- src/qhttpresponse.h | 93 +++++++++++++++++++---------------------- src/qhttpserver.h | 15 ++----- src/qhttpserverapi.h | 41 ++++++++++++++++++ src/qhttpserverfwd.h | 48 +++++++++++++++++++++ 8 files changed, 206 insertions(+), 133 deletions(-) create mode 100644 src/qhttpserverapi.h create mode 100644 src/qhttpserverfwd.h diff --git a/src/qhttpconnection.cpp b/src/qhttpconnection.cpp index 2fdc62b..aa58fc7 100644 --- a/src/qhttpconnection.cpp +++ b/src/qhttpconnection.cpp @@ -29,10 +29,13 @@ #include "qhttprequest.h" #include "qhttpresponse.h" +#include + QHttpConnection::QHttpConnection(QTcpSocket *socket, QObject *parent) : QObject(parent) , m_socket(socket) , m_parser(0) + , m_parserSettings(0) , m_request(0) { qDebug() << "Got new connection" << socket->peerAddress() << socket->peerPort(); @@ -40,13 +43,14 @@ QHttpConnection::QHttpConnection(QTcpSocket *socket, QObject *parent) m_parser = (http_parser*)malloc(sizeof(http_parser)); http_parser_init(m_parser, HTTP_REQUEST); - m_parserSettings.on_message_begin = MessageBegin; - m_parserSettings.on_url = Url; - m_parserSettings.on_header_field = HeaderField; - m_parserSettings.on_header_value = HeaderValue; - m_parserSettings.on_headers_complete = HeadersComplete; - m_parserSettings.on_body = Body; - m_parserSettings.on_message_complete = MessageComplete; + m_parserSettings = new http_parser_settings(); + m_parserSettings->on_message_begin = MessageBegin; + m_parserSettings->on_url = Url; + m_parserSettings->on_header_field = HeaderField; + m_parserSettings->on_header_value = HeaderValue; + m_parserSettings->on_headers_complete = HeadersComplete; + m_parserSettings->on_body = Body; + m_parserSettings->on_message_complete = MessageComplete; m_parser->data = this; @@ -61,6 +65,9 @@ QHttpConnection::~QHttpConnection() free(m_parser); m_parser = 0; + + delete m_parserSettings; + m_parserSettings = 0; } void QHttpConnection::socketDisconnected() @@ -83,7 +90,7 @@ void QHttpConnection::parseRequest() while(m_socket->bytesAvailable()) { QByteArray arr = m_socket->readAll(); - http_parser_execute(m_parser, &m_parserSettings, arr.constData(), arr.size()); + http_parser_execute(m_parser, m_parserSettings, arr.constData(), arr.size()); } } @@ -154,7 +161,7 @@ int QHttpConnection::Url(http_parser *parser, const char *at, size_t length) QHttpConnection *theConnection = (QHttpConnection *)parser->data; Q_ASSERT(theConnection->m_request); - QString url = QString::fromAscii(at, length); + QString url = QString::fromLatin1(at, length); theConnection->m_request->setUrl(QUrl(url)); return 0; } @@ -177,7 +184,7 @@ int QHttpConnection::HeaderField(http_parser *parser, const char *at, size_t len theConnection->m_currentHeaderValue = QString(); } - QString fieldSuffix = QString::fromAscii(at, length); + QString fieldSuffix = QString::fromLatin1(at, length); theConnection->m_currentHeaderField += fieldSuffix; return 0; } @@ -187,7 +194,7 @@ int QHttpConnection::HeaderValue(http_parser *parser, const char *at, size_t len QHttpConnection *theConnection = (QHttpConnection *)parser->data; Q_ASSERT(theConnection->m_request); - QString valueSuffix = QString::fromAscii(at, length); + QString valueSuffix = QString::fromLatin1(at, length); theConnection->m_currentHeaderValue += valueSuffix; return 0; } diff --git a/src/qhttpconnection.h b/src/qhttpconnection.h index a85fa09..e95eef6 100644 --- a/src/qhttpconnection.h +++ b/src/qhttpconnection.h @@ -23,19 +23,12 @@ #ifndef Q_HTTP_CONNECTION #define Q_HTTP_CONNECTION -#include -#include - -#include - -class QTcpSocket; +#include "qhttpserverapi.h" +#include "qhttpserverfwd.h" -class QHttpRequest; -class QHttpResponse; - -typedef QHash HeaderHash; +#include -class QHttpConnection : public QObject +class QHTTPSERVER_API QHttpConnection : public QObject { Q_OBJECT @@ -64,7 +57,7 @@ private slots: private: QTcpSocket *m_socket; - http_parser_settings m_parserSettings; + http_parser_settings *m_parserSettings; http_parser *m_parser; // since there can only be one request at any time diff --git a/src/qhttprequest.h b/src/qhttprequest.h index 4e0d610..2f8cfcb 100644 --- a/src/qhttprequest.h +++ b/src/qhttprequest.h @@ -23,18 +23,14 @@ #ifndef Q_HTTP_REQUEST #define Q_HTTP_REQUEST +#include "qhttpserverapi.h" +#include "qhttpserverfwd.h" + #include -#include #include #include #include -class QTcpSocket; - -class QHttpConnection; - -typedef QHash HeaderHash; - /* Request Methods */ /*! \class QHttpRequest @@ -52,7 +48,7 @@ typedef QHash HeaderHash; * * The class is read-only by users of %QHttpServer. */ -class QHttpRequest : public QObject +class QHTTPSERVER_API QHttpRequest : public QObject { Q_OBJECT @@ -73,37 +69,37 @@ class QHttpRequest : public QObject * Taken from http_parser.h -- make sure to keep synced */ enum HttpMethod { - HTTP_DELETE = 0, - HTTP_GET, - HTTP_HEAD, - HTTP_POST, - HTTP_PUT, - /* pathological */ - HTTP_CONNECT, - HTTP_OPTIONS, - HTTP_TRACE, - /* webdav */ - HTTP_COPY, - HTTP_LOCK, - HTTP_MKCOL, - HTTP_MOVE, - HTTP_PROPFIND, - HTTP_PROPPATCH, - HTTP_SEARCH, - HTTP_UNLOCK, - /* subversion */ - HTTP_REPORT, - HTTP_MKACTIVITY, - HTTP_CHECKOUT, - HTTP_MERGE, - /* upnp */ - HTTP_MSEARCH, - HTTP_NOTIFY, - HTTP_SUBSCRIBE, - HTTP_UNSUBSCRIBE, - /* RFC-5789 */ - HTTP_PATCH, - HTTP_PURGE + HTTP_DELETE = 0, + HTTP_GET, + HTTP_HEAD, + HTTP_POST, + HTTP_PUT, + /* pathological */ + HTTP_CONNECT, + HTTP_OPTIONS, + HTTP_TRACE, + /* webdav */ + HTTP_COPY, + HTTP_LOCK, + HTTP_MKCOL, + HTTP_MOVE, + HTTP_PROPFIND, + HTTP_PROPPATCH, + HTTP_SEARCH, + HTTP_UNLOCK, + /* subversion */ + HTTP_REPORT, + HTTP_MKACTIVITY, + HTTP_CHECKOUT, + HTTP_MERGE, + /* upnp */ + HTTP_MSEARCH, + HTTP_NOTIFY, + HTTP_SUBSCRIBE, + HTTP_UNSUBSCRIBE, + /* RFC-5789 */ + HTTP_PATCH, + HTTP_PURGE }; /*! @@ -189,9 +185,9 @@ class QHttpRequest : public QObject */ void storeBody() { - connect(this, SIGNAL(data(const QByteArray &)), - this, SLOT(appendBody(const QByteArray &)), - Qt::UniqueConnection); + connect(this, SIGNAL(data(const QByteArray &)), + this, SLOT(appendBody(const QByteArray &)), + Qt::UniqueConnection); } signals: @@ -213,8 +209,8 @@ class QHttpRequest : public QObject static QString MethodToString(HttpMethod method) { - int index = staticMetaObject.indexOfEnumerator("HttpMethod"); - return staticMetaObject.enumerator(index).valueToKey(method); + int index = staticMetaObject.indexOfEnumerator("HttpMethod"); + return staticMetaObject.enumerator(index).valueToKey(method); } void setMethod(HttpMethod method) { m_method = method; } @@ -235,11 +231,11 @@ class QHttpRequest : public QObject friend class QHttpConnection; - private slots: - void appendBody(const QByteArray &body) - { +private slots: + void appendBody(const QByteArray &body) + { m_body.append(body); - } + } }; #endif diff --git a/src/qhttpresponse.cpp b/src/qhttpresponse.cpp index b92e88b..b017fa3 100644 --- a/src/qhttpresponse.cpp +++ b/src/qhttpresponse.cpp @@ -101,7 +101,7 @@ void QHttpResponse::writeHeaders() } //TODO: Expect case - writeHeader(name.toAscii(), value.toAscii()); + writeHeader(name.toLatin1(), value.toLatin1()); } if( !m_sentConnectionHeader ) @@ -140,7 +140,7 @@ void QHttpResponse::writeHead(int status) if( m_headerWritten ) return; - m_connection->write(QString("HTTP/1.1 %1 %2\r\n").arg(status).arg(STATUS_CODES[status]).toAscii()); + m_connection->write(QString("HTTP/1.1 %1 %2\r\n").arg(status).arg(STATUS_CODES[status]).toLatin1()); writeHeaders(); diff --git a/src/qhttpresponse.h b/src/qhttpresponse.h index 6249776..29df832 100644 --- a/src/qhttpresponse.h +++ b/src/qhttpresponse.h @@ -23,15 +23,10 @@ #ifndef Q_HTTP_RESPONSE #define Q_HTTP_RESPONSE -#include -#include - -// -class QTcpSocket; +#include "qhttpserverapi.h" +#include "qhttpserverfwd.h" -class QHttpConnection; - -typedef QHash HeaderHash; +#include /*! * The QHttpResponse class handles sending @@ -46,52 +41,52 @@ typedef QHash HeaderHash; * * */ -class QHttpResponse : public QObject +class QHTTPSERVER_API QHttpResponse : public QObject { Q_OBJECT public: enum StatusCode { - STATUS_CONTINUE = 100, - STATUS_SWITCH_PROTOCOLS = 101, - STATUS_OK = 200, - STATUS_CREATED = 201, - STATUS_ACCEPTED = 202, - STATUS_NON_AUTHORITATIVE_INFORMATION = 203, - STATUS_NO_CONTENT = 204, - STATUS_RESET_CONTENT = 205, - STATUS_PARTIAL_CONTENT = 206, - STATUS_MULTIPLE_CHOICES = 300, - STATUS_MOVED_PERMANENTLY = 301, - STATUS_FOUND = 302, - STATUS_SEE_OTHER = 303, - STATUS_NOT_MODIFIED = 304, - STATUS_USE_PROXY = 305, - STATUS_TEMPORARY_REDIRECT = 307, - STATUS_BAD_REQUEST = 400, - STATUS_UNAUTHORIZED = 401, - STATUS_PAYMENT_REQUIRED = 402, - STATUS_FORBIDDEN = 403, - STATUS_NOT_FOUND = 404, - STATUS_METHOD_NOT_ALLOWED = 405, - STATUS_NOT_ACCEPTABLE = 406, - STATUS_PROXY_AUTHENTICATION_REQUIRED = 407, - STATUS_REQUEST_TIMEOUT = 408, - STATUS_CONFLICT = 409, - STATUS_GONE = 410, - STATUS_LENGTH_REQUIRED = 411, - STATUS_PRECONDITION_FAILED = 412, - STATUS_REQUEST_ENTITY_TOO_LARGE = 413, - STATUS_REQUEST_URI_TOO_LONG = 414, - STATUS_REQUEST_UNSUPPORTED_MEDIA_TYPE = 415, - STATUS_REQUESTED_RANGE_NOT_SATISFIABLE = 416, - STATUS_EXPECTATION_FAILED = 417, - STATUS_INTERNAL_SERVER_ERROR = 500, - STATUS_NOT_IMPLEMENTED = 501, - STATUS_BAD_GATEWAY = 502, - STATUS_SERVICE_UNAVAILABLE = 503, - STATUS_GATEWAY_TIMEOUT = 504, - STATUS_HTTP_VERSION_NOT_SUPPORTED = 505 + STATUS_CONTINUE = 100, + STATUS_SWITCH_PROTOCOLS = 101, + STATUS_OK = 200, + STATUS_CREATED = 201, + STATUS_ACCEPTED = 202, + STATUS_NON_AUTHORITATIVE_INFORMATION = 203, + STATUS_NO_CONTENT = 204, + STATUS_RESET_CONTENT = 205, + STATUS_PARTIAL_CONTENT = 206, + STATUS_MULTIPLE_CHOICES = 300, + STATUS_MOVED_PERMANENTLY = 301, + STATUS_FOUND = 302, + STATUS_SEE_OTHER = 303, + STATUS_NOT_MODIFIED = 304, + STATUS_USE_PROXY = 305, + STATUS_TEMPORARY_REDIRECT = 307, + STATUS_BAD_REQUEST = 400, + STATUS_UNAUTHORIZED = 401, + STATUS_PAYMENT_REQUIRED = 402, + STATUS_FORBIDDEN = 403, + STATUS_NOT_FOUND = 404, + STATUS_METHOD_NOT_ALLOWED = 405, + STATUS_NOT_ACCEPTABLE = 406, + STATUS_PROXY_AUTHENTICATION_REQUIRED = 407, + STATUS_REQUEST_TIMEOUT = 408, + STATUS_CONFLICT = 409, + STATUS_GONE = 410, + STATUS_LENGTH_REQUIRED = 411, + STATUS_PRECONDITION_FAILED = 412, + STATUS_REQUEST_ENTITY_TOO_LARGE = 413, + STATUS_REQUEST_URI_TOO_LONG = 414, + STATUS_REQUEST_UNSUPPORTED_MEDIA_TYPE = 415, + STATUS_REQUESTED_RANGE_NOT_SATISFIABLE = 416, + STATUS_EXPECTATION_FAILED = 417, + STATUS_INTERNAL_SERVER_ERROR = 500, + STATUS_NOT_IMPLEMENTED = 501, + STATUS_BAD_GATEWAY = 502, + STATUS_SERVICE_UNAVAILABLE = 503, + STATUS_GATEWAY_TIMEOUT = 504, + STATUS_HTTP_VERSION_NOT_SUPPORTED = 505 }; virtual ~QHttpResponse(); diff --git a/src/qhttpserver.h b/src/qhttpserver.h index a74b13e..f3ae53d 100644 --- a/src/qhttpserver.h +++ b/src/qhttpserver.h @@ -27,19 +27,12 @@ #define QHTTPSERVER_VERSION_MINOR 1 #define QHTTPSERVER_VERSION_PATCH 0 +#include "qhttpserverapi.h" +#include "qhttpserverfwd.h" + #include #include -class QTcpServer; - -class QHttpRequest; -class QHttpResponse; - -/*! - * A map of request or response headers - */ -typedef QHash HeaderHash; - /*! * Maps status codes to string reason phrases */ @@ -105,7 +98,7 @@ extern QHash STATUS_CODES; * \include helloworld/helloworld.h * */ -class QHttpServer : public QObject +class QHTTPSERVER_API QHttpServer : public QObject { Q_OBJECT diff --git a/src/qhttpserverapi.h b/src/qhttpserverapi.h new file mode 100644 index 0000000..29dfe3e --- /dev/null +++ b/src/qhttpserverapi.h @@ -0,0 +1,41 @@ +/* + * Copyright 2011 Nikhil Marathe + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +#ifndef Q_HTTP_SERVER_API +#define Q_HTTP_SERVER_API + +#include + +#ifdef Q_OS_WIN + // Define to export or import depending if we are building or using the library. + // QHTTPSERVER_EXPORT should only be defined when building. + #if defined(QHTTPSERVER_EXPORT) + #define QHTTPSERVER_API __declspec(dllexport) + #else + #define QHTTPSERVER_API __declspec(dllimport) + #endif +#else + // Define empty for other platforms + #define QHTTPSERVER_API +#endif + +#endif diff --git a/src/qhttpserverfwd.h b/src/qhttpserverfwd.h new file mode 100644 index 0000000..847c342 --- /dev/null +++ b/src/qhttpserverfwd.h @@ -0,0 +1,48 @@ +/* + * Copyright 2011 Nikhil Marathe + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +#ifndef Q_HTTP_SERVER_FWD +#define Q_HTTP_SERVER_FWD + +#include +#include + +/*! + * A map of request or response headers + */ +typedef QHash HeaderHash; + +// QHttpServer +class QHttpServer; +class QHttpConnection; +class QHttpRequest; +class QHttpResponse; + +// Qt +class QTcpServer; +class QTcpSocket; + +// http_parser +struct http_parser_settings; +struct http_parser; + +#endif From 3765e52edbe322156ef0117b1f63937e7c824834 Mon Sep 17 00:00:00 2001 From: Jonne Nauha Date: Wed, 2 Jan 2013 03:04:56 +0200 Subject: [PATCH 02/67] Fix detecting OS also for Qt 4.7, Q_OS_WIN does not exist there. --- src/qhttpserverapi.h | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/qhttpserverapi.h b/src/qhttpserverapi.h index 29dfe3e..798f658 100644 --- a/src/qhttpserverapi.h +++ b/src/qhttpserverapi.h @@ -25,6 +25,7 @@ #include +#if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0)) #ifdef Q_OS_WIN // Define to export or import depending if we are building or using the library. // QHTTPSERVER_EXPORT should only be defined when building. @@ -37,5 +38,19 @@ // Define empty for other platforms #define QHTTPSERVER_API #endif +#else +#ifdef Q_WS_WIN + // Define to export or import depending if we are building or using the library. + // QHTTPSERVER_EXPORT should only be defined when building. + #if defined(QHTTPSERVER_EXPORT) + #define QHTTPSERVER_API __declspec(dllexport) + #else + #define QHTTPSERVER_API __declspec(dllimport) + #endif +#else + // Define empty for other platforms + #define QHTTPSERVER_API +#endif +#endif #endif From 2e00b47a462bfaa21c41385e7b591b85817c3796 Mon Sep 17 00:00:00 2001 From: Nikhil Marathe Date: Mon, 2 Sep 2013 08:52:33 -0700 Subject: [PATCH 03/67] Add bodydata to gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 6a06dfd..427e250 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,4 @@ examples/helloworld/helloworld docs/html tests/tests examples/greeting/greeting +examples/bodydata/bodydata From 832af37ec8fd4701e0b2f3c84e359fcec58756f6 Mon Sep 17 00:00:00 2001 From: Nikhil Marathe Date: Mon, 2 Sep 2013 08:52:40 -0700 Subject: [PATCH 04/67] Add null check --- src/qhttpserver.cpp | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/qhttpserver.cpp b/src/qhttpserver.cpp index 02a29db..34d24e6 100644 --- a/src/qhttpserver.cpp +++ b/src/qhttpserver.cpp @@ -121,5 +121,7 @@ bool QHttpServer::listen(quint16 port) void QHttpServer::close() { - m_tcpServer->close(); + if(m_tcpServer) { + m_tcpServer->close(); + } } From 9944d433fd5f86ee019da2033584da6d739bdef1 Mon Sep 17 00:00:00 2001 From: Nikhil Marathe Date: Mon, 2 Sep 2013 09:04:11 -0700 Subject: [PATCH 05/67] Style fix --- src/qhttpconnection.cpp | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/qhttpconnection.cpp b/src/qhttpconnection.cpp index aa58fc7..72c72b9 100644 --- a/src/qhttpconnection.cpp +++ b/src/qhttpconnection.cpp @@ -26,11 +26,10 @@ #include #include +#include "http_parser.h" #include "qhttprequest.h" #include "qhttpresponse.h" -#include - QHttpConnection::QHttpConnection(QTcpSocket *socket, QObject *parent) : QObject(parent) , m_socket(socket) From b56a898ca21178f201b59e9f089eeb40c40620b1 Mon Sep 17 00:00:00 2001 From: Nikhil Marathe Date: Mon, 2 Sep 2013 09:05:09 -0700 Subject: [PATCH 06/67] Fix last remaining toAscii() calls --- examples/bodydata/bodydata.cpp | 2 +- examples/greeting/greeting.cpp | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/bodydata/bodydata.cpp b/examples/bodydata/bodydata.cpp index 498ffc6..86e21e3 100644 --- a/examples/bodydata/bodydata.cpp +++ b/examples/bodydata/bodydata.cpp @@ -50,7 +50,7 @@ void Responder::accumulate(const QByteArray &data) void Responder::reply() { - m_resp->end(QString("

").toAscii()); + m_resp->end(QString("

").toLatin1()); } BodyData::BodyData() diff --git a/examples/greeting/greeting.cpp b/examples/greeting/greeting.cpp index 8d6801e..7e64382 100644 --- a/examples/greeting/greeting.cpp +++ b/examples/greeting/greeting.cpp @@ -26,7 +26,7 @@ void Greeting::handle(QHttpRequest *req, QHttpResponse *resp) QString name = exp.capturedTexts()[1]; QString reply = tr("Greeting App

Hello %1!

"); - resp->end(reply.arg(name).toAscii()); + resp->end(reply.arg(name).toLatin1()); } else { From 6b568a99b127ef35212a2c219017ad3bf1b69961 Mon Sep 17 00:00:00 2001 From: Samu Nuutamo Date: Wed, 11 Sep 2013 19:25:11 +0300 Subject: [PATCH 07/67] Added missing headers to PUBLIC_HEADERS in src.pro --- src/src.pro | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/src.pro b/src/src.pro index a31150a..6c8e57d 100644 --- a/src/src.pro +++ b/src/src.pro @@ -14,7 +14,7 @@ INCLUDEPATH += $$QHTTPSERVER_BASE/http-parser PRIVATE_HEADERS += $$QHTTPSERVER_BASE/http-parser/http_parser.h qhttpconnection.h -PUBLIC_HEADERS += qhttpserver.h qhttprequest.h qhttpresponse.h +PUBLIC_HEADERS += qhttpserver.h qhttprequest.h qhttpresponse.h qhttpserverapi.h qhttpserverfwd.h HEADERS = $$PRIVATE_HEADERS $$PUBLIC_HEADERS SOURCES = *.cpp $$QHTTPSERVER_BASE/http-parser/http_parser.c From a7e190aed98e2354197a6534319b9db3a0433f51 Mon Sep 17 00:00:00 2001 From: Samu Nuutamo Date: Wed, 18 Sep 2013 15:12:22 +0300 Subject: [PATCH 08/67] Removed unused gui dependency from tests --- tests/tests.pro | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/tests.pro b/tests/tests.pro index c3164f5..6843dd4 100644 --- a/tests/tests.pro +++ b/tests/tests.pro @@ -1,5 +1,6 @@ TEMPLATE = app QT += network +QT -= gui SOURCES = test.cpp From e5a8c6100972b76b3262ba5b940255ef920b88e1 Mon Sep 17 00:00:00 2001 From: Samu Nuutamo Date: Wed, 18 Sep 2013 15:25:46 +0300 Subject: [PATCH 09/67] Removed debug flag from src/src.pro to build the library with optimizations and without symbols by default --- src/src.pro | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/src.pro b/src/src.pro index 6c8e57d..774a4d4 100644 --- a/src/src.pro +++ b/src/src.pro @@ -8,7 +8,7 @@ VERSION = 0.1.0 QT += network QT -= gui -CONFIG += dll debug +CONFIG += dll INCLUDEPATH += $$QHTTPSERVER_BASE/http-parser From e7fd0b28056c2f5588a7f7760742a72b1190ef88 Mon Sep 17 00:00:00 2001 From: Nikhil Marathe Date: Mon, 2 Sep 2013 09:11:45 -0700 Subject: [PATCH 10/67] Add Jonne as contributor --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index e4ced16..df8c541 100644 --- a/README.md +++ b/README.md @@ -65,3 +65,4 @@ Contributors * Nikhil Marathe (maintainer) * David Wolinsy +* Jonne Nauha (Windows build fixes) From 9a0428e57fefedf3292cc77ecaa789be294c2dd7 Mon Sep 17 00:00:00 2001 From: Nikhil Marathe Date: Mon, 2 Sep 2013 09:18:08 -0700 Subject: [PATCH 11/67] Add note about Qt 5 compatibility. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index df8c541..7b04d0c 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ anything complex** Installation ------------ -Requires Qt 4. +Requires Qt 4 or Qt 5. qmake && make && su -c 'make install' From ea4ba5e12064a8fdef57eaa5b63d8e3bf7906afd Mon Sep 17 00:00:00 2001 From: Nikhil Marathe Date: Thu, 26 Sep 2013 08:41:37 -0700 Subject: [PATCH 12/67] Revert bad parts of commit 8269510b4b1 and 20294974. --- src/qhttpconnection.cpp | 17 +++++++++++++---- src/qhttpconnection.h | 3 ++- src/qhttpresponse.cpp | 2 +- 3 files changed, 16 insertions(+), 6 deletions(-) diff --git a/src/qhttpconnection.cpp b/src/qhttpconnection.cpp index 72c72b9..f4cd171 100644 --- a/src/qhttpconnection.cpp +++ b/src/qhttpconnection.cpp @@ -1,23 +1,23 @@ /* * Copyright 2011 Nikhil Marathe - * + * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to * deal in the Software without restriction, including without limitation the * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or * sell copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: - * + * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. - * + * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS - * IN THE SOFTWARE. + * IN THE SOFTWARE. */ #include "qhttpconnection.h" @@ -103,6 +103,14 @@ void QHttpConnection::flush() m_socket->flush(); } +void QHttpConnection::responseDone() +{ + QHttpResponse *response = qobject_cast(QObject::sender()); + if (response->m_last) { + m_socket->disconnectFromHost(); + } +} + /******************** * Static Callbacks * *******************/ @@ -138,6 +146,7 @@ int QHttpConnection::HeadersComplete(http_parser *parser) response->m_keepAlive = false; connect(theConnection, SIGNAL(destroyed()), response, SLOT(connectionClosed())); + connect(response, SIGNAL(done()), theConnection, SLOT(responseDone())); // we are good to go! emit theConnection->newRequest(theConnection->m_request, response); diff --git a/src/qhttpconnection.h b/src/qhttpconnection.h index e95eef6..a90a535 100644 --- a/src/qhttpconnection.h +++ b/src/qhttpconnection.h @@ -44,6 +44,7 @@ class QHTTPSERVER_API QHttpConnection : public QObject private slots: void parseRequest(); + void responseDone(); void socketDisconnected(); private: @@ -57,8 +58,8 @@ private slots: private: QTcpSocket *m_socket; - http_parser_settings *m_parserSettings; http_parser *m_parser; + http_parser_settings *m_parserSettings; // since there can only be one request at any time // even with pipelining diff --git a/src/qhttpresponse.cpp b/src/qhttpresponse.cpp index b017fa3..ad82122 100644 --- a/src/qhttpresponse.cpp +++ b/src/qhttpresponse.cpp @@ -177,10 +177,10 @@ void QHttpResponse::end(const QString &data) if(m_finished) { return; } - m_finished = true; write(data); + m_finished = true; emit done(); deleteLater(); // TODO: end connection and delete ourselves From 2e20e079057f4cad8970ec5e632595486de4a805 Mon Sep 17 00:00:00 2001 From: Nikhil Marathe Date: Thu, 26 Sep 2013 09:00:45 -0700 Subject: [PATCH 13/67] QString write() delegates to QByteArray write() --- src/qhttpresponse.cpp | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/src/qhttpresponse.cpp b/src/qhttpresponse.cpp index ad82122..ee88b8a 100644 --- a/src/qhttpresponse.cpp +++ b/src/qhttpresponse.cpp @@ -165,11 +165,7 @@ void QHttpResponse::write(const QByteArray &data) void QHttpResponse::write(const QString &data) { - if(m_finished) { - return; - } - - m_connection->write(data.toUtf8()); + write(data.toUtf8()); } void QHttpResponse::end(const QString &data) From fcf2dbdaebabe8a4255c51341f23448c72e54b09 Mon Sep 17 00:00:00 2001 From: Nikhil Marathe Date: Thu, 26 Sep 2013 09:01:14 -0700 Subject: [PATCH 14/67] Add end(QString) --- examples/bodydata/bodydata.cpp | 4 ++-- examples/greeting/greeting.cpp | 4 ++-- src/qhttpresponse.cpp | 7 ++++++- src/qhttpresponse.h | 7 ++++++- 4 files changed, 16 insertions(+), 6 deletions(-) diff --git a/examples/bodydata/bodydata.cpp b/examples/bodydata/bodydata.cpp index 86e21e3..ce4566a 100644 --- a/examples/bodydata/bodydata.cpp +++ b/examples/bodydata/bodydata.cpp @@ -27,7 +27,7 @@ Responder::Responder(QHttpRequest *req, QHttpResponse *resp) else { resp->writeHead(403); - resp->end("You aren't allowed here!"); + resp->end(QStringLiteral("You aren't allowed here!")); // TODO: there should be a way to tell request to stop streaming data return; } @@ -50,7 +50,7 @@ void Responder::accumulate(const QByteArray &data) void Responder::reply() { - m_resp->end(QString("

").toLatin1()); + m_resp->end(QStringLiteral("

")); } BodyData::BodyData() diff --git a/examples/greeting/greeting.cpp b/examples/greeting/greeting.cpp index 7e64382..dc9d726 100644 --- a/examples/greeting/greeting.cpp +++ b/examples/greeting/greeting.cpp @@ -26,12 +26,12 @@ void Greeting::handle(QHttpRequest *req, QHttpResponse *resp) QString name = exp.capturedTexts()[1]; QString reply = tr("Greeting App

Hello %1!

"); - resp->end(reply.arg(name).toLatin1()); + resp->end(reply.arg(name)); } else { resp->writeHead(403); - resp->end("You aren't allowed here!"); + resp->end(QStringLiteral("You aren't allowed here!")); } } diff --git a/src/qhttpresponse.cpp b/src/qhttpresponse.cpp index ee88b8a..cfa442a 100644 --- a/src/qhttpresponse.cpp +++ b/src/qhttpresponse.cpp @@ -168,7 +168,7 @@ void QHttpResponse::write(const QString &data) write(data.toUtf8()); } -void QHttpResponse::end(const QString &data) +void QHttpResponse::end(const QByteArray &data) { if(m_finished) { return; @@ -182,6 +182,11 @@ void QHttpResponse::end(const QString &data) // TODO: end connection and delete ourselves } +void QHttpResponse::end(const QString &data) +{ + end(data.toUtf8()); +} + void QHttpResponse::connectionClosed() { m_finished = true; diff --git a/src/qhttpresponse.h b/src/qhttpresponse.h index 29df832..ad5ceec 100644 --- a/src/qhttpresponse.h +++ b/src/qhttpresponse.h @@ -124,7 +124,12 @@ public slots: * This will emit done() and queue this object * for deletion. For details see \ref memorymanagement */ - void end(const QString &data=QString()); + void end(const QByteArray &data=QByteArray()); + + /*! + * End with a QString. + */ + void end(const QString &data); /*! * Set a response header @c field to @c value From 1f04ffd58ac5534af01e0e89da7497aaf595206e Mon Sep 17 00:00:00 2001 From: Nikhil Marathe Date: Thu, 26 Sep 2013 09:01:26 -0700 Subject: [PATCH 15/67] Fix unused warning --- examples/bodydata/bodydata.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/bodydata/bodydata.cpp b/examples/bodydata/bodydata.cpp index ce4566a..a996b61 100644 --- a/examples/bodydata/bodydata.cpp +++ b/examples/bodydata/bodydata.cpp @@ -63,7 +63,7 @@ BodyData::BodyData() void BodyData::handle(QHttpRequest *req, QHttpResponse *resp) { - Responder *r = new Responder(req, resp); + new Responder(req, resp); } int main(int argc, char **argv) From 3b428026c801d457fa8eb2274a65ca6ebe116988 Mon Sep 17 00:00:00 2001 From: Nikhil Marathe Date: Thu, 26 Sep 2013 09:51:05 -0700 Subject: [PATCH 16/67] Mark unused request --- examples/helloworld/helloworld.cpp | 1 + 1 file changed, 1 insertion(+) diff --git a/examples/helloworld/helloworld.cpp b/examples/helloworld/helloworld.cpp index 0dc9858..16a12b6 100644 --- a/examples/helloworld/helloworld.cpp +++ b/examples/helloworld/helloworld.cpp @@ -16,6 +16,7 @@ Hello::Hello() void Hello::handle(QHttpRequest *req, QHttpResponse *resp) { + Q_UNUSED(req); resp->setHeader("Content-Length", "11"); resp->writeHead(200); resp->write(QString("Hello World")); From f60c814e4c97da4a6645e4a07591331f84e7c7f6 Mon Sep 17 00:00:00 2001 From: Nikhil Marathe Date: Thu, 26 Sep 2013 09:51:35 -0700 Subject: [PATCH 17/67] Add lib as dependency to tests and examples. Fixes #8 --- qhttpserver.pro | 3 +++ 1 file changed, 3 insertions(+) diff --git a/qhttpserver.pro b/qhttpserver.pro index db008c2..be8d8e2 100644 --- a/qhttpserver.pro +++ b/qhttpserver.pro @@ -3,3 +3,6 @@ SUBDIRS += \ src\ tests\ examples + +tests.depends = src +examples.depends = src From 073c0176db85af62b7e31cf0b447d7bce9b32582 Mon Sep 17 00:00:00 2001 From: Jonne Nauha Date: Fri, 27 Sep 2013 01:31:28 +0300 Subject: [PATCH 18/67] Add preprocessor define QHTTPSERVER_EXPORT in the solution files to fix windows build. --- src/src.pro | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/src.pro b/src/src.pro index 774a4d4..e901f6f 100644 --- a/src/src.pro +++ b/src/src.pro @@ -1,4 +1,5 @@ include(../qhttpserver.pri) + QHTTPSERVER_BASE = .. TEMPLATE = lib @@ -10,6 +11,8 @@ QT -= gui CONFIG += dll +DEFINES += QHTTPSERVER_EXPORT + INCLUDEPATH += $$QHTTPSERVER_BASE/http-parser PRIVATE_HEADERS += $$QHTTPSERVER_BASE/http-parser/http_parser.h qhttpconnection.h From 74a31e0406e5d599909ae42b7e7ed5c870d10555 Mon Sep 17 00:00:00 2001 From: Jonne Nauha Date: Fri, 27 Sep 2013 01:39:19 +0300 Subject: [PATCH 19/67] Fix build for Qt4. No QStringLiteral there. --- examples/bodydata/bodydata.cpp | 4 ++-- examples/greeting/greeting.cpp | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/bodydata/bodydata.cpp b/examples/bodydata/bodydata.cpp index a996b61..70abaac 100644 --- a/examples/bodydata/bodydata.cpp +++ b/examples/bodydata/bodydata.cpp @@ -27,7 +27,7 @@ Responder::Responder(QHttpRequest *req, QHttpResponse *resp) else { resp->writeHead(403); - resp->end(QStringLiteral("You aren't allowed here!")); + resp->end(QLatin1String("You aren't allowed here!")); // TODO: there should be a way to tell request to stop streaming data return; } @@ -50,7 +50,7 @@ void Responder::accumulate(const QByteArray &data) void Responder::reply() { - m_resp->end(QStringLiteral("

")); + m_resp->end(QLatin1String("

")); } BodyData::BodyData() diff --git a/examples/greeting/greeting.cpp b/examples/greeting/greeting.cpp index dc9d726..4315ea2 100644 --- a/examples/greeting/greeting.cpp +++ b/examples/greeting/greeting.cpp @@ -31,7 +31,7 @@ void Greeting::handle(QHttpRequest *req, QHttpResponse *resp) else { resp->writeHead(403); - resp->end(QStringLiteral("You aren't allowed here!")); + resp->end(QLatin1String("You aren't allowed here!")); } } From bc05a76a77aa6794ea4af4a4a4bc82163586f0ab Mon Sep 17 00:00:00 2001 From: Jonne Nauha Date: Fri, 27 Sep 2013 02:04:54 +0300 Subject: [PATCH 20/67] Try to uniform to a single coding convention/style. 2x spaces to 4x spaces. Add qWarning() to situations where nothing is done while still nothing is reported back to the caller. Id like to see these functions return bool. --- src/qhttpconnection.cpp | 31 +++++------ src/qhttpresponse.cpp | 111 +++++++++++++++++++++------------------- src/qhttpserver.cpp | 7 +-- 3 files changed, 77 insertions(+), 72 deletions(-) diff --git a/src/qhttpconnection.cpp b/src/qhttpconnection.cpp index f4cd171..d30c930 100644 --- a/src/qhttpconnection.cpp +++ b/src/qhttpconnection.cpp @@ -71,10 +71,11 @@ QHttpConnection::~QHttpConnection() void QHttpConnection::socketDisconnected() { - if(m_request) { - if(m_request->successful()) { - return; - } + if (m_request) + { + if (m_request->successful()) + return; + m_request->setSuccessful(false); emit m_request->end(); } @@ -106,17 +107,17 @@ void QHttpConnection::flush() void QHttpConnection::responseDone() { QHttpResponse *response = qobject_cast(QObject::sender()); - if (response->m_last) { + if (response->m_last) m_socket->disconnectFromHost(); - } } /******************** * Static Callbacks * *******************/ + int QHttpConnection::MessageBegin(http_parser *parser) { - QHttpConnection *theConnection = (QHttpConnection *)parser->data; + QHttpConnection *theConnection = static_cast(parser->data); theConnection->m_currentHeaders.clear(); theConnection->m_request = new QHttpRequest(theConnection); return 0; @@ -124,7 +125,7 @@ int QHttpConnection::MessageBegin(http_parser *parser) int QHttpConnection::HeadersComplete(http_parser *parser) { - QHttpConnection *theConnection = (QHttpConnection *)parser->data; + QHttpConnection *theConnection = static_cast(parser->data); Q_ASSERT(theConnection->m_request); /** set method **/ @@ -142,7 +143,7 @@ int QHttpConnection::HeadersComplete(http_parser *parser) theConnection->m_request->m_remotePort = theConnection->m_socket->peerPort(); QHttpResponse *response = new QHttpResponse(theConnection); - if( parser->http_major < 1 || parser->http_minor < 1 ) + if (parser->http_major < 1 || parser->http_minor < 1) response->m_keepAlive = false; connect(theConnection, SIGNAL(destroyed()), response, SLOT(connectionClosed())); @@ -156,7 +157,7 @@ int QHttpConnection::HeadersComplete(http_parser *parser) int QHttpConnection::MessageComplete(http_parser *parser) { // TODO: do cleanup and prepare for next request - QHttpConnection *theConnection = (QHttpConnection *)parser->data; + QHttpConnection *theConnection = static_cast(parser->data); Q_ASSERT(theConnection->m_request); theConnection->m_request->setSuccessful(true); @@ -166,7 +167,7 @@ int QHttpConnection::MessageComplete(http_parser *parser) int QHttpConnection::Url(http_parser *parser, const char *at, size_t length) { - QHttpConnection *theConnection = (QHttpConnection *)parser->data; + QHttpConnection *theConnection = static_cast(parser->data); Q_ASSERT(theConnection->m_request); QString url = QString::fromLatin1(at, length); @@ -176,12 +177,12 @@ int QHttpConnection::Url(http_parser *parser, const char *at, size_t length) int QHttpConnection::HeaderField(http_parser *parser, const char *at, size_t length) { - QHttpConnection *theConnection = (QHttpConnection *)parser->data; + QHttpConnection *theConnection = static_cast(parser->data); Q_ASSERT(theConnection->m_request); // insert the header we parsed previously // into the header map - if( !theConnection->m_currentHeaderField.isEmpty() && !theConnection->m_currentHeaderValue.isEmpty() ) + if (!theConnection->m_currentHeaderField.isEmpty() && !theConnection->m_currentHeaderValue.isEmpty()) { // header names are always lower-cased theConnection->m_currentHeaders[theConnection->m_currentHeaderField.toLower()] = theConnection->m_currentHeaderValue; @@ -199,7 +200,7 @@ int QHttpConnection::HeaderField(http_parser *parser, const char *at, size_t len int QHttpConnection::HeaderValue(http_parser *parser, const char *at, size_t length) { - QHttpConnection *theConnection = (QHttpConnection *)parser->data; + QHttpConnection *theConnection = static_cast(parser->data); Q_ASSERT(theConnection->m_request); QString valueSuffix = QString::fromLatin1(at, length); @@ -209,7 +210,7 @@ int QHttpConnection::HeaderValue(http_parser *parser, const char *at, size_t len int QHttpConnection::Body(http_parser *parser, const char *at, size_t length) { - QHttpConnection *theConnection = (QHttpConnection *)parser->data; + QHttpConnection *theConnection = static_cast(parser->data); Q_ASSERT(theConnection->m_request); emit theConnection->m_request->data(QByteArray(at, length)); diff --git a/src/qhttpresponse.cpp b/src/qhttpresponse.cpp index cfa442a..fd76ee7 100644 --- a/src/qhttpresponse.cpp +++ b/src/qhttpresponse.cpp @@ -49,68 +49,61 @@ QHttpResponse::~QHttpResponse() void QHttpResponse::setHeader(const QString &field, const QString &value) { - if(m_finished) { - return; - } - - m_headers[field] = value; + if (!m_finished) + m_headers[field] = value; + else + qWarning() << "QHttpResponse::setHeader() Cannot set headers after response has finished."; } void QHttpResponse::writeHeader(const char *field, const QString &value) { - if(m_finished) { - return; + if (!m_finished) + { + m_connection->write(field); + m_connection->write(": "); + m_connection->write(value.toUtf8()); + m_connection->write("\r\n"); } - - m_connection->write(field); - m_connection->write(": "); - m_connection->write(value.toUtf8()); - m_connection->write("\r\n"); + else + qWarning() << "QHttpResponse::writeHeader() Cannot write headers after response has finished."; } void QHttpResponse::writeHeaders() { - if(m_finished) { - return; - } + if (m_finished) + return; - foreach(QString name, m_headers.keys()) + foreach(const QString &name, m_headers.keys()) { QString value = m_headers[name]; - if( name.compare("connection", Qt::CaseInsensitive) == 0 ) + if (name.compare("connection", Qt::CaseInsensitive) == 0) { m_sentConnectionHeader = true; - if( value == "close" ) + if (value.compare("close", Qt::CaseInsensitive) == 0) m_last = true; else m_keepAlive = true; } - else if( name.compare("transfer-encoding", Qt::CaseInsensitive) == 0 ) + else if (name.compare("transfer-encoding", Qt::CaseInsensitive) == 0) { m_sentTransferEncodingHeader = true; - if( value == "chunked" ) + if (value.compare("chunked", Qt::CaseInsensitive) == 0) m_useChunkedEncoding = true; } - else if( name.compare("content-length", Qt::CaseInsensitive) == 0 ) - { + else if (name.compare("content-length", Qt::CaseInsensitive) == 0) m_sentContentLengthHeader = true; - } - else if( name.compare("date", Qt::CaseInsensitive) == 0 ) - { + else if (name.compare("date", Qt::CaseInsensitive) == 0) m_sentDate = true; - } - //TODO: Expect case + + /// @todo Expect case (??) writeHeader(name.toLatin1(), value.toLatin1()); } - if( !m_sentConnectionHeader ) + if (!m_sentConnectionHeader) { - if( m_keepAlive && - ( m_sentContentLengthHeader || m_useChunkedEncoding ) ) - { + if (m_keepAlive && (m_sentContentLengthHeader || m_useChunkedEncoding)) writeHeader("Connection", "keep-alive"); - } else { m_last = true; @@ -118,45 +111,51 @@ void QHttpResponse::writeHeaders() } } - if( !m_sentContentLengthHeader && !m_sentTransferEncodingHeader ) + if (!m_sentContentLengthHeader && !m_sentTransferEncodingHeader) { - if( m_useChunkedEncoding ) + if (m_useChunkedEncoding) writeHeader("Transfer-Encoding", "chunked"); else m_last = true; } - if( !m_sentDate ) - { - writeHeader("Date", QDateTime::currentDateTimeUtc().toString("ddd, dd MMM yyyy hh:mm:ss G'M'T")); - } + /// @todo Fix this, it writes month and day in the operating system regions language. + if (!m_sentDate) + writeHeader("Date", QDateTime::currentDateTimeUtc().toString("ddd, dd MMM yyyy hh:mm:ss") + " GMT"); } void QHttpResponse::writeHead(int status) { - if(m_finished) { - return; + if (m_finished) + { + qWarning() << "QHttpResponse::writeHead() Cannot write headers after response has finished."; + return; } - if( m_headerWritten ) return; + if (m_headerWritten) + { + qWarning() << "QHttpResponse::writeHead() Already called once for this response."; + return; + } m_connection->write(QString("HTTP/1.1 %1 %2\r\n").arg(status).arg(STATUS_CODES[status]).toLatin1()); - writeHeaders(); - m_connection->write("\r\n"); + m_headerWritten = true; } void QHttpResponse::write(const QByteArray &data) { - if(m_finished) { - return; + if (m_finished) + { + qWarning() << "QHttpResponse::write() Cannot write body after response has finished."; + return; } - if( !m_headerWritten ) + if (!m_headerWritten) { - qDebug() << "You MUST call writeHead() before writing body data"; + qWarning() << "QHttpResponse::write() You must call writeHead() before writing body data."; return; } @@ -170,16 +169,20 @@ void QHttpResponse::write(const QString &data) void QHttpResponse::end(const QByteArray &data) { - if(m_finished) { - return; + if (m_finished) + { + qWarning() << "QHttpResponse::end() Cannot write end after response has finished."; + return; } - write(data); - + if (data.size() > 0) + write(data); m_finished = true; + emit done(); + + /// @todo End connection and delete ourselves. Is this a still valid note? deleteLater(); - // TODO: end connection and delete ourselves } void QHttpResponse::end(const QString &data) @@ -189,6 +192,6 @@ void QHttpResponse::end(const QString &data) void QHttpResponse::connectionClosed() { - m_finished = true; - deleteLater(); + m_finished = true; + deleteLater(); } diff --git a/src/qhttpserver.cpp b/src/qhttpserver.cpp index 34d24e6..d623ff9 100644 --- a/src/qhttpserver.cpp +++ b/src/qhttpserver.cpp @@ -99,7 +99,9 @@ QHttpServer::~QHttpServer() void QHttpServer::newConnection() { Q_ASSERT(m_tcpServer); - while(m_tcpServer->hasPendingConnections()) { + + while(m_tcpServer->hasPendingConnections()) + { QHttpConnection *connection = new QHttpConnection(m_tcpServer->nextPendingConnection(), this); connect(connection, SIGNAL(newRequest(QHttpRequest*, QHttpResponse*)), this, SIGNAL(newRequest(QHttpRequest*, QHttpResponse*))); @@ -121,7 +123,6 @@ bool QHttpServer::listen(quint16 port) void QHttpServer::close() { - if(m_tcpServer) { + if (m_tcpServer) m_tcpServer->close(); - } } From d0ed47364aeb3fc976a01a5524b792c6af2544e5 Mon Sep 17 00:00:00 2001 From: Jonne Nauha Date: Fri, 27 Sep 2013 02:14:52 +0300 Subject: [PATCH 21/67] Fix Date header to always use month and day names in english. QDateTime::toString uses the os/region language and does not conform to the RFC spec. --- src/qhttpresponse.cpp | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/qhttpresponse.cpp b/src/qhttpresponse.cpp index fd76ee7..c2c5d3e 100644 --- a/src/qhttpresponse.cpp +++ b/src/qhttpresponse.cpp @@ -23,6 +23,7 @@ #include "qhttpresponse.h" #include +#include #include "qhttpserver.h" #include "qhttpconnection.h" @@ -119,9 +120,9 @@ void QHttpResponse::writeHeaders() m_last = true; } - /// @todo Fix this, it writes month and day in the operating system regions language. + // Sun, 06 Nov 1994 08:49:37 GMT - RFC 822. Use QLocale::c() so english is used for month and day. if (!m_sentDate) - writeHeader("Date", QDateTime::currentDateTimeUtc().toString("ddd, dd MMM yyyy hh:mm:ss") + " GMT"); + writeHeader("Date", QLocale::c().toString(QDateTime::currentDateTimeUtc(), "ddd, dd MMM yyyy hh:mm:ss") + " GMT"); } void QHttpResponse::writeHead(int status) From 8ba025f7c70475c33bf12deecf3fcde78fb0317f Mon Sep 17 00:00:00 2001 From: Jonne Nauha Date: Fri, 27 Sep 2013 02:57:30 +0300 Subject: [PATCH 22/67] Improve .pro files: Dont define version on windows, it does 0.dll which is not wanted on windows. Add windows d postfix to debug dlls. Make other projects link to correct lib. I could not get qmake to realise that tests and examples depend on the main library, so the first build at lest in visual studio will fail as the lib is not yet there. --- examples/bodydata/bodydata.pro | 16 +++++++++++++--- examples/greeting/greeting.pro | 16 +++++++++++++--- examples/helloworld/helloworld.pro | 18 ++++++++++++++---- qhttpserver.pro | 10 ++++++---- src/src.pro | 9 +++++++-- tests/tests.pro | 13 +++++++++++-- 6 files changed, 64 insertions(+), 18 deletions(-) diff --git a/examples/bodydata/bodydata.pro b/examples/bodydata/bodydata.pro index ef6d0d2..46d15d9 100644 --- a/examples/bodydata/bodydata.pro +++ b/examples/bodydata/bodydata.pro @@ -1,9 +1,19 @@ +TARGET = bodydata + QT += network QT -= gui + CONFIG += debug INCLUDEPATH += ../../src -LIBS += -L../../lib -lqhttpserver +LIBS += -L../../lib + +win32 { + debug: LIBS += -lqhttpserverd + else: LIBS += -lqhttpserver +} else { + LIBS += -lqhttpserver +} -SOURCES=bodydata.cpp -HEADERS=bodydata.h +SOURCES = bodydata.cpp +HEADERS = bodydata.h diff --git a/examples/greeting/greeting.pro b/examples/greeting/greeting.pro index 120a33f..ff2089a 100644 --- a/examples/greeting/greeting.pro +++ b/examples/greeting/greeting.pro @@ -1,9 +1,19 @@ +TARGET = greeting + QT += network QT -= gui + CONFIG += debug INCLUDEPATH += ../../src -LIBS += -L../../lib -lqhttpserver +LIBS += -L../../lib + +win32 { + debug: LIBS += -lqhttpserverd + else: LIBS += -lqhttpserver +} else { + LIBS += -lqhttpserver +} -SOURCES=greeting.cpp -HEADERS=greeting.h +SOURCES = greeting.cpp +HEADERS = greeting.h diff --git a/examples/helloworld/helloworld.pro b/examples/helloworld/helloworld.pro index 6cc6668..1ca0cbc 100644 --- a/examples/helloworld/helloworld.pro +++ b/examples/helloworld/helloworld.pro @@ -1,9 +1,19 @@ -TARGET=helloworld +TARGET = helloworld + QT += network QT -= gui +CONFIG += debug + INCLUDEPATH += ../../src -LIBS += -L../../lib -lqhttpserver +LIBS += -L../../lib + +win32 { + debug: LIBS += -lqhttpserverd + else: LIBS += -lqhttpserver +} else { + LIBS += -lqhttpserver +} -SOURCES=helloworld.cpp -HEADERS=helloworld.h +SOURCES = helloworld.cpp +HEADERS = helloworld.h diff --git a/qhttpserver.pro b/qhttpserver.pro index be8d8e2..2c7b492 100644 --- a/qhttpserver.pro +++ b/qhttpserver.pro @@ -1,8 +1,10 @@ +CONFIG += ordered + TEMPLATE = subdirs -SUBDIRS += \ - src\ - tests\ - examples + +SUBDIRS += src \ + tests \ + examples tests.depends = src examples.depends = src diff --git a/src/src.pro b/src/src.pro index e901f6f..4392081 100644 --- a/src/src.pro +++ b/src/src.pro @@ -4,12 +4,17 @@ QHTTPSERVER_BASE = .. TEMPLATE = lib TARGET = qhttpserver -VERSION = 0.1.0 + +unix:VERSION = 0.1.0 QT += network QT -= gui -CONFIG += dll +CONFIG += dll debug_and_release + +CONFIG(debug, debug|release) { + win32: TARGET = $$join(TARGET,,,d) +} DEFINES += QHTTPSERVER_EXPORT diff --git a/tests/tests.pro b/tests/tests.pro index 6843dd4..723ef4c 100644 --- a/tests/tests.pro +++ b/tests/tests.pro @@ -1,9 +1,18 @@ TEMPLATE = app + QT += network QT -= gui SOURCES = test.cpp -LIBS += -L../lib/ -lqhttpserver +LIBS += -L../lib/ + +win32 { + debug: LIBS += -lqhttpserverd + else: LIBS += -lqhttpserver +} else { + LIBS += -lqhttpserver +} + INCLUDEPATH += .\ - ../src + ../src From ef4fdf213c2441718a7c8af52d6a925f424caf8e Mon Sep 17 00:00:00 2001 From: Jonne Nauha Date: Fri, 27 Sep 2013 03:00:38 +0300 Subject: [PATCH 23/67] Remove not needed include path from tests, also removes accidental tabs from previous commit. --- tests/tests.pro | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/tests/tests.pro b/tests/tests.pro index 723ef4c..e2e6791 100644 --- a/tests/tests.pro +++ b/tests/tests.pro @@ -14,5 +14,4 @@ win32 { LIBS += -lqhttpserver } -INCLUDEPATH += .\ - ../src +INCLUDEPATH += ../src From e1ec153165bac037655cb8504f4c43b537f47846 Mon Sep 17 00:00:00 2001 From: Jonne Nauha Date: Fri, 27 Sep 2013 03:14:02 +0300 Subject: [PATCH 24/67] Fix also mac and others to have version define. --- src/src.pro | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/src.pro b/src/src.pro index 4392081..dfe8789 100644 --- a/src/src.pro +++ b/src/src.pro @@ -5,7 +5,7 @@ TEMPLATE = lib TARGET = qhttpserver -unix:VERSION = 0.1.0 +!win32:VERSION = 0.1.0 QT += network QT -= gui From 28636b3e625e41fe3bf51c09b0ab9048c0c040dc Mon Sep 17 00:00:00 2001 From: Nikhil Marathe Date: Fri, 27 Sep 2013 10:25:45 -0700 Subject: [PATCH 25/67] Remove QString variants of write() and end(). Force explicit conversion so Content-Length errors are more obvious. Fixes #16. --- examples/bodydata/bodydata.cpp | 8 ++++---- examples/greeting/greeting.cpp | 4 ++-- examples/helloworld/helloworld.cpp | 2 +- src/qhttpresponse.cpp | 10 ---------- src/qhttpresponse.h | 11 ----------- 5 files changed, 7 insertions(+), 28 deletions(-) diff --git a/examples/bodydata/bodydata.cpp b/examples/bodydata/bodydata.cpp index a996b61..40efdc1 100644 --- a/examples/bodydata/bodydata.cpp +++ b/examples/bodydata/bodydata.cpp @@ -21,13 +21,13 @@ Responder::Responder(QHttpRequest *req, QHttpResponse *resp) resp->writeHead(200); QString name = exp.capturedTexts()[1]; - QString reply = tr("BodyData App

Hello %1!

").arg(name); - resp->write(reply); + QString reply = tr("BodyData App

Hello %1!

").arg(name); + resp->write(reply.toUtf8()); } else { resp->writeHead(403); - resp->end(QStringLiteral("You aren't allowed here!")); + resp->end(QByteArray("You aren't allowed here!")); // TODO: there should be a way to tell request to stop streaming data return; } @@ -50,7 +50,7 @@ void Responder::accumulate(const QByteArray &data) void Responder::reply() { - m_resp->end(QStringLiteral("

")); + m_resp->end(QByteArray("

")); } BodyData::BodyData() diff --git a/examples/greeting/greeting.cpp b/examples/greeting/greeting.cpp index dc9d726..f51b8b9 100644 --- a/examples/greeting/greeting.cpp +++ b/examples/greeting/greeting.cpp @@ -26,12 +26,12 @@ void Greeting::handle(QHttpRequest *req, QHttpResponse *resp) QString name = exp.capturedTexts()[1]; QString reply = tr("Greeting App

Hello %1!

"); - resp->end(reply.arg(name)); + resp->end(reply.arg(name).toUtf8()); } else { resp->writeHead(403); - resp->end(QStringLiteral("You aren't allowed here!")); + resp->end(QByteArray("You aren't allowed here!")); } } diff --git a/examples/helloworld/helloworld.cpp b/examples/helloworld/helloworld.cpp index 16a12b6..b9ac6d2 100644 --- a/examples/helloworld/helloworld.cpp +++ b/examples/helloworld/helloworld.cpp @@ -19,7 +19,7 @@ void Hello::handle(QHttpRequest *req, QHttpResponse *resp) Q_UNUSED(req); resp->setHeader("Content-Length", "11"); resp->writeHead(200); - resp->write(QString("Hello World")); + resp->write(QByteArray("Hello World")); resp->end(); } diff --git a/src/qhttpresponse.cpp b/src/qhttpresponse.cpp index cfa442a..2304823 100644 --- a/src/qhttpresponse.cpp +++ b/src/qhttpresponse.cpp @@ -163,11 +163,6 @@ void QHttpResponse::write(const QByteArray &data) m_connection->write(data); } -void QHttpResponse::write(const QString &data) -{ - write(data.toUtf8()); -} - void QHttpResponse::end(const QByteArray &data) { if(m_finished) { @@ -182,11 +177,6 @@ void QHttpResponse::end(const QByteArray &data) // TODO: end connection and delete ourselves } -void QHttpResponse::end(const QString &data) -{ - end(data.toUtf8()); -} - void QHttpResponse::connectionClosed() { m_finished = true; diff --git a/src/qhttpresponse.h b/src/qhttpresponse.h index ad5ceec..1095c42 100644 --- a/src/qhttpresponse.h +++ b/src/qhttpresponse.h @@ -109,12 +109,6 @@ public slots: */ void write(const QByteArray &data); - /*! - * Write a QString instead of a QByteArray. - * \see write(const QByteArray &); - */ - void write(const QString &data); - /*! * End the response. Data will be flushed * to the underlying socket and the connection @@ -126,11 +120,6 @@ public slots: */ void end(const QByteArray &data=QByteArray()); - /*! - * End with a QString. - */ - void end(const QString &data); - /*! * Set a response header @c field to @c value */ From c13999540004126582ff1dcd2a60851007412cb0 Mon Sep 17 00:00:00 2001 From: Jonne Nauha Date: Sat, 28 Sep 2013 00:00:47 +0300 Subject: [PATCH 26/67] Improve .gitignore --- .gitignore | 28 ++++++++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index 427e250..e7540b8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,10 +1,30 @@ +# Folders build lib + +# Generated Makefile *.o moc_* -examples/helloworld/helloworld + +# Docs docs/html -tests/tests -examples/greeting/greeting -examples/bodydata/bodydata + +# Build folders +*/debug +*/release +*/*/debug +*/*/release + +# Visual studio +*.suo +*.ncb +*.user +*.pdb +*.idb +*.vcproj +*.vcxproj +*.vcxproj.filters +*.lib +*.sln +*.rc From d641e779153564b0b7f75597761b06cf452dde23 Mon Sep 17 00:00:00 2001 From: Jonne Nauha Date: Sat, 28 Sep 2013 00:05:01 +0300 Subject: [PATCH 27/67] Remove the windows spesific note from my name, I've now done other stuff too and will continue to provide more :) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7b04d0c..6266471 100644 --- a/README.md +++ b/README.md @@ -65,4 +65,4 @@ Contributors * Nikhil Marathe (maintainer) * David Wolinsy -* Jonne Nauha (Windows build fixes) +* Jonne Nauha From 02e8fba81e4c9efc16312bc7fda900c338ab37d6 Mon Sep 17 00:00:00 2001 From: Jonne Nauha Date: Sat, 28 Sep 2013 02:34:01 +0300 Subject: [PATCH 28/67] Improve documentation. Changed to use the /** and @ style of doxygen, uniformed to single style accross the codebase. Separated main page and examples to own files. Reworked examples to be more clear and to the point, added parenting to the QHttpServer object so it wont leak. --- docs/Doxyfile | 2541 +++++++++++++++++----------- docs/pages/examples.dox | 10 + docs/pages/main-page.dox | 105 ++ examples/bodydata/bodydata.cpp | 65 +- examples/bodydata/bodydata.h | 16 +- examples/greeting/greeting.cpp | 23 +- examples/greeting/greeting.h | 8 +- examples/helloworld/helloworld.cpp | 24 +- examples/helloworld/helloworld.h | 12 +- src/qhttpconnection.cpp | 4 + src/qhttpconnection.h | 9 +- src/qhttprequest.cpp | 61 + src/qhttprequest.h | 238 ++- src/qhttpresponse.cpp | 5 + src/qhttpresponse.h | 101 +- src/qhttpserver.h | 201 +-- 16 files changed, 2031 insertions(+), 1392 deletions(-) create mode 100644 docs/pages/examples.dox create mode 100644 docs/pages/main-page.dox diff --git a/docs/Doxyfile b/docs/Doxyfile index 724dfa0..ebc46e7 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -1,103 +1,112 @@ -# Doxyfile 1.7.3 +# Doxyfile 1.8.5 # This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project -# -# All text after a hash (#) is considered a comment and will be ignored +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. # The format is: -# TAG = value [value, ...] -# For lists items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" ") +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# http://www.gnu.org/software/libiconv for the list of possible encodings. +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded -# by quotes) that should identify the project. +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. PROJECT_NAME = QHttpServer -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. PROJECT_NUMBER = 0.1 # Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer -# a quick idea about the purpose of the project. Keep the description short. +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = "A Qt based asynchronous Http Server" -# With the PROJECT_LOGO tag one can specify an logo or icon that is -# included in the documentation. The maximum height of the logo should not -# exceed 55 pixels and the maximum width should not exceed 200 pixels. -# Doxygen will copy the logo to the output directory. +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. PROJECT_LOGO = -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location -# where doxygen was started. If left blank the current directory will be used. +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. -OUTPUT_DIRECTORY = /home/nikhil/workspace/qhttpserver/docs +OUTPUT_DIRECTORY = ./ -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would -# otherwise cause performance problems for the file system. +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. CREATE_SUBDIRS = NO -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese- +# Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi, +# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en, +# Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, +# Turkish, Ukrainian and Vietnamese. +# The default value is: English. OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). -# Set to NO to disable this. +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. +# The default value is: YES. REPEAT_BRIEF = YES -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" -# "represents" "a" "an" "the" +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = "The $name class" \ "The $name widget" \ @@ -111,1295 +120,1785 @@ ABBREVIATE_BRIEF = "The $name class" \ an \ the -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief # description. +# The default value is: NO. ALWAYS_DETAILED_SEC = NO -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. +# The default value is: NO. INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. FULL_PATH_NAMES = YES -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the -# path to strip. +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that -# are normally passed to the compiler using the -I flag. +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. STRIP_FROM_INC_PATH = -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful if your file system -# doesn't support long names like on DOS, Mac, or CD-ROM. +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. SHORT_NAMES = NO -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like regular Qt-style comments -# (thus requiring an explicit @brief command for a brief description.) +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. JAVADOC_AUTOBRIEF = NO -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will -# interpret the first line (until the first dot) of a Qt-style -# comment as the brief description. If set to NO, the comments -# will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. -QT_AUTOBRIEF = NO +QT_AUTOBRIEF = YES -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed -# description. Set this tag to YES if you prefer the old behaviour instead. +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. -MULTILINE_CPP_IS_BRIEF = NO +MULTILINE_CPP_IS_BRIEF = YES -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. INHERIT_DOCS = YES -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will -# be part of the file/class/namespace that contains it. +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. SEPARATE_MEMBER_PAGES = NO -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 4 -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. ALIASES = -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list -# of all members will be omitted, etc. +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = NO -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified -# scopes will look different, etc. +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources only. Doxygen will then generate output that is more tailored for -# Fortran. +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for -# VHDL. +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given extension. -# Doxygen has a built-in mapping, but you can override or extend it using this -# tag. The format is ext=language, where ext is a file extension, and language -# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, -# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C -# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions -# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. EXTENSION_MAPPING = -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also makes the inheritance and collaboration +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. +# The default value is: NO. BUILTIN_STL_SUPPORT = NO -# If you use Microsoft's C++/CLI language, you should set this option to YES to +# If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. +# The default value is: NO. CPP_CLI_SUPPORT = NO -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. -# Doxygen will parse them like normal C++ but will assume all classes use public -# instead of private inheritance when no explicit protection keyword is present. +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. SIP_SUPPORT = NO -# For Microsoft's IDL there are propget and propput attributes to indicate getter -# and setter methods for a property. Setting this option to YES (the default) -# will make doxygen replace the get and set methods by a property in the -# documentation. This will only work if the methods are indeed getting or -# setting a simple type. If this is not the case, or you want to show the -# methods anyway, you should set this option to NO. +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. IDL_PROPERTY_SUPPORT = YES -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. +# The default value is: NO. DISTRIBUTE_GROUP_DOC = NO -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using -# the \nosubgrouping command. +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. SUBGROUPING = YES -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code in case the coding convention dictates that all compound +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. TYPEDEF_HIDES_STRUCT = NO -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penalty. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will roughly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols - -SYMBOL_CACHE_SIZE = 0 +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. EXTRACT_ALL = NO -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. EXTRACT_PRIVATE = NO -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. EXTRACT_STATIC = NO -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. -# If set to NO only classes defined in header files are included. +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. EXTRACT_LOCAL_CLASSES = YES -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. -# If set to NO (the default) only methods in the interface are included. +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. EXTRACT_LOCAL_METHODS = NO -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base -# name of the file that contains the anonymous namespace. By default -# anonymous namespaces are hidden. +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. EXTRACT_ANON_NSPACES = NO -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. HIDE_UNDOC_MEMBERS = NO -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. HIDE_UNDOC_CLASSES = NO -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the -# documentation. +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the -# function's detailed documentation block. +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. HIDE_IN_BODY_DOCS = NO -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. INTERNAL_DOCS = NO -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. +# The default value is: system dependent. CASE_SENSE_NAMES = NO -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. HIDE_SCOPE_NAMES = NO -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. SHOW_INCLUDE_FILES = YES -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen -# will list include files with double quotes in the documentation -# rather than with sharp brackets. +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. FORCE_LOCAL_INCLUDES = NO -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] -# is inserted in the documentation for inline members. +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in -# declaration order. +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. SORT_MEMBER_DOCS = YES -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: NO. SORT_BRIEF_DOCS = NO -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen -# will sort the (brief and detailed) documentation of class members so that -# constructors and destructors are listed first. If set to NO (the default) -# the constructors will appear in the respective orders defined by -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the default) -# the group names will appear in their defined order. +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. SORT_GROUP_NAMES = NO -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the -# alphabetical list. +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. SORT_BY_SCOPE_NAME = NO -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to -# do proper type resolution of all parameters of a function it will reject a -# match between the prototype and the implementation of a member function even -# if there is only one candidate or it is obvious which candidate to choose -# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen -# will still accept a match between prototype and implementation in such cases. +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. STRICT_PROTO_MATCHING = NO -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo -# commands in the documentation. +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. -GENERATE_TODOLIST = YES +GENERATE_TODOLIST = NO -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test -# commands in the documentation. +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. GENERATE_TESTLIST = YES -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug -# commands in the documentation. +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. GENERATE_BUGLIST = YES -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting -# \deprecated commands in the documentation. +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. GENERATE_DEPRECATEDLIST= YES -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. ENABLED_SECTIONS = -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or macro consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and macros in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the -# list will mention the files that were used to generate the documentation. - -SHOW_USED_FILES = YES - -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is NO. +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. -SHOW_DIRECTORIES = NO +SHOW_USED_FILES = NO -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. -# This will remove the Files entry from the Quick Index and from the -# Folder Tree View (if specified). The default is YES. +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. -SHOW_FILES = YES +SHOW_FILES = NO -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the -# Namespaces page. This will remove the Namespaces entry from the Quick Index -# and from the Folder Tree View (if specified). The default is YES. +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. SHOW_NAMESPACES = YES -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. FILE_VERSION_FILTER = -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. The create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. -# You can optionally specify a file name after the option, if omitted -# DoxygenLayout.xml will be used as the name of the layout file. +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. LAYOUT_FILE = +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + #--------------------------------------------------------------------------- -# configuration options related to warning and progress messages +# Configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. QUIET = NO -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank -# NO is used. +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. WARNINGS = YES -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will -# automatically be disabled. +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. WARN_IF_UNDOCUMENTED = YES -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. WARN_IF_DOC_ERROR = YES -# The WARN_NO_PARAMDOC option can be enabled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. WARN_NO_PARAMDOC = NO -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- -# configuration options related to the input files +# Configuration options related to the input files #--------------------------------------------------------------------------- -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. -INPUT = /home/nikhil/workspace/qhttpserver/src +INPUT = pages \ + ../src -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for -# the list of possible encodings. +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. INPUT_ENCODING = UTF-8 -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh -# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py -# *.f90 *.f *.for *.vhd *.vhdl - -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.d \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = *.cpp \ *.inl \ *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.idl \ - *.odl \ - *.cs \ - *.php \ - *.php3 \ - *.inc \ - *.m \ - *.mm \ - *.dox \ - *.py \ - *.f90 \ - *.f \ - *.for \ - *.vhd \ - *.vhdl - -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. + *.dox + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. RECURSIVE = YES -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. EXCLUDE = -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded # from the input. +# The default value is: NO. EXCLUDE_SYMLINKS = NO -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories -# for example use the pattern */test/* +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* -EXCLUDE_PATTERNS = +EXCLUDE_PATTERNS = ui_*.h \ + moc_* -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). EXAMPLE_PATH = ../examples -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank all files are included. +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. EXAMPLE_PATTERNS = * -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. EXAMPLE_RECURSIVE = NO -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). IMAGE_PATH = -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be -# ignored. +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. INPUT_FILTER = -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty or if -# non of the patterns match the file name, INPUT_FILTER is applied. +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. FILTER_PATTERNS = -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. FILTER_SOURCE_FILES = NO -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) -# and it is also possible to disable source filtering for a specific pattern -# using *.ext= (so without naming a filter). This option only has effect when -# FILTER_SOURCE_FILES is enabled. +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + #--------------------------------------------------------------------------- -# configuration options related to source browsing +# Configuration options related to source browsing #--------------------------------------------------------------------------- -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. SOURCE_BROWSER = NO -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. INLINE_SOURCES = NO -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C and C++ comments will always remain visible. +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES -# then for each documented function all documented -# functions referencing it will be listed. +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. REFERENCED_BY_RELATION = NO -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities -# called/used by that function will be listed. +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. REFERENCES_RELATION = NO -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. Otherwise they will link to the documentation. +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. REFERENCES_LINK_SOURCE = YES -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You -# will need version 4.8.6 or higher. +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. VERBATIM_HEADERS = YES +# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more acurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# compiled with the --with-libclang option. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + #--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index +# Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project -# contains a lot of classes, structs, unions or interfaces. +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. ALPHABETICAL_INDEX = YES -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that -# should be ignored while generating the index headers. +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- -# configuration options related to the HTML output +# Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. GENERATE_HTML = YES -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `html' will be used as the default path. +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank -# doxygen will generate files with .html extension. +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a # standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# stylesheet in the HTML output directory as well, or it will be erased! +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. -# Doxygen will adjust the colors in the stylesheet and background images -# according to this color. Hue is specified as an angle on a colorwheel, -# see http://en.wikipedia.org/wiki/Hue for more information. -# For instance the value 0 represents red, 60 is yellow, 120 is green, -# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. -# The allowed range is 0 to 359. +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of -# the colors in the HTML output. For a value of 0 the output will use -# grayscales only. A value of 255 will produce the most vivid colors. +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to -# the luminance component of the colors in the HTML output. Values below -# 100 gradually make the output lighter, whereas values above 100 make -# the output darker. The value divided by 100 is the actual gamma applied, -# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, -# and 100 does not change the gamma. +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = YES -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. - -HTML_ALIGN_MEMBERS = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. For this to work a browser that supports -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox -# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO -# If the GENERATE_DOCSET tag is set to YES, additional index files -# will be generated that can be used as input for Apple's Xcode 3 -# integrated development environment, introduced with OSX 10.5 (Leopard). -# To create a documentation set, doxygen will generate a Makefile in the -# HTML output directory. Running make will produce the docset in that -# directory and running "make install" will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find -# it at startup. -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product suite) -# can be grouped. +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen -# will append .docset to the name. +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher -# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be # written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file -# content. +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO -# The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the HTML help documentation and to the tree view. +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated -# that can be used as input for Qt's qhelpgenerator to generate a -# Qt Compressed Help (.qch) of the generated HTML documentation. +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can -# be used to specify the file name of the resulting .qch file. -# The path specified is relative to the HTML output folder. +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#namespace +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#virtual-folders +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to -# add. For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see -# -# Qt Help Project / Custom Filters. +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's -# filter section matches. -# -# Qt Help Project / Filter Attributes. +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated -# .qhp file. +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files -# will be generated, which together with the HTML files, form an Eclipse help -# plugin. To install this plugin and make it available under the help contents -# menu in Eclipse, the contents of the directory containing the HTML and XML -# files needs to be copied into the plugins directory of eclipse. The name of -# the directory within the plugins directory should be the same as -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before -# the help appears. +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO -# A unique identifier for the eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have -# this name. +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO -# This tag can be used to set the number of enum values (range [0,1..20]) -# that doxygen will group on one line in the generated HTML documentation. -# Note that a value of 0 will completely suppress the enum values from -# appearing in the overview section. - -ENUM_VALUES_PER_LINE = 4 - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. -# If the tag value is set to YES, a side panel will be generated -# containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). -# Windows users are probably better off using the HTML help feature. +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NO -# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list. +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. -USE_INLINE_TREES = NO +ENUM_VALUES_PER_LINE = 4 -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree -# is shown. +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open -# links to external symbols imported via tag files in a separate window. +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory -# to force them to be regenerated. +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are -# not supported properly for IE 6.0, but are supported on all modern browsers. -# Note that when changing this option you need to delete any form_*.png files -# in the HTML output before the changes have effect. +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax -# (see http://www.mathjax.org) which uses client side Javascript for the -# rendering instead of using prerendered bitmaps. Use this if you do not -# have LaTeX installed or if you want to formulas look prettier in the HTML -# output. When enabled you also need to install MathJax separately and -# configure the path to it using the MATHJAX_RELPATH option. +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO -# When MathJax is enabled you need to specify the location relative to the -# HTML output directory using the MATHJAX_RELPATH option. The destination -# directory should contain the MathJax.js script. For instance, if the mathjax -# directory is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the -# mathjax.org site, so you can quickly see the result without installing -# MathJax, but it is strongly recommended to install a local copy of MathJax -# before deployment. +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://www.mathjax.org/mathjax -# When the SEARCHENGINE tag is enabled doxygen will generate a search box -# for the HTML output. The underlying search engine uses javascript -# and DHTML and should work on any modern browser. Note that when using -# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets -# (GENERATE_DOCSET) there is already a search function so this one should -# typically be disabled. For large projects the javascript based search engine -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /