some fixes on documentation

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

11 files changed, 54 insertions, 57 deletions

diff --git a/src/kvirc/kvs/KviKvsCoreFunctions_af.cpp b/src/kvirc/kvs/KviKvsCoreFunctions_af.cpp
index bcbed4dbb..8c132a8c1 100644
--- a/src/kvirc/kvs/KviKvsCoreFunctions_af.cpp
+++ b/src/kvirc/kvs/KviKvsCoreFunctions_af.cpp
@@ -68,7 +68,7 @@ namespace KviKvsCoreFunctions
 		@description:
 			Returns the [b]window ID[/b] of the active window
 			bound to the IRC context specified by <irc context id>.
-			If no window matches the specified IRC context, and invalid
+			If no window matches the specified IRC context, an invalid
 			window ID is returned (0).[br]
 			If no <irc context id> is specified, then
 			the application active window is returned (the window
@@ -477,7 +477,7 @@ namespace KviKvsCoreFunctions
 			<string> $certificate(<query:string>[,<param1:string>])
 		@description:
 			Returns the requested information about local certificate.[br]
-			Some queries can accept an optional parameter <param1>[br]
+			Some queries can accept an optional parameter <param1>.[br]
 			Available query strings are:[br]
 			[ul]
 			[li]signatureType[/li]
@@ -815,9 +815,9 @@ namespace KviKvsCoreFunctions
 		@syntax:
 			<int> $countStatusBarItems
 		@description:
-			Returns the number of items in the statusbar
+			Returns the number of items in the statusbar.
 		@seealso:
-			[class]widget class[/class]
+			[class]widget[/class]
 	*/
 
 	KVSCF(countStatusBarItems)
@@ -1207,7 +1207,7 @@ namespace KviKvsCoreFunctions
 			have a variable that can assume boolean values it's
 			nicer to use [fnc]$true[/fnc] and $false instead of
 			the integer constants 1 and 0. The reader will
-			undestand immediately that the variable simply can't
+			understand immediately that the variable simply can't
 			assume any other value.
 		@examples:
 			[example]
@@ -1414,16 +1414,13 @@ namespace KviKvsCoreFunctions
 			Returns an array of items built from the passed arguments
 			with the following rules:[br]
 			[ul]
-				[li]If an argument is a scalar value then the argument itself
-					is appended to the result.[/li]
-				[li]If an argument is an array then each contained item
-					is appended to the result.[/li]
-				[li]If an argument is a hash then each contained value
-					is appended to the result.[/li]
+				[li]If an argument is a scalar value then the argument itself is appended to the result.[/li]
+				[li]If an argument is an array then each contained item is appended to the result.[/li]
+				[li]If an argument is a hash then each contained value is appended to the result.[/li]
 			[/ul]
 			A simple example of usage is to merge N arrays into a new one.
 			(Please note that for merging one array into another the
-			[doc:arrayconcatenation]<+ operator[/doc] is more efficient).
+			[doc:arrayconcatenation]array concatenation operator[/doc] is more efficient).
 	*/
 
 	KVSCF(flatten)
@@ -1491,7 +1488,7 @@ namespace KviKvsCoreFunctions
 			Returns a link formatted for the [cmd]echo[/cmd] command.[br]
 			If you pass the returned string to the echo command, the string will be displayed
 			as a link and will be highlighted when the user moves the mouse over it.[br]
-			If the user will leave the mouse for a few seconds over the link, the <tooltip_text>
+			If the user leaves the mouse for a few seconds over the link, the <tooltip_text>
 			will be displayed in a small tooltip window. If <tooltip_text> is not given,
 			then no tooltip will be shown.[br]
 			The <double_click_command> will be executed when the user will double click on the link.[br]
diff --git a/src/kvirc/kvs/KviKvsCoreFunctions_gl.cpp b/src/kvirc/kvs/KviKvsCoreFunctions_gl.cpp
index ca08dd5fc..dc15d202b 100644
--- a/src/kvirc/kvs/KviKvsCoreFunctions_gl.cpp
+++ b/src/kvirc/kvs/KviKvsCoreFunctions_gl.cpp
@@ -297,7 +297,7 @@ KVSCF(gender)
 	@short:
 		Returns the lag on the current server
 	@syntax:
-		<integer> lag
+		<integer> $lag
 	@description:
 		This function returns the lag in the current server, in milliseconds.[br]
 	*/
@@ -606,7 +606,7 @@ KVSCF(gender)
 		@syntax:
 			<boolean> $isMainWindowMinimized()
 		@description:
-			Returns true if main KVirc window is minimized and false otherwise.
+			Returns true if main KVIrc window is minimized and false otherwise.
 	*/
 
 	KVSCF(isMainWindowMinimized)
@@ -663,7 +663,7 @@ KVSCF(gender)
 		@syntax:
 			<boolean> $isEventEnabled(<event_name:string>,<handler_name:string>)
 		@description:
-			Returns 1 if the event handler enabled
+			Returns 1 if the event handler is enabled.
 	*/
 
 	///////////////////////////////////////////////////////////////////////////////////////////////
@@ -783,7 +783,7 @@ KVSCF(gender)
 		@syntax:
 			<boolean> $istimer(<name:string>)
 		@description:
-			Returns 1 if the timer named <name> is actually running, else 0
+			Returns 1 if the timer named <name> is actually running, 0 otherwise.
 		@seealso:
 			[cmd]timer[/cmd], [cmd]killtimer[/cmd]
 	*/
@@ -943,11 +943,11 @@ KVSCF(gender)
 		@syntax:
 			<string> $lang([<type:string>])
 		@description:
-			Returns the short name of currently used language
+			Returns the short name of currently used language.[br]
 			Type <type> should be one of: [br]
-			"full"  - returns full locale name, such as ru_RU.UTF-8 (default)
-			"lang"  - return language name, such as "ru_RU"
-			"short" - returns only language group such as "ru"
+			"full"  - returns full locale name, such as ru_RU.UTF-8 (default).[br]
+			"lang"  - return language name, such as "ru_RU".[br]
+			"short" - returns only language group such as "ru".[br]
 	*/
 
 	KVSCF(lang)
@@ -1031,7 +1031,7 @@ KVSCF(gender)
 		@syntax:
 			<string> $lf
 		@description:
-			Returns a line feed character
+			Returns a line feed character.
 		@seealso:
 			[fnc]$cr[/fnc], [fnc]$ascii[/fnc], [fnc]$char[/fnc]
 	*/
diff --git a/src/kvirc/kvs/KviKvsCoreFunctions_sz.cpp b/src/kvirc/kvs/KviKvsCoreFunctions_sz.cpp
index 13069619a..27d847e86 100644
--- a/src/kvirc/kvs/KviKvsCoreFunctions_sz.cpp
+++ b/src/kvirc/kvs/KviKvsCoreFunctions_sz.cpp
@@ -484,7 +484,7 @@ namespace KviKvsCoreFunctions
 			$$
 		@description:
 			Returns the ID of the current object or ('0') if there is
-			none. This function has equivalent to [fnc]$this[/fnc]
+			none. This function is equivalent to [fnc]$this[/fnc]
 	*/
 
 	KVSCF(thisCKEYWORDWORKAROUND)
@@ -731,7 +731,7 @@ namespace KviKvsCoreFunctions
 			have a variable that can assume boolean values it's
 			nicer to use $true and [fnc]$false[/fnc] instead of
 			the integer constants 1 and 0. The reader will
-			undestand immediately that the variable simply can't
+			understand immediately that the variable simply can't
 			assume any other value.
 		@examples:
 			[example]
diff --git a/src/modules/chan/libkvichan.cpp b/src/modules/chan/libkvichan.cpp
index 25c031840..3340e52d3 100644
--- a/src/modules/chan/libkvichan.cpp
+++ b/src/modules/chan/libkvichan.cpp
@@ -100,7 +100,7 @@ static bool chan_kvs_fnc_name(KviKvsModuleFunctionCall * c)
 		<string> $chan.getUrl(<window_id:string>)
 		<string> $chan.getUrl(<channel_name:string>)
 	@description:
-		Returns IRC URL for this channel
+		Returns the IRC URL for this channel.
 */
 static bool chan_kvs_fnc_getUrl(KviKvsModuleFunctionCall * c)
 {
@@ -640,7 +640,7 @@ static bool chan_kvs_fnc_ison(KviKvsModuleFunctionCall * c)
 		Returns the channel user mode flag of an user on the channel specified by <window_id>.[br]
 		If <window_id> is not passed, the current window is used.[br]
 		If the specified window is not a channel, a warning is printed and an empty string is returned.[br]
-		If the specified user is not on the channel identified by <window_id>, and empty string is returned.[br]
+		If the specified user is not on the channel identified by <window_id>, an empty string is returned.[br]
 		The possible user flags are:[br]
 			'!' for channel administrators[br]
 			'@' for ops[br]
@@ -933,7 +933,7 @@ IS_ME_KVS_FUNC(chan_kvs_fnc_ismeuserop,isMeUserOp)
 	@description:
 		Returns the mode string of the channel identified by <window_id>.[br]
 		If no <window_id> is passed, the current channel mode string is returned (assuming that
-		the current window is a chnannel at all).[br]
+		the current window is a channel at all).[br]
 		If the window is not a channel, a warning is printed and an empty string is returned.[br]
 */
 static bool chan_kvs_fnc_mode(KviKvsModuleFunctionCall * c)
@@ -966,7 +966,7 @@ static bool chan_kvs_fnc_mode(KviKvsModuleFunctionCall * c)
 	@description:
 		Returns the key of the channel identified by <window_id>.[br]
 		If no <window_id> is passed, the current channel key is returned (assuming that
-		the current window is a chnannel at all).[br]
+		the current window is a channel at all).[br]
 		If the window is not a channel, a warning is printed and an empty string is returned.[br]
 		If the channel has no key set, an empty string is returned.[br]
 		Alternatively, you could use $chan.modeParam(k) to get the current key.
@@ -999,7 +999,7 @@ static bool chan_kvs_fnc_key(KviKvsModuleFunctionCall * c)
 	@description:
 		Returns the limit of the channel identified by <window_id>.[br]
 		If no <window_id> is passed, the current channel limit is returned (assuming that
-		the current window is a chnannel at all).[br]
+		the current window is a channel at all).[br]
 		If the window is not a channel, a warning is printed and an empty string is returned.[br]
 		If the channel has no limit set, "0" is returned.[br]
 		Alternatively, you could use $chan.modeParam(l) to get the current limit.
@@ -1037,7 +1037,7 @@ static bool chan_kvs_fnc_limit(KviKvsModuleFunctionCall * c)
 	@description:
 		Returns the parameter for a set mode of a channel identified by <window_id>.[br]
 		If no <window_id> is passed, the current channel key is returned (assuming that
-		the current window is a chnannel at all).[br]
+		the current window is a channel at all).[br]
 		If the window is not a channel, a warning is printed and an empty string is returned.[br]
 		If the channel has no such a mode set, an empty string is returned.[br]
 		If you need to get the current channel key or user limit, you can use one of the specialized functions.[br]
@@ -1232,7 +1232,7 @@ next_item:
 	@syntax:
 		$chan.banlist([window_id])
 	@description:
-		Returns an array of ban masks set ont the channel identified by [window_id].[br]
+		Returns an array of ban masks set on the channel identified by [window_id].[br]
 		If [window_id] is empty, the current window is used.[br]
 		If the window designated by [window_id] is not a channel a warning is printed and an empty array is returned.[br]
 	@seealso:
@@ -1587,7 +1587,7 @@ static bool chan_kvs_fnc_matchinvite(KviKvsModuleFunctionCall * c)
 		Use [fnc]$chan.matchmask[/fnc] instead.[br]
 		Some networks use +q channel mode to set "mute bans".[br]
 		When an user mask matches such a ban, he won't be able to send messages to the channel.[br]
-		The "mute bans" masks will be inserted in the normal channel bans list, with a percent sign % prepended
+		The "mute bans" masks will be inserted in the normal channel bans list, with a percent sign % prepended.[br]
 		This function returns the "mute ban" mask that matches <complete_mask> on channel identified by [window_id].[br]
 		If no ban mask matches <complete_mask> an empty string is returned.[br]
 		If [window_id] is empty, the current window is used.[br]
diff --git a/src/modules/config/libkviconfig.cpp b/src/modules/config/libkviconfig.cpp
index 13a6541ee..79f712f7b 100644
--- a/src/modules/config/libkviconfig.cpp
+++ b/src/modules/config/libkviconfig.cpp
@@ -309,7 +309,7 @@ static bool config_kvs_fnc_readonly(KviKvsModuleFunctionCall * c)
 	@description:
 		Returns the filename of the [b]open[/b] config file identifier by <id>.[br]
 		<id> must be a valid config identifier returned by [fnc]$config.open[/fnc]()
-		If the <id> doesn't match any open file, and empty string is returned.[br]
+		If the <id> doesn't match any open file, an empty string is returned.[br]
 	@seealso:
 		[module:config]Config module documentation[/module]
 */
diff --git a/src/modules/context/libkvicontext.cpp b/src/modules/context/libkvicontext.cpp
index 61def0ef1..e9fe071d2 100644
--- a/src/modules/context/libkvicontext.cpp
+++ b/src/modules/context/libkvicontext.cpp
@@ -625,7 +625,7 @@ static bool context_kvs_fnc_queueSize(KviKvsModuleFunctionCall * c)
 		If <context_id> is not a valid IRC Context identifier (or it is omitted and the current window
 		has no associated IRC Context) then this function prints a warning and returns an empty string.[br]
 		If the IRC Context is not using ssl then this function returns an empty string.[br]
-		Some queries can accept an optional parameter <param1>[br]
+		Some queries can accept an optional parameter <param1>.[br]
 		Available query strings are:[br]
 		[ul]
 		[li]signatureType[/li]
diff --git a/src/modules/dcc/libkvidcc.cpp b/src/modules/dcc/libkvidcc.cpp
index c67ffad34..c8df8bfda 100644
--- a/src/modules/dcc/libkvidcc.cpp
+++ b/src/modules/dcc/libkvidcc.cpp
@@ -2715,7 +2715,7 @@ static bool dcc_kvs_fnc_sessionList(KviKvsModuleFunctionCall * c)
 		If <dcc_id> 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]
 		If the DCC session is not using ssl then this function returns an empty string.[br]
-		Some queries can accept an optional parameter <param1>[br]
+		Some queries can accept an optional parameter <param1>.[br]
 		Available query strings are:[br]
 		[ul]
 		[li]signatureType[/li]
diff --git a/src/modules/file/libkvifile.cpp b/src/modules/file/libkvifile.cpp
index 5a41a63ba..cbe12d370 100644
--- a/src/modules/file/libkvifile.cpp
+++ b/src/modules/file/libkvifile.cpp
@@ -550,7 +550,7 @@ static bool file_kvs_fnc_size(KviKvsModuleFunctionCall * c)
 	<array> $file.allSize(<dirname:string>)
 	@description:
 	Returns the size of each file in a specified directory as an array.[br]
-	This function is not recursive: it wont return the size of files in subdirectories of <dirname>.
+	This function is not recursive: it won't return the size of files in subdirectories of <dirname>.
 */
 static bool file_kvs_fnc_allSizes(KviKvsModuleFunctionCall * c)
 {
@@ -763,10 +763,10 @@ static bool file_kvs_fnc_ls(KviKvsModuleFunctionCall * c)
 		The data read is returned as a string, so if the file contains binary data,
 		expect strange results.[br] If <size> is not specified, then KVIrc tries to read
 		the whole file up to the 1 MiB limit (so if you want to read a file that is
-		bigger thatn 1 MiB then you MUST specify the <size>).[br]
+		bigger than 1 MiB then you MUST specify the <size>).[br]
 		If you want read binary data (with null bytes inside) then take a look at [fnc]$file.readBytes[/fnc].
-		WARNING: always check the file size before attemting to read a whole file...
-		reading a CDROM iso image may sit down your system :) (and will prolly crash while
+		WARNING: always check the file size before attempting to read a whole file...
+		reading a CDROM iso image may sit down your system :) (and will probably crash while
 		allocating memory, before attempting to read anything)[br]
 		An empty string is returned if a serious error occures.[br]
 		The <filename> is adjusted according to the system that KVIrc is running on.[br]
@@ -856,10 +856,10 @@ static bool file_kvs_fnc_read(KviKvsModuleFunctionCall * c)
 		<size> is an upper limit but may be not reached if the real file is smaller.[br]
 		If <size> is not specified, then KVIrc tries to read
 		the whole file up to the 1 MiB limit (so if you want to read a file that is
-		bigger thatn 1 MiB then you MUST specify the <size>).[br]
+		bigger than 1 MiB then you MUST specify the <size>).[br]
 		If you want simple text data then take a look at [fnc]$file.read[/fnc].
 		WARNING: always check the file size before attemting to read a whole file...
-		reading a CDROM iso image may sit down your system :) (and will prolly crash while
+		reading a CDROM iso image may sit down your system :) (and will probably crash while
 		allocating memory, before attempting to read anything)[br]
 		An empty array (or just "nothing") is returned if a serious error occures.[br]
 		The <filename> is adjusted according to the system that KVIrc is running on.[br]
diff --git a/src/modules/mask/libkvimask.cpp b/src/modules/mask/libkvimask.cpp
index 8afb7d23a..b09d638af 100644
--- a/src/modules/mask/libkvimask.cpp
+++ b/src/modules/mask/libkvimask.cpp
@@ -148,7 +148,7 @@ static bool mask_kvs_fnc_host(KviKvsModuleFunctionCall * c)
 	@syntax:
 		<boolean> $mask.hasNumericHost(<mask: string>)
 	@description:
-		Returns 1 if the hostname part of the mask is numeric (e.g : unresolved IPV4 or IPV6 address)
+		Returns 1 if the hostname part of the mask is numeric (e.g: unresolved IPv4 or IPv6 address).
 */
 
 
diff --git a/src/modules/math/libkvimath.cpp b/src/modules/math/libkvimath.cpp
index a26af9c12..213a5c4c8 100644
--- a/src/modules/math/libkvimath.cpp
+++ b/src/modules/math/libkvimath.cpp
@@ -93,7 +93,7 @@ static int isnan (double d) {
 	@syntax:
 		<real> $math.sin(<angle:real>)
 	@description:
-		Returns the sinus of the specified angle in radiants
+		Returns the sinus of the specified angle in radiants.
 */
 MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_sin,"angle",sin)
 
@@ -108,7 +108,7 @@ MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_sin,"angle",sin)
 	@syntax:
 		<real> $math.cos(<angle:real>)
 	@description:
-		Returns the cosinus of the specified angle in radiants
+		Returns the cosinus of the specified angle in radiants.
 */
 MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_cos,"angle",cos)
 
@@ -123,7 +123,7 @@ MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_cos,"angle",cos)
 	@syntax:
 		<real> $math.tan(<angle:real>)
 	@description:
-		Returns the tangent of the specified angle in radiants
+		Returns the tangent of the specified angle in radiants.
 */
 MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_tan,"angle",tan)
 
@@ -184,7 +184,7 @@ MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_atan,"tangent",atan)
 	@syntax:
 		<real> $math.sqrt(<number:real>)
 	@description:
-		Returns the square root of the specified number
+		Returns the square root of the specified number.
 */
 MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_sqrt,"number",sqrt)
 
@@ -199,7 +199,7 @@ MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_sqrt,"number",sqrt)
 	@syntax:
 		<real> $math.cbrt(<number:real>)
 	@description:
-		Returns the cube root of the specified number
+		Returns the cube root of the specified number.
 */
 MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_cbrt,"number",cbrt)
 
@@ -214,7 +214,7 @@ MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_cbrt,"number",cbrt)
 	@syntax:
 		<real> $math.abs(<number:real>)
 	@description:
-		Returns the absolute value of the specified number
+		Returns the absolute value of the specified number.
 */
 MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_abs,"number",fabs)
 
@@ -229,7 +229,7 @@ MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_abs,"number",fabs)
 	@syntax:
 		<real> $math.floor(<number:real>)
 	@description:
-		Rounds down number to the nearest integer
+		Rounds down the number to the nearest integer.
 */
 MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_floor,"number",floor)
 
@@ -244,7 +244,7 @@ MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_floor,"number",floor)
 	@syntax:
 		<real> $math.ceil(<number:real>)
 	@description:
-		Rounds up number to the nearest integer
+		Rounds up the number to the nearest integer.
 */
 MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_ceil,"number",ceil)
 
@@ -259,7 +259,7 @@ MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_ceil,"number",ceil)
 	@syntax:
 		<real> $math.exp(<number:real>)
 	@description:
-		Returns the exponential of the specified number
+		Returns the exponential of the specified number.
 */
 MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_exp,"number",exp)
 
@@ -274,7 +274,7 @@ MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_exp,"number",exp)
 	@syntax:
 		<real> $math.log(<number:real>)
 	@description:
-		Returns the natural (base e) logarithm of the specified number
+		Returns the natural (base e) logarithm of the specified number.
 */
 
 MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_log,"number",log)
@@ -291,7 +291,7 @@ MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_log,"number",log)
 	@syntax:
 		<real> $math.log10(<number:real>)
 	@description:
-		Returns the base 10 logarithm of the specified number
+		Returns the base 10 logarithm of the specified number.
 */
 MATH_KVS_1PARAM_FUNCTION(math_kvs_fnc_log10,"number",log10)
 
@@ -383,7 +383,7 @@ static bool math_kvs_fnc_pow(KviKvsModuleFunctionCall * c)
 	@syntax:
 		<real> $math.pi()
 	@description:
-		Returns the value of pi
+		Returns the value of pi.
 */
 #ifdef COMPILE_ON_WINDOWS
 static bool math_kvs_fnc_pi(KviKvsModuleFunctionCall * c)
@@ -409,7 +409,7 @@ static bool math_kvs_fnc_pi(KviKvsModuleFunctionCall * c)
 	@syntax:
 		<real> $math.e()
 	@description:
-		Returns the value of the euler constant e
+		Returns the value of the euler constant e.
 */
 
 
diff --git a/src/modules/my/libkvimy.cpp b/src/modules/my/libkvimy.cpp
index 00972553b..c8ac52741 100644
--- a/src/modules/my/libkvimy.cpp
+++ b/src/modules/my/libkvimy.cpp
@@ -304,11 +304,11 @@ static bool my_kvs_fnc_serverIsIPV6(KviKvsModuleFunctionCall * c)
 	@title:
 		$my.serverIsSSL
 	@short:
-		Returns 1 if the current server connection use SSL.
+		Returns 1 if the current server connection uses SSL
 	@syntax:
 		<boolean> $my.serverIsSSL([irc_context_id:uint])
 	@description:
-		Returns 1 if the server connection use SSL.[br]
+		Returns 1 if the server connection uses SSL.[br]
 		If the irc context is not connected then an empty string is returned.[br]
 		If <irc_context_id> is specified this function returns acts as it was called
 		in that irc_context.[br]