From 4e18af418a7ba8a1a35de0cfc4a42f1a88436223 Mon Sep 17 00:00:00 2001 From: un1versal Date: Mon, 23 Nov 2015 16:19:46 +0000 Subject: fix the crazy formatting on help files --- src/modules/objects/KvsObject_ftp.cpp | 29 +++++++++++++++-------------- src/modules/objects/KvsObject_http.cpp | 14 +++++++------- 2 files changed, 22 insertions(+), 21 deletions(-) (limited to 'src/modules') diff --git a/src/modules/objects/KvsObject_ftp.cpp b/src/modules/objects/KvsObject_ftp.cpp index cf48999e2..cba762964 100644 --- a/src/modules/objects/KvsObject_ftp.cpp +++ b/src/modules/objects/KvsObject_ftp.cpp @@ -56,18 +56,19 @@ @description: This class provides a standard FTP functionality.[br] @functions: - !fn:$dataAvailableEvent() - This function is called when some data is available to be read: the parameter specifies - the length of the available data in bytes.[br] + !fn:$dataAvailableEvent() + This function is called when some data is available to be read.[br] + The parameter specifies the length of the available data in bytes.[br] You can use one of the $read* functions to obtain the data. - !fn: $connect(,) - Connects to the FTP server host using port port.The command is scheduled, and its execution is performed asynchronously. - The function returns a unique identifier which is passed by commandStarted() and commandFinished().[br] + !fn: $connect(,) + Connects to the FTP server host using port port.[br] + The command is scheduled, and its execution is performed asynchronously.[br] + The function returns a unique identifier which is passed by [b]commandStarted()[/b] and [b]commandFinished()[/b]. !fn:$abort() Aborts the current command and deletes all scheduled commands. !fn: $login(,) - Logs in to the FTP server with the username user and the password . - The function returns a unique identifier which is passed by commandStarted() and commandFinished().[br] + Logs in to the FTP server with the username user and the password .[br] + The function returns a unique identifier which is passed by [b]commandStarted()[/b] and [b]commandFinished()[/b]. !fn: $get(,) Downloads the file from the server. !fn: $put(,) @@ -75,16 +76,16 @@ !fn: $cd() Changes the working directory of the server to . !fn: $list() - Lists the contents of directory dir on the FTP server. + Lists the contents of the directory on the FTP server. !fn: $commandFinishedEvent(,) - Called by KVIrc when the ftp command identified by id has finished. - error is true if an error occurred during the processing; otherwise error is false. - The default implementation emits the [classfnc]$commandFinished[/classfnc]() signal. + Called by KVIrc when the FTP command identified by id has finished.[br] + Error is true if an error occurred during the processing; otherwise error is false.[br] + The default implementation emits the [classfnc]$commandFinished[/classfnc]() signal.[br] !fn: $listInfoEvent() - This event is triggered for each directory entry found by [classfnc]$list[/classfnc]() command. + This event is triggered for each directory entry found by [classfnc]$list[/classfnc]() command.[br] The default implementation emits the [classfnc]$listInfo[/classfnc]() signal. !fn: $dataTransferProgressEvent(,) - This event is triggered in response to a [classfnc]get[/classfnc]() or [classfnc]put[/classfnc]() request to indicate the current progress of the download or upload. + This event is triggered in response to a [b]get()[/b] or [b]put()[/b] request to indicate the current progress of the download or upload.[br] The default implementation emits the [classfnc]$dataTransferProgress[/classfnc]() signal. @signals: !sg: $commandFinished(,,) diff --git a/src/modules/objects/KvsObject_http.cpp b/src/modules/objects/KvsObject_http.cpp index 2c898a2a3..d8dcf4a55 100644 --- a/src/modules/objects/KvsObject_http.cpp +++ b/src/modules/objects/KvsObject_http.cpp @@ -88,16 +88,16 @@ @functions: !fn: $get(,[]) Sends a get request for path to the server set by [classfnc]$setHost[/classfnc]. - If local_file is not specified readyRead() signal is emitted every time new content data is available to read. + If local_file is not specified [b]readyRead()[/b] signal is emitted every time new content data is available to read. !fn: $post(,, Sends a post request for path to the server set by [classfnc]$setHost[/classfnc]. - If local_file is not specified readyRead() signal is emitted every time new content data is available to read. + If local_file is not specified [b]readyRead()[/b] signal is emitted every time new content data is available to read. !fn: $abort() Aborts the current request and deletes all scheduled requests. !fn: $setHost(,) Sets the HTTP server that is used for requests to hostName on port port. The function does not block: the request is scheduled, and its execution is performed asynchronously. - The function returns a unique identifier which is passed by [classfnc]requestStartedEvent()[/classfnc] and [classfnc]requestFinishedEvent()[/classfnc]. + 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: $currentId() Returns the identifier of the HTTP request being executed or 0 if there is no request being executed. @@ -129,12 +129,12 @@ !fn: $stateChangedEvent() This event is triggered by the framework when the state of the connection changes. !fn: $readyReadEvent() - This event is triggered by the framework when there is new data read and there is not file specified in [classfnc]get[/classfunc] or [classfnc]post[/classfunc]. - You can call [classfnc]readAll[/classfnc] to reads all the bytes from the response data. + This event is triggered by the framework when there is new data read and there is not file specified in [b]get[/b] or [b]post[/b]. + You can call [b]readAll[/b] to reads all the bytes from the response data. !fn: $sslErrorsEvent() Returns the list of errors that occurred during the SSL handshake. - Unless you call ignoreSslErrors() from within a slot connected to the signal emited by this event, - the framwork will tear down the connection immediately after emitting the signal. + Unless you call ignoreSslErrors() from within a slot connected to the signal emitted by this event, + the framework will tear down the connection immediately after emitting the signal. @signals: !sg: $requestStarted() This signal is emitted by the default implementation of [classfnc]$requestStartedEvent[/classfnc]. -- cgit v1.3.1-10-gc9f91