daily documentation fixes by OmegaPhil

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

3 files changed, 36 insertions, 38 deletions

diff --git a/src/kvirc/kvs/kvi_kvs_corecallbackcommands.cpp b/src/kvirc/kvs/kvi_kvs_corecallbackcommands.cpp
index 1b8d59a46..e0fdb98dc 100644
--- a/src/kvirc/kvs/kvi_kvs_corecallbackcommands.cpp
+++ b/src/kvirc/kvs/kvi_kvs_corecallbackcommands.cpp
@@ -179,21 +179,20 @@ namespace KviKvsCoreCallbackCommands
 			Adds the alias <alias_name> with the specified <implementation> code.
 			The implementation code can be either a single KVS instruction
 			or an instruction block (instruction list enclosed in braces).[br]
-			If the alias was already existing, it is replaced with the
-			new implementation.[br]
+			If the alias already exists, it is replaced with the new implementation.[br]
 			If the <implementation> is empty (eg. "{}" or just a ";")
-			the alias <alias_name> is removed instead of being added.
-			If the "remove" form is used but the specified <alias_name> is
-			not existing in the alias store then a warning is printed unless
+			the alias <alias_name> is removed.
+			If the "remove" form is used but the specified <alias_name> does not exist
+			in the alias store then a warning is printed unless
 			the -q (--quiet) switch is used.
 			If <alias_name> contains a "<name>::" prefix, then the alias
 			is created in the namespace specified by <name>.
-			If the namespace is not existing, it is created.
+			If the namespace does not exist, it is created.
 			Any alias without the "<name>::" prefix is created in the root
 			namespace. Namespaces are useful to avoid collisions in alias names
 			between scripts. Only really common aliases should be created
-			in the root namespace: all your script internal functionality
-			should be hidden in your own namespace.
+			in the root namespace - all of the internal functionality of your 
+			scripts should be hidden in your own namespace.
 		@examples:
 			[example]
 				[comment]# Add the alias j[/comment]
diff --git a/src/kvirc/kvs/kvi_kvs_eventtable.cpp b/src/kvirc/kvs/kvi_kvs_eventtable.cpp
index e3c6c039c..a27c0f67f 100644
--- a/src/kvirc/kvs/kvi_kvs_eventtable.cpp
+++ b/src/kvirc/kvs/kvi_kvs_eventtable.cpp
@@ -400,7 +400,7 @@ KviKvsEvent KviKvsEventManager::m_appEventTable[KVI_KVS_NUM_APP_EVENTS]=
 			High-Lag Alarm Started
 		@parameters:
 			$0 = server
-			$1 = Lag value in miliseconds
+			$1 = Lag value in milliseconds
 		@window:
 			Console
 		@description:
@@ -408,7 +408,7 @@ KviKvsEvent KviKvsEventManager::m_appEventTable[KVI_KVS_NUM_APP_EVENTS]=
 	*/
 	EVENT("OnLagAlarmTimeUp", \
 		"$0 = server\n" \
-		"$1 = lag time in miliseconds"),
+		"$1 = lag time in milliseconds"),
 
 	/*
 		@doc: onlagalarmtimedown
@@ -420,7 +420,7 @@ KviKvsEvent KviKvsEventManager::m_appEventTable[KVI_KVS_NUM_APP_EVENTS]=
 			High-Lag Alarm Stopped
 		@parameters:
 			$0 = server
-			$1 = Lag value in miliseconds
+			$1 = Lag value in milliseconds
 		@window:
 			Console
 		@description:
@@ -428,7 +428,7 @@ KviKvsEvent KviKvsEventManager::m_appEventTable[KVI_KVS_NUM_APP_EVENTS]=
 	*/
 	EVENT("OnLagAlarmTimeDown", \
 		"$0 = server\n" \
-		"$1 = lag time in miliseconds"),
+		"$1 = lag time in milliseconds"),
 
 	/*
 		@doc: onlagcheck
@@ -440,15 +440,15 @@ KviKvsEvent KviKvsEventManager::m_appEventTable[KVI_KVS_NUM_APP_EVENTS]=
 			The lag metering engine has checked the lag
 		@parameters:
 			$0 = server
-			$1 = Lag value in miliseconds
+			$1 = Lag value in milliseconds
 		@window:
 			Console
 		@description:
-			Triggered when the lag metering engine calculate a new current lag.[br]
+			Triggered when the lag metering engine periodically calculates the current lag (the interval is configurable under settings -> IRC -> Tools -> Lag). 
 	*/
 	EVENT("OnLagCheck", \
 		"$0 = server\n" \
-		"$1 = lag time in miliseconds"),
+		"$1 = lag time in milliseconds"),
 
 	/*
 		@doc: ontextinput
@@ -779,7 +779,7 @@ KviKvsEvent KviKvsEventManager::m_appEventTable[KVI_KVS_NUM_APP_EVENTS]=
 			OnOutboundTraffic
 		@short:
 			Triggered on outbound traffic.[br]
-			USE THIS EVENT WITH REALLY CAUTION: an improper use can leads to many problems to KVIrc; especially avoid the use of 'halt' command.
+			USE THIS EVENT WITH REAL CAUTION: an improper use can leads to many problems to KVIrc; especially avoid the use of 'halt' command.
 		@parameters:
 			$0 = outbound string
 		@window:
@@ -1162,18 +1162,18 @@ KviKvsEvent KviKvsEventManager::m_appEventTable[KVI_KVS_NUM_APP_EVENTS]=
 		@title:
 			OnChannelSync
 		@short:
-			Triggered when all the channel information have been received
+			Triggered when all channel information have been received
 		@parameters:
 			$0 = channel sync time in milliseconds
 		@window:
 			Channel
 		@description:
 			This event is triggered after you have joined a channel
-			and all the information have been received.[br]
+			and all information have been received.[br]
 			This includes the channel users list, the ban list,
 			the channel mode, the topic and eventually
 			the invite and ban exception lists.[br]
-			Calling halt in this even stops the "channel synchronized" output.[br]
+			Calling halt in this even stops the "channel synchronized" output.
 			(the output will be halted anyway if [fnc]$option[/fnc](boolShowChannelSyncTime) evaluates to false)
 		@seealso:
 			[event:ondccchatpopuprequest]OnDCCChatPopupRequest[/event],
@@ -3011,7 +3011,8 @@ KviKvsEvent KviKvsEventManager::m_appEventTable[KVI_KVS_NUM_APP_EVENTS]=
 			console
 		@description:
 			Triggered when a notice is received and the source user is recognized as
-			the NickServ service.<br>
+			the NickServ service (the source nick is 'NickServ' or its mask matches 
+			a mask defined in the Nickserver identify options).[br]
 			Calling [cmd]halt[/cmd] stops the message output.
 		@seealso:
 			[event:onquerynotice]OnQueryNotice[/event]
diff --git a/src/kvirc/kvs/kvi_kvs_object.cpp b/src/kvirc/kvs/kvi_kvs_object.cpp
index cf8e52248..df048e713 100644
--- a/src/kvirc/kvs/kvi_kvs_object.cpp
+++ b/src/kvirc/kvs/kvi_kvs_object.cpp
@@ -558,10 +558,10 @@
 	@inherits:
 		none
 	@description:
-		This is the base class for all the builtin KVirc object classes.
-		It exports the functions to retrieve the object name, to iterate
-		through children objects and to lookup a child object by name or class.
-		Additionally, this class provides the builtin timer functionality.
+		This is the base class for all builtin KVirc object classes.
+		It exports functions to retrieve an object's name, to iterate
+		through child objects and to lookup a child object by name or class.
+		Additionally, this class provides builtin timer functionality.
 		The [classfnc]$constructor[/classfnc] and [classfnc]$destructor[/classfnc]
 		functions are empty implementations that all the other classes inherit.
 	@functions:
@@ -582,9 +582,9 @@
 		and [classfnc]$killTimer[/classfnc]().
 		!fn: $startTimer(<timeout>)
 		Starts a builtin timer for this object and returns its timer id
-		as a string or '-1' if the <timeout> was invalid.
+		as a string or '-1' if <timeout> was invalid.
 		The [classfnc]$timerEvent[/classfnc]() handler function
-		will be called at each <timeout>. The <timeout> is in milliseconds.
+		will be called every <timeout> milliseconds until the timer is stopped by $killTimer(). 
 		!fn: $killTimer(<timer id>)
 		Stops the timer specified by <timer id>.
 		!fn: $className()
@@ -596,34 +596,32 @@
 		This function traverses the entire tree of children
 		but is NOT recursive.
 		!fn: $childCount()
-		Returns the number of children objects
+		Returns the number of child objects
 		!fn: $emit(<signal_name>[,parameters])
 		Emits the signal <signal_name> passing the optional [parameters].
 		See the [doc:objects]objects documentation[/doc] for an overview of signals and slots.
 		!fn: $children()
-		Returns an array of children object identifiers.
+		Returns an array of child object identifiers.
 		!fn: $signalSender()
 		Returns the current signal sender when in a slot connected to a signal.
 		In other contexts this function returns an empty string.
 		You can safely use it to test if the current function has been
 		triggered directly or from a signal emission.
 		!fn: $signalName()
-		Returns the name of the signal last signal that has triggered
-		one of this object's slots.
-		This means that in a slot handler it returns the name of the signal
-		that has triggered it.
+		Returns the name of the last signal that has triggered one of this object's slots.
+		When called in a slot handler, the triggering signal name is returned. 
 		!fn: $property(<Qt property name>[,bNowarning:boolean])
 		This is for really advanced scripting.[br]
 		All KVIrc widgets are based on the Qt library ones.[br]
-		The Qt library allow to set and read special properties.[br]
+		The Qt library allows to set and read special properties.[br]
 		You will have to take a look at the Qt documentation for each widget type
 		to see the available property names.[br]
 		The supported property types are: Rect, Size, Point, Color, String, CString,
 		Int, UInt, Bool and enumeration types.[br]
 		For example, the widget's x coordinate can be retrieved by using the [classfnc]$x[/classfnc]()
 		function or by calling $property(x).[br]
-		There are many properties that are available ony through the [classfnc]$property()[classfnc]" call:[br]
-		For example, you can find out if the widget accepts drops by calling [classfnc]$property(acceptDrops)[classfnc].[br]
+		There are many properties that are available ony through the [classfnc]$property[/classfnc]() call:[br]
+		For example, you can find out if the widget accepts drops by calling [classfnc]$property[/classfnc](acceptDrops).[br]
 		This function will be mainly useful in the [class]wrapper[/class] class.
 		!fn: $setProperty(<Qt property>,<property value>)
 		Sets a qt property for this widget.[br]
@@ -631,9 +629,9 @@
 		For example, the [class]multilineedit[/class] widgets can be set to
 		the "password" echo mode only by using this function call:[br]
 		[example]
-			%X=$new(lineedit, 0, a_name)
-			%X-&gt;$show()
-			%X-&gt;$setProperty(echoMode,Password)
+			%X=$new(lineedit, 0, a_name)[br]
+			%X-&gt;$show()[br]
+			%X-&gt;$setProperty(echoMode,Password)[br]
 		[/example]
 		The available properties to be set are listed by [classfnc]$listProperties[/classfnc]()[br]
 		and must appear in the list as writeable.[br]