From 2f82b670716c8b1188db8cb036fe5b7dea0fc490 Mon Sep 17 00:00:00 2001
From: Poommetee Ketson
Date: Fri, 20 Apr 2018 16:25:06 +0700
Subject: [DOCS] add HTTPRequest.request return values
(cherry picked from commit f05e24ed18575e2f48270025c4c2bb0705c667b5)
---
doc/classes/HTTPRequest.xml | 2 ++
1 file changed, 2 insertions(+)
(limited to 'doc/classes')
diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml
index beb40a9fb..ef29eb4b6 100644
--- a/doc/classes/HTTPRequest.xml
+++ b/doc/classes/HTTPRequest.xml
@@ -55,6 +55,8 @@
+ Creates request on the underlying [HTTPClient]. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request].
+ Returns [code]OK[/code] if request is successfully created. (Does not imply that the server has responded), [code]ERR_UNCONFIGURED[/code] if not in the tree, [code]ERR_BUSY[/code] if still processing previous request, [code]ERR_INVALID_PARAMETER[/code] if given string is not a valid URL format, or [code]ERR_CANT_CONNECT[/code] if not using thread and the [HTTPClient] cannot connect to host.
--
cgit v1.2.3-70-g09d2