From f62cc56dd9c24bbe606bfce29fde92595611d95b Mon Sep 17 00:00:00 2001 From: Fabio Bas Date: Tue, 11 Jun 2013 19:02:53 +0000 Subject: documentation fixes by OmegaWeapon git-svn-id: https://svn.kvirc.de/svn/trunk/kvirc@6340 17fca916-40b9-46aa-a4ea-0a15b648b75c --- src/modules/dcc/libkvidcc.cpp | 96 +++++++++++++++++++++---------------------- 1 file changed, 48 insertions(+), 48 deletions(-) (limited to 'src/modules/dcc/libkvidcc.cpp') diff --git a/src/modules/dcc/libkvidcc.cpp b/src/modules/dcc/libkvidcc.cpp index e9bebafcc..fe17027ef 100644 --- a/src/modules/dcc/libkvidcc.cpp +++ b/src/modules/dcc/libkvidcc.cpp @@ -1738,7 +1738,7 @@ static bool dcc_kvs_cmd_setBandwidthLimit(KviKvsModuleCommandCall * c) @title: $dcc.protocol @short: - Returns the protocol of the specified DCC + Returns the protocol of the specified DCC session @syntax: $dcc.protocol $dcc.protocol() @@ -1749,7 +1749,7 @@ static bool dcc_kvs_cmd_setBandwidthLimit(KviKvsModuleCommandCall * c) with the current window is assumed.[br] If is not a valid DCC session identifier (or it is omitted and the current window has no associated DCC session) then - this function prints a warning and returns an empty sting.[br] + this function prints a warning and returns an empty string.[br] See the [module:dcc]dcc module[/module] documentation for more information.[br] */ @@ -1774,19 +1774,19 @@ static bool dcc_kvs_fnc_protocol(KviKvsModuleFunctionCall * c) @title: $dcc.connectionType @short: - Returns the connection type of the specified DCC + Returns the connection type of the specified DCC session @syntax: $dcc.connectionType $dcc.connectionType() @description: - Returns the connection type of the specified DCC.[br] + Returns the connection type of the specified DCC session.[br] Returns the string "ACTIVE" for active DCC connections and the string "PASSIVE" for passive DCC connections. If is omitted then the DCC Session associated with the current window is assumed.[br] If is not a valid DCC session identifier (or it is omitted and the current window has no associated DCC session) then - this function prints a warning and returns an empty sting.[br] + this function prints a warning and returns an empty string.[br] See the [module:dcc]dcc module[/module] documentation for more information.[br] */ @@ -1919,17 +1919,17 @@ static bool dcc_kvs_fnc_isFileDownload(KviKvsModuleFunctionCall * c) @title: $dcc.localNick @short: - Returns the local nickname associated with the specified DCC + Returns the local nickname associated with the specified DCC session @syntax: $dcc.localNick $dcc.localNick() @description: - Returns the local nickname associated with the specified DCC.[br] + Returns the local nickname associated with the specified DCC session.[br] If is omitted then the DCC Session associated with the current window is assumed.[br] If is not a valid DCC session identifier (or it is omitted and the current window has no associated DCC session) then - this function prints a warning and returns an empty sting.[br] + this function prints a warning and returns an empty string.[br] See the [module:dcc]dcc module[/module] documentation for more information.[br] */ @@ -1954,17 +1954,17 @@ static bool dcc_kvs_fnc_localNick(KviKvsModuleFunctionCall * c) @title: $dcc.localUser @short: - Returns the local username associated with the specified DCC + Returns the local username associated with the specified DCC session @syntax: $dcc.localUser $dcc.localUser() @description: - Returns the local username associated with the specified DCC.[br] + Returns the local username associated with the specified DCC session.[br] If is omitted then the DCC Session associated with the current window is assumed.[br] If is not a valid DCC session identifier (or it is omitted and the current window has no associated DCC session) then - this function prints a warning and returns an empty sting.[br] + this function prints a warning and returns an empty string.[br] See the [module:dcc]dcc module[/module] documentation for more information.[br] */ @@ -1988,17 +1988,17 @@ static bool dcc_kvs_fnc_localUser(KviKvsModuleFunctionCall * c) @title: $dcc.localHost @short: - Returns the local hostname associated with the specified DCC + Returns the local hostname associated with the specified DCC session @syntax: $dcc.localHost $dcc.localHost() @description: - Returns the local hostname associated with the specified DCC.[br] + Returns the local hostname associated with the specified DCC session.[br] If is omitted then the DCC Session associated with the current window is assumed.[br] If is not a valid DCC session identifier (or it is omitted and the current window has no associated DCC session) then - this function prints a warning and returns an empty sting.[br] + this function prints a warning and returns an empty string.[br] See the [module:dcc]dcc module[/module] documentation for more information.[br] */ @@ -2023,17 +2023,17 @@ static bool dcc_kvs_fnc_localHost(KviKvsModuleFunctionCall * c) @title: $dcc.localIp @short: - Returns the local ip address associated with the specified DCC + Returns the local ip address associated with the specified DCC session @syntax: $dcc.localIp $dcc.localIp() @description: - Returns the local ip address associated with the specified DCC.[br] + Returns the local ip address associated with the specified DCC session.[br] If is omitted then the DCC Session associated with the current window is assumed.[br] If is not a valid DCC session identifier (or it is omitted and the current window has no associated DCC session) then - this function prints a warning and returns an empty sting.[br] + this function prints a warning and returns an empty string.[br] See the [module:dcc]dcc module[/module] documentation for more information.[br] */ @@ -2058,16 +2058,16 @@ static bool dcc_kvs_fnc_localIp(KviKvsModuleFunctionCall * c) @title: $dcc.localPort @short: - Returns the local port associated with the specified DCC + Returns the local port associated with the specified DCC session @syntax: $dcc.localPort $dcc.localPort() @description: - Returns the local port associated with the specified DCC.[br] + Returns the local port associated with the specified DCC session.[br] If is omitted then the DCC Session associated with the current window is assumed.[br] If is not a valid DCC session identifier then - this function prints a warning and returns an empty sting.[br] + this function prints a warning and returns an empty string.[br] See the [module:dcc]dcc module[/module] documentation for more information.[br] */ @@ -2092,11 +2092,11 @@ static bool dcc_kvs_fnc_localPort(KviKvsModuleFunctionCall * c) @title: $dcc.localFileName @short: - Returns the local file name associated with the specified DCC + Returns the local file name associated with the specified DCC session @syntax: $dcc.localFileName() @description: - Returns the local file name associated with the specified DCC.[br] + Returns the local file name associated with the specified DCC session.[br] If does not identify a file transfer DCC then this function returns an empty string. If is not a valid Direct Client Connection identifier @@ -2124,11 +2124,11 @@ static bool dcc_kvs_fnc_localFileName(KviKvsModuleFunctionCall * c) @title: $dcc.localFileSize @short: - Returns the local file size associated with the specified DCC + Returns the local file size associated with the specified DCC session @syntax: $dcc.localFileSize() @description: - Returns the local file size associated with the specified DCC.[br] + Returns the local file size associated with the specified DCC session.[br] If does not identify a file transfer DCC then this function returns '0'[br] If is not a valid Direct Client Connection identifier @@ -2161,17 +2161,17 @@ static bool dcc_kvs_fnc_localFileSize(KviKvsModuleFunctionCall * c) @title: $dcc.remoteNick @short: - Returns the remote nickname associated with the specified DCC + Returns the remote nickname associated with the specified DCC session @syntax: $dcc.remoteNick $dcc.remoteNick() @description: - Returns the remote nickname associated with the specified DCC.[br] + Returns the remote nickname associated with the specified DCC session .[br] If is omitted then the DCC Session associated with the current window is assumed.[br] If is not a valid DCC session identifier (or it is omitted and the current window has no associated DCC session) then - this function prints a warning and returns an empty sting.[br] + this function prints a warning and returns an empty string.[br] See the [module:dcc]dcc module[/module] documentation for more information.[br] */ @@ -2196,17 +2196,17 @@ static bool dcc_kvs_fnc_remoteNick(KviKvsModuleFunctionCall * c) @title: $dcc.remoteUser @short: - Returns the remote username associated with the specified DCC + Returns the remote username associated with the specified DCC session @syntax: $dcc.remoteUser $dcc.remoteUser() @description: - Returns the remote username associated with the specified DCC.[br] + Returns the remote username associated with the specified DCC session.[br] If is omitted then the DCC Session associated with the current window is assumed.[br] If is not a valid DCC session identifier (or it is omitted and the current window has no associated DCC session) then - this function prints a warning and returns an empty sting.[br] + this function prints a warning and returns an empty string.[br] See the [module:dcc]dcc module[/module] documentation for more information.[br] */ @@ -2230,17 +2230,17 @@ static bool dcc_kvs_fnc_remoteUser(KviKvsModuleFunctionCall * c) @title: $dcc.remoteHost @short: - Returns the remote hostname associated with the specified DCC + Returns the remote hostname associated with the specified DCC session @syntax: $dcc.remoteHost $dcc.remoteHost() @description: - Returns the remote hostname associated with the specified DCC.[br] + Returns the remote hostname associated with the specified DCC session.[br] If is omitted then the DCC Session associated with the current window is assumed.[br] If is not a valid DCC session identifier (or it is omitted and the current window has no associated DCC session) then - this function prints a warning and returns an empty sting.[br] + this function prints a warning and returns an empty string.[br] See the [module:dcc]dcc module[/module] documentation for more information.[br] */ @@ -2264,17 +2264,17 @@ static bool dcc_kvs_fnc_remoteHost(KviKvsModuleFunctionCall * c) @title: $dcc.remoteIp @short: - Returns the remote ip address associated with the specified DCC + Returns the remote ip address associated with the specified DCC session @syntax: $dcc.remoteIp $dcc.remoteIp() @description: - Returns the remote ip address associated with the specified DCC.[br] + Returns the remote ip address associated with the specified DCC session.[br] If is omitted then the DCC Session associated with the current window is assumed.[br] If is not a valid DCC session identifier (or it is omitted and the current window has no associated DCC session) then - this function prints a warning and returns an empty sting.[br] + this function prints a warning and returns an empty string.[br] See the [module:dcc]dcc module[/module] documentation for more information.[br] */ @@ -2299,17 +2299,17 @@ static bool dcc_kvs_fnc_remoteIp(KviKvsModuleFunctionCall * c) @title: $dcc.remotePort @short: - Returns the remote port associated with the specified DCC + Returns the remote port associated with the specified DCC session @syntax: $dcc.remotePort $dcc.remotePort() @description: - Returns the remote port associated with the specified DCC.[br] + Returns the remote port associated with the specified DCC session.[br] If is omitted then the DCC Session associated with the current window is assumed.[br] If is not a valid DCC session identifier (or it is omitted and the current window has no associated DCC session) then - this function prints a warning and returns an empty sting.[br] + this function prints a warning and returns an empty string.[br] See the [module:dcc]dcc module[/module] documentation for more information.[br] */ @@ -2334,11 +2334,11 @@ static bool dcc_kvs_fnc_remotePort(KviKvsModuleFunctionCall * c) @title: $dcc.remoteFileName @short: - Returns the remote file name associated with the specified DCC + Returns the remote file name associated with the specified DCC session @syntax: $dcc.remoteFileName() @description: - Returns the remote file name associated with the specified DCC.[br] + Returns the remote file name associated with the specified DCC session.[br] If does not identify a file transfer DCC then this function returns an empty string. If is not a valid Direct Client Connection identifier @@ -2366,11 +2366,11 @@ static bool dcc_kvs_fnc_remoteFileName(KviKvsModuleFunctionCall * c) @title: $dcc.remoteFileSize @short: - Returns the remote file size associated with the specified DCC + Returns the remote file size associated with the specified DCC session @syntax: $dcc.remoteFileSize() @description: - Returns the remote file size associated with the specified DCC.[br] + Returns the remote file size associated with the specified DCC session.[br] If does not identify a file transfer DCC then this function returns '0'[br] If is not a valid Direct Client Connection identifier @@ -2409,7 +2409,7 @@ static bool dcc_kvs_fnc_remoteFileSize(KviKvsModuleFunctionCall * c) $dcc.ircContext() @description: Returns the identifier of the irc context from which - the specified DCC has been originated.[br] + the specified DCC session has been originated.[br] When the DCC is not originated from an IRC context then this function returns '0' : an invalid irc context id. If is omitted then the DCC Session associated @@ -2464,7 +2464,7 @@ static bool dcc_kvs_fnc_ircContext(KviKvsModuleFunctionCall * c) with the current window is assumed.[br] If is not a valid DCC session identifier (or it is omitted and the current window has no associated DCC session) then - this function prints a warning and returns an empty sting.[br] + this function prints a warning and returns an empty string.[br] If the DCC session does not refer to a file transfer then this function returns "".[br] See the [module:dcc]dcc module[/module] documentation for more information.[br] @@ -2509,7 +2509,7 @@ static bool dcc_kvs_fnc_transferStatus(KviKvsModuleFunctionCall * c) with the current window is assumed.[br] If is not a valid DCC session identifier (or it is omitted and the current window has no associated DCC session) then - this function prints a warning and returns an empty sting.[br] + this function prints a warning and returns an empty string.[br] If the DCC session does not refer to a file transfer then this function returns 0.[br] See the [module:dcc]dcc module[/module] documentation for more information.[br] @@ -2555,7 +2555,7 @@ static bool dcc_kvs_fnc_transferredBytes(KviKvsModuleFunctionCall * c) with the current window is assumed.[br] If is not a valid DCC session identifier (or it is omitted and the current window has no associated DCC session) then - this function prints a warning and returns an empty sting.[br] + this function prints a warning and returns an empty string.[br] If the DCC session does not refer to a file transfer then this function returns 0.[br] See the [module:dcc]dcc module[/module] documentation for more information.[br] @@ -2727,7 +2727,7 @@ static bool dcc_kvs_fnc_sessionList(KviKvsModuleFunctionCall * c) to query the information from; if omitted, it defaults to "remote".[br] If is omitted then the DCC Session associated with the current window is assumed.[br] If is not a valid DCC session identifier (or it is omitted and the current window - has no associated DCC session) then this function prints a warning and returns an empty sting.[br] + has no associated DCC session) then this function prints a warning and returns an empty string.[br] If the DCC session is not using ssl then this function returns an empty string.[br] Some queries can accept an optional parameter .[br] Available query strings are:[br] -- cgit v1.3.1-10-gc9f91