aboutsummaryrefslogtreecommitdiffstats
path: root/src/modules
diff options
context:
space:
mode:
authorGravatar Fabio Bas2010-12-28 09:17:08 +0000
committerGravatar Fabio Bas2010-12-28 09:17:08 +0000
commit4386329804c686ee0f006f9a079174b51c5b4a14 (patch)
tree8080ffb4d3d37c09a4229289d78092d736f46543 /src/modules
parentupdated docs (diff)
downloadKVIrc-4386329804c686ee0f006f9a079174b51c5b4a14.tar.gz
KVIrc-4386329804c686ee0f006f9a079174b51c5b4a14.tar.bz2
KVIrc-4386329804c686ee0f006f9a079174b51c5b4a14.zip
daily documentation fixes by OmegaPhil
git-svn-id: https://svn.kvirc.de/svn/trunk/kvirc@5242 17fca916-40b9-46aa-a4ea-0a15b648b75c
Diffstat (limited to 'src/modules')
-rw-r--r--src/modules/context/libkvicontext.cpp2
-rw-r--r--src/modules/str/libkvistr.cpp16
-rw-r--r--src/modules/window/libkviwindow.cpp8
3 files changed, 13 insertions, 13 deletions
diff --git a/src/modules/context/libkvicontext.cpp b/src/modules/context/libkvicontext.cpp
index cbfb906ac..6628a6d22 100644
--- a/src/modules/context/libkvicontext.cpp
+++ b/src/modules/context/libkvicontext.cpp
@@ -464,7 +464,7 @@ static bool context_kvs_fnc_state(KviKvsModuleFunctionCall * c)
Print the names of the currently connected servers
[example]
foreach(%ic,$context.list)
- echo "IRC Context" %ic ": " $context.serverHostName
+ echo "IRC Context" %ic ": " $context.serverHostName(%ic)
[/example]
*/
diff --git a/src/modules/str/libkvistr.cpp b/src/modules/str/libkvistr.cpp
index 78f9703c5..4e28300c3 100644
--- a/src/modules/str/libkvistr.cpp
+++ b/src/modules/str/libkvistr.cpp
@@ -1685,16 +1685,16 @@ static bool str_kvs_fnc_grep(KviKvsModuleFunctionCall * c)
@description:
Splits the <data> string by <separator> and returns an array of substrings.[br]
<flags> may be a combination of the characters 's', 'w', 'r' and 'n'.[br]
- If s is specified, <separator> matching is case sensitive, otherwise is case insensitive.[br]
+ If s is specified, <separator> matching is case sensitive, otherwise it is case insensitive.[br]
If w is specified, <separator> is treated as a wildcard-type regular expression
- (with * and ? wildcars).[br]
+ (with * and ? wildcards).[br]
If r is specified, <separator> is treated as a extended-type regular expression
(with character classes, special escapes etc..).[br]
- If both w and r are specified w takes precedence.[br]
- If none of w and r are specified <separator> is treated as a simple string to be matched.[br]
- If 'n' is specified then eventual empty fields are discarded.[br]
- If <maxfield> is specified then at most <maxfields> items are returned in the array (i.e. the last
- item may be not splitted completly).
+ If both w and r are specified, w takes precedence.[br]
+ If neither w and r are specified <separator> is treated as a simple string to be matched.[br]
+ If 'n' is specified then any resulting empty fields are discarded.[br]
+ If <maxfield> is specified, then at most <maxfields> items are returned in the array (i.e. the last
+ item may be not completely split).
@examples:
[example]
[comment]# Split the fields[/comment]
@@ -1714,7 +1714,7 @@ static bool str_kvs_fnc_grep(KviKvsModuleFunctionCall * c)
%Test[] = $str.split("Y*H","hihiYeaHhohohoyeahYepYEAHhi",sw)
echo %Test[]
[/example]
- If used in "non-array" context it returns just a comma separated list of substrings:[br]
+ If used outside of an array context, a comma-separated list of substrings is returned:[br]
[example]
[cmd]echo[/cmd] $str.split("[ ]*","Condense spaces and change &nbsp; &nbsp; all &nbsp; &nbsp; &nbsp; it in commas",r)
[/example]
diff --git a/src/modules/window/libkviwindow.cpp b/src/modules/window/libkviwindow.cpp
index e6590bf3a..0ed95f63d 100644
--- a/src/modules/window/libkviwindow.cpp
+++ b/src/modules/window/libkviwindow.cpp
@@ -609,15 +609,15 @@ static bool window_kvs_fnc_hasUserFocus(KviKvsModuleFunctionCall * c)
@title:
$window.console
@short:
- Returns the console that a window is attacched to
+ Returns the console that a window is attached to
@syntax:
$window.console
$window.console(<window_id>)
@description:
- Returns the id of the console window that the window specified by window_id is attacched to.
+ Returns the id of the console window that the window specified by window_id is attached to.
The console is the main (and only) console of the IRC context. If window_id is missing then
the current window is used. If this window does not belong to an irc context (and thus has
- no attacched console) then 0 is returned.
+ no attached console) then 0 is returned.
@seealso:
*/
@@ -1117,7 +1117,7 @@ static bool window_kvs_fnc_list(KviKvsModuleFunctionCall * c)
If <caption> is given then the new window will have it as the initial plain text <caption>.
You can change the caption later by calling [cmd]window.setWindowTitle[/cmd].[br]
If <irc_context> is given then the new window is bound to the specified irc context
- and will be destroyed when the attacched console closes.
+ and will be destroyed when the attached console closes.
If <irc_context> is omitted or is 0 then the window will be context free (not bound
to any context) and will exist until it is closed by the GUI, by a [cmd]window.close[/cmd]
call or until KVIrc terminates. When <irc_context> is given but is not valid