aboutsummaryrefslogtreecommitdiffstats
path: root/src/modules/objects/KvsObject_http.cpp
diff options
context:
space:
mode:
authorGravatar un1versal2016-03-02 12:15:44 +0000
committerGravatar un1versal2016-03-14 04:57:12 +0000
commitf138911b65dfce85c551f9e2e4bbeb595d6c6755 (patch)
tree701d5eec803c30160be47f8762b5838e57bc44dd /src/modules/objects/KvsObject_http.cpp
parentcleanup: add or remove empty lines between documentation blocks & code (diff)
downloadKVIrc-f138911b65dfce85c551f9e2e4bbeb595d6c6755.tar.gz
KVIrc-f138911b65dfce85c551f9e2e4bbeb595d6c6755.tar.bz2
KVIrc-f138911b65dfce85c551f9e2e4bbeb595d6c6755.zip
documentation: formatting/indentation + minor syntax fixes
+ Dont use double quotes to emphasise words in normal circumstances. + improve indenting + consistency (good for readability when editing source) + also replace single quotes
Diffstat (limited to 'src/modules/objects/KvsObject_http.cpp')
-rw-r--r--src/modules/objects/KvsObject_http.cpp2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/modules/objects/KvsObject_http.cpp b/src/modules/objects/KvsObject_http.cpp
index 3d01509d2..57bb11d74 100644
--- a/src/modules/objects/KvsObject_http.cpp
+++ b/src/modules/objects/KvsObject_http.cpp
@@ -100,7 +100,7 @@
The function returns a unique identifier which is passed by [b]requestStartedEvent()[/b] and [b]requestFinishedEvent()[/b].
When the request is started the requestStarted() signal is emitted. When it is finished the requestFinished() signal is emitted.
!fn: <id:integer>$currentId()
- Returns the identifier of the HTTP request being executed or 0 if there is no request being executed.
+ Returns the identifier of the HTTP request being executed or [b]0[/b] if there is no request being executed.
!fn: <id:integer> $setProxy(<host:string>,<port:integer>,[<user:string>,<password:string>])
Enables HTTP proxy support, using the proxy server host on port port.
Optionals parameters user and password can be provided if the proxy server requires authentication.