a lot of typo and documentarion fixes by OmegaPhil

git-svn-id: https://svn.kvirc.de/svn/trunk/kvirc@5175 17fca916-40b9-46aa-a4ea-0a15b648b75c

5 files changed, 65 insertions, 56 deletions

diff --git a/src/modules/addon/libkviaddon.cpp b/src/modules/addon/libkviaddon.cpp
index e3a50677d..394105733 100644
--- a/src/modules/addon/libkviaddon.cpp
+++ b/src/modules/addon/libkviaddon.cpp
@@ -603,8 +603,8 @@ static bool addon_kvs_cmd_register(KviKvsModuleCallbackCommandCall * c)
 	@switches:
 		!sw: -q | --quiet
 			Makes the command run quietly
-		!sw: -s | --skip-inexisting
-			Skip inexisting entries in the [files] list
+		!sw: -s | --skip-inexistant
+			Skip inexistant entries in the [files] list
 	@description:
 		Installs the [files] for the addon identified by the specified <id>.
 		The files will be automatically removed when the addon is uninstalled.
@@ -638,7 +638,8 @@ static bool addon_kvs_cmd_installfiles(KviKvsModuleCommandCall * c)
 	KVSM_PARAMETERS_END(c)
 
 	bool bQuiet = c->switches()->find('q',"quiet");
-	bool bSkipInexisting = c->switches()->find('i',"skip-inexisting");
+	// we had a typo here, support the old switch name for backward scripts compatibility
+	bool bSkipInexistant = c->switches()->find('i',"skip-inexistant") || c->switches()->find('i',"skip-inexisting");
 
 	KviKvsScriptAddon * a = KviKvsScriptAddonManager::instance()->findAddon(szName);
 	if(!a)
@@ -685,10 +686,10 @@ static bool addon_kvs_cmd_installfiles(KviKvsModuleCommandCall * c)
 			QDir dir(szPath);
 			if(!dir.exists())
 			{
-				if(!bSkipInexisting)
+				if(!bSkipInexistant)
 					return c->error(__tr2qs_ctx("The directory '%1' doesn't exist","addon").arg(szPath));
 				if(!bQuiet)
-					c->warning(__tr2qs_ctx("Skipping inexisting entry '%1'","addon").arg(szEntry));
+					c->warning(__tr2qs_ctx("Skipping inexistant entry '%1'","addon").arg(szEntry));
 				continue;
 			}
 
@@ -708,16 +709,16 @@ static bool addon_kvs_cmd_installfiles(KviKvsModuleCommandCall * c)
 		QFileInfo inf(szEntry);
 		if(!inf.exists())
 		{
-			if(!bSkipInexisting)
+			if(!bSkipInexistant)
 				return c->error(__tr2qs_ctx("The file '%1' doesn't exist","addon").arg(szEntry));
 			if(!bQuiet)
-				c->warning(__tr2qs_ctx("Skipping inexisting entry '%1'","addon").arg(szEntry));
+				c->warning(__tr2qs_ctx("Skipping inexistant entry '%1'","addon").arg(szEntry));
 			continue;
 		}
 
 		if(!inf.isFile())
 		{
-			if(!bSkipInexisting)
+			if(!bSkipInexistant)
 				return c->error(__tr2qs_ctx("The entry '%1' is not a file","addon").arg(szEntry));
 			if(!bQuiet)
 				c->warning(__tr2qs_ctx("Skipping invalid entry '%1'","addon").arg(szEntry));
diff --git a/src/modules/dialog/libkvidialog.cpp b/src/modules/dialog/libkvidialog.cpp
index 8c59cdbbf..25d328ef8 100644
--- a/src/modules/dialog/libkvidialog.cpp
+++ b/src/modules/dialog/libkvidialog.cpp
@@ -80,7 +80,7 @@ KviKvsCallbackMessageBox::KviKvsCallbackMessageBox(
 		setEscapeButton(QMessageBox::No);
 	else
 		setEscapeButton(QMessageBox::Cancel);
-	
+
 	g_pDialogModuleDialogList->append(this);
 
 	QPixmap * pix = g_pIconManager->getImage(szIcon);
@@ -115,7 +115,7 @@ void KviKvsCallbackMessageBox::done(int code)
 			// user closed the dialog, fake an "escape button" press
 			if(standardButtons() & QMessageBox::Cancel)
 				iVal = 2;
-			else 
+			else
 				iVal = 1;
 			break;
 	}
@@ -152,9 +152,13 @@ void KviKvsCallbackMessageBox::done(int code)
 		<button0> is the text of the first button (on the left).[br]
 		<button1> is the text of the second button (if empty or specified, only one button will appear in the dialog).[br]
 		<button2> is the text of the third button (if empty or specified, only two buttons will appear in the dialog).[br]
-		The first button is always the default button - it is activated when the user presses the
+		The first button is the default button - it is activated when the user presses the
 		enter key. The third (or the second if only two buttons are present) is treated as the escape button
 		and is activated when the user presses the Esc key or closes the dialog with the window manager close button.[br]
+		If one of the button text strings starts with a "default=" prefix then that button is assumed
+		to be the default button of the dialog.[br]
+		If one of the button text strings starts with a "escape=" prefix then that button is assumed
+		to be the escape button of the dialog.[br]
 		<magic1>,<magic2>... are the magic parameters - evaluated at dialog.message call time and passed
 		to the <callback_command> as positional parameters.[br]
 		If the -b or -modal switch is specified the dialog will have non-blocking modal behaviour -
@@ -327,7 +331,7 @@ KviKvsCallbackTextInput::KviKvsCallbackTextInput(
 			m_iEscapeButton = 2;
 		else if(!szButton1.isEmpty())
 			m_iEscapeButton = 1;
-		else 
+		else
 			m_iEscapeButton = 0;
 	}
 }
@@ -421,7 +425,7 @@ void KviKvsCallbackTextInput::showEvent(QShowEvent *e)
 		!sw: -d=<default_text> | --default=<default_text>
 		Set the initial text input value to <default_text>
 		!sw: -i=<icon> | --icon=<icon>
-		Display the specified icon, just of the left of the informational text
+		Display the specified icon, to the left of the informational text
 		!sw: -m | --multiline
 		Input multiline text instead of single line
 	@description:
@@ -432,12 +436,18 @@ void KviKvsCallbackTextInput::showEvent(QShowEvent *e)
 		<button0> is the text of the first button (on the left).[br]
 		<button1> is the text of the second button (if empty or not given at all, only one button will appear in the dialog).[br]
 		<button2> is the text of the third button (if empty or not given, only two buttons will appear in the dialog).[br]
-		If one of the text strings starts with a "default=" prefix then the button is assumed
-		to be the default button of the dialog and will be also activated when the user presses enter.
+		The first button is the default button - it is activated when the user presses the
+		enter key. The third (or the second if only two buttons are present) is treated as the escape button
+		and is activated when the user presses the Esc key or closes the dialog with the window manager close button.[br]
+		If one of the button text strings starts with a "default=" prefix then that button is assumed
+		to be the default button of the dialog.[br]
+		If one of the button text strings starts with a "escape=" prefix then that button is assumed
+		to be the escape button of the dialog.[br]
 		If the -m switch is used, the dialog will be a multi-line text input, otherwise the user will be able to
 		input only a single line of text.[br]
 		If the -d switch is used, the initial text input value is set to <default text>.[br]
-		If the -i switch is used, the dialog displays also the icon <icon>, just on the left ot the <info_text>[br]
+		If the -i switch is used, the dialog displays also the icon <icon> to the left of <info_text>.
+		<icon> is an image identifier (a relative or absolute path to an image file, or a signed number that maps to an internal KVIrc image). [br]
 		If the -b or -modal switch is specified the dialog will have non-blocking modal behaviour:
 		it will appear above its parent widget and block its input until it's closed.[br]
 		In that case <icon> is an [doc:image_id]image identifier[/doc] (can be a relative or absolute
@@ -447,8 +457,6 @@ void KviKvsCallbackTextInput::showEvent(QShowEvent *e)
 		Once the dialog has been shown, the user will click one of the buttons. At this point the dialog
 		is hidden and the <callback_command> is executed passing the text input value in $1, the number of the button clicked
 		as $0, and the magic parameters as positional parameters $2, $3, $4....[br]
-		Please note that if the user closes the window with the window manager close button,
-		the action is interpreted as a button2 click (that is usually sth as "Cancel").[br]
 	@examples:
 		[example]
 		[comment]# We need a single line "reason"[/comment]
diff --git a/src/modules/objects/class_checkbox.cpp b/src/modules/objects/class_checkbox.cpp
index d808cc968..7c9266ddb 100644
--- a/src/modules/objects/class_checkbox.cpp
+++ b/src/modules/objects/class_checkbox.cpp
@@ -52,9 +52,9 @@
 		See also [classfnc]$setChecked[/classfnc]().
 		!fn: $setChecked([<bChecked:bool>])
 		Sets the check box 'checked state' to <bool>.
-		!fn: $setText([<text:string>])
-		Sets the check box 'checked state' to <bool>.[br]
 		See also [classfnc]$isChecked[/classfnc]().
+		!fn: $setText([<text:string>])
+		Sets the label text associated with the checkbox to <text>.[br]
 		!fn: $toggleEvent(<bToggled:bool>)
 		Called by KVIrc when the checkbox state is toggled.
 		The default implementation emits the toggled(<bool>) signal.
diff --git a/src/modules/objects/libkviobjects.cpp b/src/modules/objects/libkviobjects.cpp
index 987b5e600..178a495af 100644
--- a/src/modules/objects/libkviobjects.cpp
+++ b/src/modules/objects/libkviobjects.cpp
@@ -262,17 +262,17 @@ static bool objects_kvs_cmd_connect(KviKvsModuleCommandCall * c)
 	obSrc=KviKvsKernel::instance()->objectController()->lookupObject(hSrc);
 	if(!obTrg)
 	{
-		c->warning(__tr2qs_ctx("Inexisting target object for objects.connect","objects"));
+		c->warning(__tr2qs_ctx("Inexistant target object for objects.connect","objects"));
 		return true;
 	}
 	if(!obSrc)
 	{
-		c->warning(__tr2qs_ctx("Inexisting source object for objects.connect","objects"));
+		c->warning(__tr2qs_ctx("Inexistant source object for objects.connect","objects"));
 		return true;
 	}
 	if(!obSrc->connectSignal(szSignal,obTrg,szSlot))
 	{
-		c->warning(__tr2qs_ctx("Inexisting target slot '%Q' for objects.connect","objects"),&szSlot);
+		c->warning(__tr2qs_ctx("Inexistant target slot '%Q' for objects.connect","objects"),&szSlot);
 		return true;
 	}
 	return true;
@@ -558,7 +558,7 @@ static bool objects_kvs_fnc_name(KviKvsModuleFunctionCall * c)
 	obSrcClass = KviKvsKernel::instance()->objectController()->lookupObject(hClass);
 	if(!obSrcClass)
 	{
-		c->warning(__tr2qs_ctx("Inexisting class object for objects.name","objects"));
+		c->warning(__tr2qs_ctx("Inexistant class object for objects.name","objects"));
 		return true;
 	}
 
@@ -601,12 +601,12 @@ static bool objects_kvs_cmd_disconnect(KviKvsModuleCommandCall * c)
 	obSrc=KviKvsKernel::instance()->objectController()->lookupObject(hSrc);
 	if(!obTrg)
 	{
-		c->warning(__tr2qs_ctx("Inexisting target object for objects.disconnect","objects"));
+		c->warning(__tr2qs_ctx("Inexistant target object for objects.disconnect","objects"));
 		return true;
 	}
 	if(!obSrc)
 	{
-		c->warning(__tr2qs_ctx("Inexisting source object for objects.disconnect","objects"));
+		c->warning(__tr2qs_ctx("Inexistant source object for objects.disconnect","objects"));
 		return true;
 	}
 	obSrc->disconnectSignal(szSignal,obTrg,szSlot);
diff --git a/src/modules/serverdb/libkviserverdb.cpp b/src/modules/serverdb/libkviserverdb.cpp
index 0093386b6..9a91c06d9 100644
--- a/src/modules/serverdb/libkviserverdb.cpp
+++ b/src/modules/serverdb/libkviserverdb.cpp
@@ -104,7 +104,7 @@ extern KVIRC_API KviServerDataBase * g_pServerDataBase;
 		$serverdb.networkExists
 	@short:
 		Checks if the network already exists in the DB
-	@synthax:
+	@syntax:
 		<bool> $serverdb.networkExists
 	@description:
 		Checks if the network already exists in the DB.[br]
@@ -145,7 +145,7 @@ static bool serverdb_kvs_fnc_networkExists(KviKvsModuleFunctionCall * c)
 		$serverdb.serverExists
 	@short:
 		Checks if the network already exists in the DB
-	@synthax:
+	@syntax:
 		<bool> $serverdb.serverExists(<string:servername>[,<string:networkname>])
 	@description:
 		Checks if the server already exists for a network in the DB.[br]
@@ -288,7 +288,7 @@ static bool serverdb_kvs_fnc_serverExists(KviKvsModuleFunctionCall * c)
 		$serverdb.networkNickName
 	@short:
 		Returns the nickname
-	@synthax:
+	@syntax:
 		<string> $serverdb.networkNickName(<string:network>)
 	@description:
 		Returns the nickname set for the network <network> if set
@@ -305,7 +305,7 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkNickName,nickName)
 		$serverdb.networkUserName
 	@short:
 		Returns the username
-	@synthax:
+	@syntax:
 		<string> $serverdb.networkUserName(<string:network>)
 	@description:
 		Returns the username set for the network <network> if set
@@ -322,7 +322,7 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkUserName,userName)
 		$serverdb.networkRealName
 	@short:
 		Returns the realname
-	@synthax:
+	@syntax:
 		<string> $serverdb.networkRealName(<string:network>)
 	@description:
 		Returns the realname set for the network <network> if set
@@ -339,7 +339,7 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkRealName,realName)
 		$serverdb.networkEncoding
 	@short:
 		Returns the encoding
-	@synthax:
+	@syntax:
 		<string> $serverdb.networkEncoding(<string:network>)
 	@description:
 		Returns the encoding used for the network <network> for server specific messages, like channel and nick names, if set
@@ -356,7 +356,7 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkEncoding,encoding)
 		$serverdb.networkTextEncoding
 	@short:
 		Returns the encoding
-	@synthax:
+	@syntax:
 		<string> $serverdb.networkTextEncoding(<string:network>)
 	@description:
 		Returns the encoding used for the network <network> for text messages, if set
@@ -373,7 +373,7 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkTextEncoding,textEncoding)
 		$serverdb.networkDescription
 	@short:
 		Returns the description
-	@synthax:
+	@syntax:
 		<string> $serverdb.networkDescription(<string:network>)
 	@description:
 		Returns the description set for the network <network> if set
@@ -390,7 +390,7 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkDescription,description)
 		$serverdb.networkConnectCommand
 	@short:
 		Returns the connect command
-	@synthax:
+	@syntax:
 		<string> $serverdb.networkConnectCommand(<string:network>)
 	@description:
 		Returns the connect command set for the network <network> if set
@@ -407,7 +407,7 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkConnectCommand,onConnectCo
 		$serverdb.networkLoginCommand
 	@short:
 		Returns the login command
-	@synthax:
+	@syntax:
 		<string> $serverdb.networkLoginCommand(<string:network>)
 	@description:
 		Returns the login command set for the network <network> if set
@@ -424,7 +424,7 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkLoginCommand,onLoginComman
 		$serverdb.networkName
 	@short:
 		Returns the name
-	@synthax:
+	@syntax:
 		<string> $serverdb.networkName(<string:network>)
 	@description:
 		Returns the name of the network <network>
@@ -441,11 +441,11 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkName,name)
 		$serverdb.networkJoinChannels
 	@short:
 		Returns the list of autojoin channels
-	@synthax:
+	@syntax:
 		<string> $serverdb.networkJoinChannels(<string:network>)
 	@description:
 		Returns a comma-separated list of autojoin channels and their relative passwords set for the network <network>[br]
-		Each item in the array is in the format <string:channel>:<string:password>
+		Each item in the list is in the format <string:channel>:<string:password>
 	@seealso:
 		[module:serverdb]ServerDB module documentation[/module]
 */
@@ -459,7 +459,7 @@ SERVERDB_GET_NETWORK_PROPERTY(serverdb_kvs_fnc_networkJoinChannels,autoJoinChann
 		$serverdb.serverNickName
 	@short:
 		Returns the nickname
-	@synthax:
+	@syntax:
 		<string> $serverdb.serverNickName(<string:network>,<string:server>)
 	@description:
 		Returns the nickname set for the server <server> of the network <network> if set
@@ -476,7 +476,7 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverNickName,nickName,setString)
 		$serverdb.serverUserName
 	@short:
 		Returns the username
-	@synthax:
+	@syntax:
 		<string> $serverdb.serverUserName(<string:network>,<string:server>)
 	@description:
 		Returns the username set for the server <server> of the network <network> if set
@@ -493,7 +493,7 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverUserName,userName,setString)
 		$serverdb.serverRealName
 	@short:
 		Returns the realname
-	@synthax:
+	@syntax:
 		<string> $serverdb.serverRealName(<string:network>,<string:server>)
 	@description:
 		Returns the realname set for the server <server> of the network <network> if set
@@ -510,7 +510,7 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverRealName,realName,setString)
 		$serverdb.serverEncoding
 	@short:
 		Returns the encoding
-	@synthax:
+	@syntax:
 		<string> $serverdb.serverEncoding(<string:network>,<string:server>)
 	@description:
 		Returns the encoding used for the server <server> of the network <network> for server specific messages, like channel and nick names, if set
@@ -527,7 +527,7 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverEncoding,encoding,setString)
 		$serverdb.serverTextEncoding
 	@short:
 		Returns the encoding
-	@synthax:
+	@syntax:
 		<string> $serverdb.serverTextEncoding(<string:network>,<string:server>)
 	@description:
 		Returns the encoding used for the server <server> of the network <network> for server specific messages, like channel and nick names, if set
@@ -544,7 +544,7 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverTextEncoding,textEncoding,se
 		$serverdb.serverDescription
 	@short:
 		Returns the description
-	@synthax:
+	@syntax:
 		<string> $serverdb.serverDescription(<string:network>,<string:server>)
 	@description:
 		Returns the description set for the server <server> of the network <network> if set
@@ -561,7 +561,7 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverDescription,description,setS
 		$serverdb.serverConnectCommand
 	@short:
 		Returns the connect command
-	@synthax:
+	@syntax:
 		<string> $serverdb.serverConnectCommand(<string:network>,<string:server>)
 	@description:
 		Returns the connect command set for the server <server> of the network <network> if set
@@ -578,7 +578,7 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverConnectCommand,onConnectComm
 		$serverdb.serverLoginCommand
 	@short:
 		Returns the login command
-	@synthax:
+	@syntax:
 		<string> $serverdb.serverLoginCommand(<string:network>,<string:server>)
 	@description:
 		Returns the login command set for the server <server> of the network <network> if set
@@ -595,7 +595,7 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverLoginCommand,onLoginCommand,
 		$serverdb.serverIp
 	@short:
 		Returns the IP address
-	@synthax:
+	@syntax:
 		<string> $serverdb.serverIp(<string:network>,<string:server>)
 	@description:
 		Returns the IP address of the server <server> of the network <network>
@@ -612,7 +612,7 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverIp,ip,setString)
 		$serverdb.serverId
 	@short:
 		Returns the ID
-	@synthax:
+	@syntax:
 		<string> $serverdb.serverId(<string:network>,<string:server>)
 	@description:
 		Returns the ID of the server <server> of the network <network>
@@ -629,7 +629,7 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverId,id,setString)
 		$serverdb.serverPassword
 	@short:
 		Returns the password
-	@synthax:
+	@syntax:
 		<string> $serverdb.serverPassword(<string:network>,<string:server>)
 	@description:
 		Returns the password of the server <server> of the network <network> if set
@@ -646,7 +646,7 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverPassword,password,setString)
 		$serverdb.serverPort
 	@short:
 		Returns the port
-	@synthax:
+	@syntax:
 		<int> $serverdb.serverPort(<string:network>,<string:server>)
 	@description:
 		Returns the port of the server <server> of the network <network> if set
@@ -663,7 +663,7 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverPort,port,setInteger)
 		$serverdb.isAutoConnect
 	@short:
 		Returns the autoconnect status
-	@synthax:
+	@syntax:
 		<bool> $serverdb.isAutoConnect(<string:network>,<string:server>)
 	@description:
 		Returns true if the server <server> of the network <network> if set to autoconnect, false otherwise
@@ -680,7 +680,7 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverAutoConnect,autoConnect,setB
 		$serverdb.isIPv6
 	@short:
 		Returns the IPv6 status
-	@synthax:
+	@syntax:
 		<bool> $serverdb.isIPv6(<string:network>,<string:server>)
 	@description:
 		Returns true if the server <server> of the network <network> if set to connect using IPv6 sockets, false otherwise
@@ -697,7 +697,7 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverIPv6,isIPv6,setBoolean)
 		$serverdb.isSSL
 	@short:
 		Returns the SSL status
-	@synthax:
+	@syntax:
 		<bool> $serverdb.isSSL(<string:network>,<string:server>)
 	@description:
 		Returns true if the server <server> of the network <network> if set to connect using SSL (Secure Socket Layer) sockets, false otherwise
@@ -714,7 +714,7 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverSSL,useSSL,setBoolean)
 		$serverdb.cacheIp
 	@short:
 		Returns the cache-ip status
-	@synthax:
+	@syntax:
 		<bool> $serverdb.cacheIp(<string:network>,<string:server>)
 	@description:
 		Returns true if KVIrc is set to cache the ip of the server <server> of the network <network>, false otherwise
@@ -731,7 +731,7 @@ SERVERDB_GET_SERVER_PROPERTY(serverdb_kvs_fnc_serverCacheIp,cacheIp,setBoolean)
 		$serverdb.serverJoinChannels
 	@short:
 		Returns the list of autojoin channels
-	@synthax:
+	@syntax:
 		<string> $serverdb.serverJoinChannels(<string:network>,<string:server>)
 	@description:
 		Returns a comma-separated list of autojoin channels and their relative passwords set for the server <server> of the network <network>[br]