From 83a175e07a4f0ccba9bf2490a5a8d540b413d3e1 Mon Sep 17 00:00:00 2001 From: Elvio Basello Date: Wed, 30 Jul 2008 16:11:57 +0000 Subject: fixed doc git-svn-id: https://svn.kvirc.de/svn/trunk/kvirc@2138 17fca916-40b9-46aa-a4ea-0a15b648b75c --- src/modules/serverdb/libkviserverdb.cpp | 126 ++++++++++++++++---------------- 1 file changed, 63 insertions(+), 63 deletions(-) (limited to 'src/modules/serverdb/libkviserverdb.cpp') diff --git a/src/modules/serverdb/libkviserverdb.cpp b/src/modules/serverdb/libkviserverdb.cpp index 425729d88..81d31c9ef 100644 --- a/src/modules/serverdb/libkviserverdb.cpp +++ b/src/modules/serverdb/libkviserverdb.cpp @@ -222,15 +222,15 @@ static bool serverdb_kvs_fnc_serverExists(KviKvsModuleFunctionCall * c) } /* - @doc: serverdb.getNetworkNickName + @doc: serverdb.networkNickName @type: function @title: - $serverdb.getNetworkNickName + $serverdb.networkNickName @short: Returns the nickname @synthax: - $serverdb.getNetworkNickName() + $serverdb.networkNickName() @description: Returns the nickname set for the network if set @seealso: @@ -239,15 +239,15 @@ static bool serverdb_kvs_fnc_serverExists(KviKvsModuleFunctionCall * c) SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkNickName,nickName) /* - @doc: serverdb.getNetworkUserName + @doc: serverdb.networkUserName @type: function @title: - $serverdb.getNetworkUserName + $serverdb.networkUserName @short: Returns the username @synthax: - $serverdb.getNetworkUserName() + $serverdb.networkUserName() @description: Returns the username set for the network if set @seealso: @@ -256,15 +256,15 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkNickName,nickName) SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkUserName,userName) /* - @doc: serverdb.getNetworkRealName + @doc: serverdb.networkRealName @type: function @title: - $serverdb.getNetworkRealName + $serverdb.networkRealName @short: Returns the realname @synthax: - $serverdb.getNetworkRealName() + $serverdb.networkRealName() @description: Returns the realname set for the network if set @seealso: @@ -273,15 +273,15 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkUserName,userName) SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkRealName,realName) /* - @doc: serverdb.getNetworkEncoding + @doc: serverdb.networkEncoding @type: function @title: - $serverdb.getNetworkEncoding + $serverdb.networkEncoding @short: Returns the encoding @synthax: - $serverdb.getNetworkEncoding() + $serverdb.networkEncoding() @description: Returns the encoding used for the network for server specific messages, like channel and nick names, if set @seealso: @@ -290,15 +290,15 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkRealName,realName) SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkEncoding,encoding) /* - @doc: serverdb.getNetworkTextEncoding + @doc: serverdb.networkTextEncoding @type: function @title: - $serverdb.getNetworkTextEncoding + $serverdb.networkTextEncoding @short: Returns the encoding @synthax: - $serverdb.getNetworkTextEncoding() + $serverdb.networkTextEncoding() @description: Returns the encoding used for the network for text messages, if set @seealso: @@ -307,15 +307,15 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkEncoding,encoding) SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkTextEncoding,textEncoding) /* - @doc: serverdb.getNetworkDescription + @doc: serverdb.networkDescription @type: function @title: - $serverdb.getNetworkDescription + $serverdb.networkDescription @short: Returns the description @synthax: - $serverdb.getNetworkDescription() + $serverdb.networkDescription() @description: Returns the description set for the network if set @seealso: @@ -324,15 +324,15 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkTextEncoding,textEncoding) SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkDescription,description) /* - @doc: serverdb.getNetworkConnectCommand + @doc: serverdb.networkConnectCommand @type: function @title: - $serverdb.getNetworkConnectCommand + $serverdb.networkConnectCommand @short: Returns the connect command @synthax: - $serverdb.getNetworkConnectCommand() + $serverdb.networkConnectCommand() @description: Returns the connect command set for the network if set @seealso: @@ -341,15 +341,15 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkDescription,description) SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkConnectCommand,onConnectCommand) /* - @doc: serverdb.getNetworkLoginCommand + @doc: serverdb.networkLoginCommand @type: function @title: - $serverdb.getNetworkLoginCommand + $serverdb.networkLoginCommand @short: Returns the login command @synthax: - $serverdb.getNetworkLoginCommand() + $serverdb.networkLoginCommand() @description: Returns the login command set for the network if set @seealso: @@ -358,15 +358,15 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkConnectCommand,onConnectCo SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkLoginCommand,onLoginCommand) /* - @doc: serverdb.getNetworkName + @doc: serverdb.networkName @type: function @title - $serverdb.getNetworkName + $serverdb.networkName @short: Returns the name @synthax: - $serverdb.getNetworkName() + $serverdb.networkName() @description: Returns the name of the network @seealso: @@ -375,15 +375,15 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkLoginCommand,onLoginComman SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkName,name) /* - @doc: serverdb.getServerNickName + @doc: serverdb.serverNickName @type: function @title: - $serverdb.getServerNickName + $serverdb.serverNickName @short: Returns the nickname @synthax: - $serverdb.getServerNickName(,) + $serverdb.serverNickName(,) @description: Returns the nickname set for the server of the network if set @seealso: @@ -392,15 +392,15 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkName,name) SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverNickName,nickName,setString) /* - @doc: serverdb.getServerUserName + @doc: serverdb.serverUserName @type: function @title: - $serverdb.getServerUserName + $serverdb.serverUserName @short: Returns the username @synthax: - $serverdb.getServerUserName(,) + $serverdb.serverUserName(,) @description: Returns the username set for the server of the network if set @seealso: @@ -409,15 +409,15 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverNickName,nickName,setString) SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverUserName,userName,setString) /* - @doc: serverdb.getServerRealName + @doc: serverdb.serverRealName @type: function @title: - $serverdb.getServerRealName + $serverdb.serverRealName @short: Returns the realname @synthax: - $serverdb.getServerRealName(,) + $serverdb.serverRealName(,) @description: Returns the realname set for the server of the network if set @seealso: @@ -426,15 +426,15 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverUserName,userName,setString) SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverRealName,realName,setString) /* - @doc: serverdb.getServerEncoding + @doc: serverdb.serverEncoding @type: function @title: - $serverdb.getServerEncoding + $serverdb.serverEncoding @short: Returns the encoding @synthax: - $serverdb.getServerEncoding(,) + $serverdb.serverEncoding(,) @description: Returns the encoding used for the server of the network for server specific messages, like channel and nick names, if set @seealso: @@ -443,15 +443,15 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverRealName,realName,setString) SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverEncoding,encoding,setString) /* - @doc: serverdb.getServerTextEncoding + @doc: serverdb.serverTextEncoding @type: function @title: - $serverdb.getServerTextEncoding + $serverdb.serverTextEncoding @short: Returns the encoding @synthax: - $serverdb.getServerTextEncoding(,) + $serverdb.serverTextEncoding(,) @description: Returns the encoding used for the server of the network for server specific messages, like channel and nick names, if set @seealso: @@ -460,15 +460,15 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverEncoding,encoding,setString) SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverTextEncoding,textEncoding,setString) /* - @doc: serverdb.getServerDescription + @doc: serverdb.serverDescription @type: function @title: - $serverdb.getServerDescription + $serverdb.serverDescription @short: Returns the description @synthax: - $serverdb.getServerDescription(,) + $serverdb.serverDescription(,) @description: Returns the description set for the server of the network if set @seealso: @@ -477,15 +477,15 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverTextEncoding,textEncoding,se SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverDescription,description,setString) /* - @doc: serverdb.getServerConnectCommand + @doc: serverdb.serverConnectCommand @type: function @title: - $serverdb.getServerConnectCommand + $serverdb.serverConnectCommand @short: Returns the connect command @synthax: - $serverdb.getServerConnectCommand(,) + $serverdb.serverConnectCommand(,) @description: Returns the connect command set for the server of the network if set @seealso: @@ -494,15 +494,15 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverDescription,description,setS SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverConnectCommand,onConnectCommand,setString) /* - @doc: serverdb.getServerLoginCommand + @doc: serverdb.serverLoginCommand @type: function @title: - $serverdb.getServerLoginCommand + $serverdb.serverLoginCommand @short: Returns the login command @synthax: - $serverdb.getServerLoginCommand(,) + $serverdb.serverLoginCommand(,) @description: Returns the login command set for the server of the network if set @seealso: @@ -511,15 +511,15 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverConnectCommand,onConnectComm SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverLoginCommand,onLoginCommand,setString) /* - @doc: serverdb.getServerIp + @doc: serverdb.serverIp @type: function @title: - $serverdb.getServerIp + $serverdb.serverIp @short: Returns the IP address @synthax: - $serverdb.getServerIp(,) + $serverdb.serverIp(,) @description: Returns the IP address of the server of the network @seealso: @@ -528,15 +528,15 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverLoginCommand,onLoginCommand, SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverIp,ip,setString) /* - @doc: serverdb.getServerId + @doc: serverdb.serverId @type: function @title: - $serverdb.getServerId + $serverdb.serverId @short: Returns the ID @synthax: - $serverdb.getServerId(,) + $serverdb.serverId(,) @description: Returns the ID of the server of the network @seealso: @@ -545,15 +545,15 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverIp,ip,setString) SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverId,id,setString) /* - @doc: serverdb.getServerPassword + @doc: serverdb.serverPassword @type: function @title: - $serverdb.getServerPassword + $serverdb.serverPassword @short: Returns the password @synthax: - $serverdb.getServerPassword(,) + $serverdb.serverPassword(,) @description: Returns the password of the server of the network if set @seealso: @@ -562,15 +562,15 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverId,id,setString) SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverPassword,password,setString) /* - @doc: serverdb.getServerPort + @doc: serverdb.serverPort @type: function @title: - $serverdb.getServerPort + $serverdb.serverPort @short: Returns the port @synthax: - $serverdb.getServerPort(,) + $serverdb.serverPort(,) @description: Returns the port of the server of the network if set @seealso: -- cgit v1.3.1-10-gc9f91