Someone is getting slapped for this; the new hidesplits/hidebans behavior doesn't...

[user/henk/code/inspircd.git] / src / modules / httpd.h

diff --git a/src/modules/httpd.h b/src/modules/httpd.h
index 7738e3fe4cb2f4da234b0815311516c247983bec..a8b0bafcdc81f2c26307d27c8972e67d0c508eac 100644 (file)
--- a/src/modules/httpd.h
+++ b/src/modules/httpd.h
@@ -1,3 +1,16 @@
+/*       +------------------------------------+
+ *       | Inspire Internet Relay Chat Daemon |
+ *       +------------------------------------+
+ *
+ *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
+ * This program is free but copyrighted software; see
+ *            the file COPYING for details.
+ *
+ * ---------------------------------------------------
+ */
+
 #include "base.h"
 
 #ifndef __HTTPD_H__
@@ -34,6 +47,7 @@ class HTTPRequest : public classbase
         * @param hdr The headers sent with the request
         * @param opaque An opaque pointer used internally by m_httpd, which you must pass back to the module in your reply.
         * @param ip The IP address making the web request.
+        * @param pdata The post data (content after headers) received with the request, up to Content-Length in size
         */
        HTTPRequest(const std::string &request_type, const std::string &uri, std::stringstream* hdr, void* opaque, const std::string &ip, const std::string &pdata)
                : type(request_type), document(uri), ipaddr(ip), postdata(pdata), headers(hdr), sock(opaque)
@@ -49,6 +63,10 @@ class HTTPRequest : public classbase
                return headers;
        }
 
+       /** Get the post data (request content).
+        * All post data will be returned, including carriage returns and linefeeds.
+        * @return The postdata
+        */
        std::string& GetPostData()
        {
                return postdata;