add file header to src/*.hpp files.

charliewolf · Jul 11, 2014 · 186e693 · 186e693
1 parent 86f1334
commit 186e693
Show file tree

Hide file tree

Showing 17 changed files with 138 additions and 2 deletions.
diff --git a/src/private/qhttpbase.hpp b/src/private/qhttpbase.hpp
@@ -1,3 +1,11 @@
+/** base classes for private implementations.
+ * https://github.com/azadkuh/qhttp
+ *
+ * @author amir zamani
+ * @version 2.0.0
+ * @date 2014-07-11
+  */
+
 #ifndef QHTTPBASE_HPP
 #define QHTTPBASE_HPP
 

diff --git a/src/private/qhttpclient_private.hpp b/src/private/qhttpclient_private.hpp
@@ -1,3 +1,11 @@
+/** private imeplementation.
+ * https://github.com/azadkuh/qhttp
+ *
+ * @author amir zamani
+ * @version 2.0.0
+ * @date 2014-07-11
+  */
+
 #ifndef QHTTPCLIENT_PRIVATE_HPP
 #define QHTTPCLIENT_PRIVATE_HPP
 ///////////////////////////////////////////////////////////////////////////////

diff --git a/src/private/qhttpclientrequest_private.hpp b/src/private/qhttpclientrequest_private.hpp
@@ -1,3 +1,11 @@
+/** private imeplementation.
+ * https://github.com/azadkuh/qhttp
+ *
+ * @author amir zamani
+ * @version 2.0.0
+ * @date 2014-07-11
+  */
+
 #ifndef QHTTPCLIENT_REQUEST_PRIVATE_HPP
 #define QHTTPCLIENT_REQUEST_PRIVATE_HPP
 ///////////////////////////////////////////////////////////////////////////////

diff --git a/src/private/qhttpclientresponse_private.hpp b/src/private/qhttpclientresponse_private.hpp
@@ -1,3 +1,11 @@
+/** private imeplementation.
+ * https://github.com/azadkuh/qhttp
+ *
+ * @author amir zamani
+ * @version 2.0.0
+ * @date 2014-07-11
+  */
+
 #ifndef QHTTPCLIENT_RESPONSE_PRIVATE_HPP
 #define QHTTPCLIENT_RESPONSE_PRIVATE_HPP
 ///////////////////////////////////////////////////////////////////////////////

diff --git a/src/private/qhttpserver_private.hpp b/src/private/qhttpserver_private.hpp
@@ -1,3 +1,11 @@
+/** private imeplementation.
+ * https://github.com/azadkuh/qhttp
+ *
+ * @author amir zamani
+ * @version 2.0.0
+ * @date 2014-07-11
+  */
+
 #ifndef QHTTPSERVER_PRIVATE_HPP
 #define QHTTPSERVER_PRIVATE_HPP
 ///////////////////////////////////////////////////////////////////////////////

diff --git a/src/private/qhttpserverconnection_private.hpp b/src/private/qhttpserverconnection_private.hpp
@@ -1,3 +1,11 @@
+/** private imeplementation.
+ * https://github.com/azadkuh/qhttp
+ *
+ * @author amir zamani
+ * @version 2.0.0
+ * @date 2014-07-11
+  */
+
 #ifndef QHTTPSERVER_CONNECTION_PRIVATE_HPP
 #define QHTTPSERVER_CONNECTION_PRIVATE_HPP
 ///////////////////////////////////////////////////////////////////////////////

diff --git a/src/private/qhttpserverrequest_private.hpp b/src/private/qhttpserverrequest_private.hpp
@@ -1,3 +1,11 @@
+/** private imeplementation.
+ * https://github.com/azadkuh/qhttp
+ *
+ * @author amir zamani
+ * @version 2.0.0
+ * @date 2014-07-11
+  */
+
 #ifndef QHTTPSERVER_REQUEST_PRIVATE_HPP
 #define QHTTPSERVER_REQUEST_PRIVATE_HPP
 ///////////////////////////////////////////////////////////////////////////////

diff --git a/src/private/qhttpserverresponse_private.hpp b/src/private/qhttpserverresponse_private.hpp
@@ -1,3 +1,11 @@
+/** private imeplementation.
+ * https://github.com/azadkuh/qhttp
+ *
+ * @author amir zamani
+ * @version 2.0.0
+ * @date 2014-07-11
+  */
+
 #ifndef QHTTPSERVER_RESPONSE_PRIVATE_HPP
 #define QHTTPSERVER_RESPONSE_PRIVATE_HPP
 ///////////////////////////////////////////////////////////////////////////////

diff --git a/src/qhttpabstracts.hpp b/src/qhttpabstracts.hpp
@@ -1,3 +1,11 @@
+/** interfaces of QHttp' incomming and outgoing classes.
+ * https://github.com/azadkuh/qhttp
+ *
+ * @author amir zamani
+ * @version 2.0.0
+ * @date 2014-07-11
+  */
+
 #ifndef QHTTPABSTRACTS_HPP
 #define QHTTPABSTRACTS_HPP
 

diff --git a/src/qhttpclient.hpp b/src/qhttpclient.hpp
@@ -1,3 +1,11 @@
+/** HTTP client class.
+ * https://github.com/azadkuh/qhttp
+ *
+ * @author amir zamani
+ * @version 2.0.0
+ * @date 2014-07-11
+  */
+
 #ifndef QHTTPCLIENT_HPP
 #define QHTTPCLIENT_HPP
 
@@ -11,7 +19,7 @@ namespace qhttp {
 namespace client {
 ///////////////////////////////////////////////////////////////////////////////
 
-/** a simple HTTP client class which sends a request to an HTTP server and parses the
+/** a simple and async HTTP client class which sends a request to an HTTP server and parses the
  *  corresponding response.
  * This class internally handles the memory management and life cycle of QHttpRequest and
  *  QHttpResponse instances. you do not have to manually delete or keep their pointers.

diff --git a/src/qhttpclientrequest.hpp b/src/qhttpclientrequest.hpp
@@ -1,3 +1,11 @@
+/** HTTP request from a client.
+ * https://github.com/azadkuh/qhttp
+ *
+ * @author amir zamani
+ * @version 2.0.0
+ * @date 2014-07-11
+  */
+
 #ifndef QHTTPCLIENT_REQUEST_HPP
 #define QHTTPCLIENT_REQUEST_HPP
 

diff --git a/src/qhttpclientresponse.hpp b/src/qhttpclientresponse.hpp
@@ -1,3 +1,11 @@
+/** HTTP response received by client.
+ * https://github.com/azadkuh/qhttp
+ *
+ * @author amir zamani
+ * @version 2.0.0
+ * @date 2014-07-11
+  */
+
 #ifndef QHTTPCLIENT_RESPONSE_HPP
 #define QHTTPCLIENT_RESPONSE_HPP
 ///////////////////////////////////////////////////////////////////////////////

diff --git a/src/qhttpfwd.hpp b/src/qhttpfwd.hpp
@@ -1,3 +1,11 @@
+/** forward declarations and general definitions of the QHttp.
+ * https://github.com/azadkuh/qhttp
+ *
+ * @author amir zamani
+ * @version 2.0.0
+ * @date 2014-07-11
+  */
+
 #ifndef QHTTPFWD_HPP
 #define QHTTPFWD_HPP
 ///////////////////////////////////////////////////////////////////////////////

diff --git a/src/qhttpserver.hpp b/src/qhttpserver.hpp
@@ -1,3 +1,11 @@
+/** HTTP server class.
+ * https://github.com/azadkuh/qhttp
+ *
+ * @author amir zamani
+ * @version 2.0.0
+ * @date 2014-07-11
+  */
+
 #ifndef QHTTPSERVER_HPP
 #define QHTTPSERVER_HPP
 
@@ -12,7 +20,7 @@ namespace qhttp {
 namespace server {
 ///////////////////////////////////////////////////////////////////////////////
 
-/** The QHttpServer class is a fast, non-blocking HTTP server. */
+/** The QHttpServer class is a fast, async (non-blocking) HTTP server. */
 class QHttpServer : public QTcpServer
 {
     Q_OBJECT

diff --git a/src/qhttpserverconnection.hpp b/src/qhttpserverconnection.hpp
@@ -1,3 +1,11 @@
+/** HTTP connection class.
+ * https://github.com/azadkuh/qhttp
+ *
+ * @author amir zamani
+ * @version 2.0.0
+ * @date 2014-07-11
+  */
+
 #ifndef QHTTPSERVER_CONNECTION_HPP
 #define QHTTPSERVER_CONNECTION_HPP
 ///////////////////////////////////////////////////////////////////////////////

diff --git a/src/qhttpserverrequest.hpp b/src/qhttpserverrequest.hpp
@@ -1,3 +1,11 @@
+/** HTTP request which is received by the server.
+ * https://github.com/azadkuh/qhttp
+ *
+ * @author amir zamani
+ * @version 2.0.0
+ * @date 2014-07-11
+  */
+
 #ifndef QHTTPSERVER_REQUEST_HPP
 #define QHTTPSERVER_REQUEST_HPP
 ///////////////////////////////////////////////////////////////////////////////

diff --git a/src/qhttpserverresponse.hpp b/src/qhttpserverresponse.hpp
@@ -1,3 +1,11 @@
+/** HTTP response from a server.
+ * https://github.com/azadkuh/qhttp
+ *
+ * @author amir zamani
+ * @version 2.0.0
+ * @date 2014-07-11
+  */
+
 #ifndef QHTTPSERVER_RESPONSE_HPP
 #define QHTTPSERVER_RESPONSE_HPP