Diff: HTTPClient.h

Revision:

43:a11d8ee0380b

Parent:

42:2f464f96c204

--- a/HTTPClient.h	Mon Feb 09 21:37:04 2015 +0000
+++ b/HTTPClient.h	Mon Feb 09 22:06:14 2015 +0000
@@ -78,7 +78,7 @@
     //High Level setup functions
     /** Execute a GET request on the URL
     Blocks until completion
-    @param url : url on which to execute the request
+    @param url : url on which to execute the request. Format of: http[s]://<host>/[<path>][#fragment_id]
     @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
     @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
     @return 0 on success, HTTP error (<0) on failure
@@ -88,7 +88,7 @@
     /** Execute a GET request on the URL
     Blocks until completion
     This is a helper to directly get a piece of text from a HTTP result
-    @param url : url on which to execute the request
+    @param url : url on which to execute the request. Format of: http[s]://<host>/[<path>][#fragment_id]
     @param result : pointer to a char array in which the result will be stored
     @param maxResultLen : length of the char array (including space for the NULL-terminating char)
     @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
@@ -98,7 +98,7 @@
 
     /** Execute a POST request on the URL
     Blocks until completion
-    @param url : url on which to execute the request
+    @param url : url on which to execute the request. Format of: http[s]://<host>/[<path>][#fragment_id]
     @param dataOut : a IHTTPDataOut instance that contains the data that will be posted
     @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
     @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
@@ -108,7 +108,7 @@
 
     /** Execute a PUT request on the URL
     Blocks until completion
-    @param url : url on which to execute the request
+    @param url : url on which to execute the request. Format of: http[s]://<host>/[<path>][#fragment_id]
     @param dataOut : a IHTTPDataOut instance that contains the data that will be put
     @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
     @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
@@ -118,7 +118,7 @@
 
     /** Execute a DELETE request on the URL
     Blocks until completion
-    @param url : url on which to execute the request
+    @param url : url on which to execute the request. Format of: http[s]://<host>/[<path>][#fragment_id]
     @param pDataIn : pointer to an IHTTPDataIn instance that will collect the data returned by the request, can be NULL
     @param timeout waiting timeout in ms (osWaitForever for blocking function, not recommended)
     @return 0 on success, HTTP error (<0) on failure