diff options
| author | 2008-03-04 16:02:47 +0000 | |
|---|---|---|
| committer | 2008-03-04 16:02:47 +0000 | |
| commit | 36dda497591e6691e757ed076ba62876b7a05c60 (patch) | |
| tree | e1b121de6a0d9884825f95cff4641422d2e1982e | |
| parent | A couple of fixes and a version switch (diff) | |
| download | KVIrc-36dda497591e6691e757ed076ba62876b7a05c60.tar.gz KVIrc-36dda497591e6691e757ed076ba62876b7a05c60.tar.bz2 KVIrc-36dda497591e6691e757ed076ba62876b7a05c60.zip | |
little doc fixes
git-svn-id: https://svn.kvirc.de/svn/trunk/kvirc@1181 17fca916-40b9-46aa-a4ea-0a15b648b75c
| -rw-r--r-- | src/kvirc/kvs/kvi_kvs_corefunctions_af.cpp | 28 | ||||
| -rw-r--r-- | src/kvirc/kvs/kvi_kvs_corefunctions_gl.cpp | 22 | ||||
| -rw-r--r-- | src/kvirc/kvs/kvi_kvs_corefunctions_mr.cpp | 8 | ||||
| -rw-r--r-- | src/kvirc/kvs/kvi_kvs_corefunctions_sz.cpp | 12 | ||||
| -rw-r--r-- | src/kvirc/kvs/kvi_kvs_coresimplecommands_af.cpp | 12 | ||||
| -rw-r--r-- | src/kvirc/kvs/kvi_kvs_coresimplecommands_mr.cpp | 12 | ||||
| -rw-r--r-- | src/kvirc/kvs/kvi_kvs_coresimplecommands_sz.cpp | 10 |
7 files changed, 56 insertions, 48 deletions
diff --git a/src/kvirc/kvs/kvi_kvs_corefunctions_af.cpp b/src/kvirc/kvs/kvi_kvs_corefunctions_af.cpp index 30bf5987b..473a8e2a5 100644 --- a/src/kvirc/kvs/kvi_kvs_corefunctions_af.cpp +++ b/src/kvirc/kvs/kvi_kvs_corefunctions_af.cpp @@ -70,7 +70,7 @@ namespace KviKvsCoreFunctions for communicating something REALLY urgent (and maybe unrelated to a specific IRC connection) to the user. @seealso: - [fnc]$window[/fnc], + [fnc]$window[/fnc] */ KVSCF(active) @@ -111,7 +111,7 @@ namespace KviKvsCoreFunctions This function has been renamed to $unicode and is present only for backward compatibility. @seealso: - [fnc]$cr[/fnc],[fnc]$lf[/fnc],[fnc]$char[/fnc] + [fnc]$cr[/fnc], [fnc]$lf[/fnc], [fnc]$char[/fnc] */ /////////////////////////////////////////////////////////////////////////////////////////////// @@ -134,7 +134,7 @@ namespace KviKvsCoreFunctions @examples: [cmd]echo[/cmd] $asciiToBase64("Hello!") @seealso: - [fnc]$base64toascii()[/fnc] + [fnc]$base64toascii[/fnc] */ KVSCF(asciiToBase64) @@ -176,7 +176,7 @@ namespace KviKvsCoreFunctions @examples: [cmd]echo[/cmd] $asciiToHex("Hello!") @seealso: - [fnc]$hextoascii()[/fnc] + [fnc]$hextoascii[/fnc] */ KVSCF(asciiToHex) @@ -315,7 +315,7 @@ namespace KviKvsCoreFunctions @description: Returns the BOLD mIRC control character (CTRL+B).[br] @seealso: - [fnc]$k[/fnc],[fnc]$u[/fnc] + [fnc]$k[/fnc], [fnc]$u[/fnc] */ KVSCF(b) @@ -339,7 +339,7 @@ namespace KviKvsCoreFunctions @description: Decodes a base64 encoded string. @seealso: - [fnc]$asciiToBase64[/fnc]() + [fnc]$asciiToBase64[/fnc] */ KVSCF(base64ToAscii) @@ -379,8 +379,8 @@ namespace KviKvsCoreFunctions Note that since KVIrc does most of the casting work automatically you shouldn't need to use this function. @seealso: - [fnc]$real()[/fnc] - [fnc]$integer()[/fnc] + [fnc]$real[/fnc] + [fnc]$integer[/fnc] */ /* @@ -396,8 +396,8 @@ namespace KviKvsCoreFunctions @description: This is an internal alias to [fnc]$boolean[/fnc](). @seealso: - [fnc]$real()[/fnc] - [fnc]$integer()[/fnc] + [fnc]$real[/fnc] + [fnc]$integer[/fnc] */ KVSCF(boolean) @@ -438,7 +438,7 @@ namespace KviKvsCoreFunctions @seealso: [fnc]$window[/fnc], [fnc]$query[/fnc], - [fnc]$console[/fnc] + [fnc]$console[/fnc], [doc:window_naming_conventions]Window naming conventions[/doc] */ @@ -499,7 +499,7 @@ namespace KviKvsCoreFunctions If the <unicode_code> is not a valid UNICODE code (or is 0), this function returns an empty string.[br] @seealso: - [fnc]$cr[/fnc],[fnc]$lf[/fnc],[fnc]$unicode[/fnc] + [fnc]$cr[/fnc], [fnc]$lf[/fnc], [fnc]$unicode[/fnc] */ KVSCF(charCKEYWORDWORKAROUND) @@ -566,7 +566,7 @@ namespace KviKvsCoreFunctions @seealso: [fnc]$window[/fnc], [fnc]$channel[/fnc], - [fnc]$query[/fnc] + [fnc]$query[/fnc], [doc:window_naming_conventions]Window naming conventions[/doc] */ @@ -660,7 +660,7 @@ namespace KviKvsCoreFunctions @description: Returns a carriage return character @seealso: - [fnc]$lf[/fnc],[fnc]$ascii[/fnc],[fnc]$char[/fnc] + [fnc]$lf[/fnc], [fnc]$ascii[/fnc], [fnc]$char[/fnc] */ KVSCF(cr) diff --git a/src/kvirc/kvs/kvi_kvs_corefunctions_gl.cpp b/src/kvirc/kvs/kvi_kvs_corefunctions_gl.cpp index aa14a89b0..e75967554 100644 --- a/src/kvirc/kvs/kvi_kvs_corefunctions_gl.cpp +++ b/src/kvirc/kvs/kvi_kvs_corefunctions_gl.cpp @@ -116,7 +116,7 @@ namespace KviKvsCoreFunctions [cmd]echo[/cmd] $hexToAscii(6B76697263) [/example] @seealso: - [fnc]$asciitohex()[/fnc] + [fnc]$asciiToHex[/fnc] */ KVSCF(hexToAscii) @@ -166,7 +166,7 @@ namespace KviKvsCoreFunctions in this interval of time KVIrc knows only the user's nickname. This function will return the string "*" in this case.[br] @seealso: - [fnc]$iswellknown[/fnc], [fnc]$username[/fnc], [cmd]awhois[/cmd] + [fnc]$isWellKnown[/fnc], [fnc]$username[/fnc], [cmd]awhois[/cmd] */ KVSCF(hostname) @@ -220,7 +220,7 @@ namespace KviKvsCoreFunctions [cmd]echo[/cmd] $($hptimestamp - %tmp) [/example] @seealso: - [fnc]$unixtime[/fnc], [fnc]$date[/fnc], [fnc]$time[/fnc] + [fnc]$unixTime[/fnc], [fnc]$date[/fnc] */ KVSCF(hptimestamp) @@ -255,7 +255,7 @@ namespace KviKvsCoreFunctions [cmd]echo[/cmd] $icon(linux) [/example] @seealso: - [fnc]$iconname[/fnc] + [fnc]$iconName[/fnc] */ KVSCF(icon) @@ -300,7 +300,7 @@ namespace KviKvsCoreFunctions [cmd]echo[/cmd] $iconname([fnc]$icon[/fnc](linux)) [/example] @seealso: - [fnc]$iconname[/fnc] + [fnc]$iconName[/fnc] */ KVSCF(iconName) @@ -349,8 +349,8 @@ namespace KviKvsCoreFunctions Note that since KVIrc does most of the casting work automatically you shouldn't need to use this function. @seealso: - [fnc]$real()[/fnc] - [fnc]$boolean()[/fnc] + [fnc]$real[/fnc] + [fnc]$boolean[/fnc] */ /* @@ -366,8 +366,8 @@ namespace KviKvsCoreFunctions @description: This is an internal alias to [fnc]$integer[/fnc](). @seealso: - [fnc]$real()[/fnc] - [fnc]$boolean()[/fnc] + [fnc]$real[/fnc] + [fnc]$boolean[/fnc] */ KVSCF(integer) @@ -601,7 +601,7 @@ namespace KviKvsCoreFunctions @description: Returns 1 if the timer named <name> is actually running, else 0 @seealso: - [cmd]timer[/cmd],[cmd]killtimer[/cmd] + [cmd]timer[/cmd], [cmd]killtimer[/cmd] */ KVSCF(isTimer) @@ -843,7 +843,7 @@ namespace KviKvsCoreFunctions @description: Returns a line feed character @seealso: - [fnc]$cr[/fnc],[fnc]$ascii[/fnc],[fnc]$char[/fnc] + [fnc]$cr[/fnc], [fnc]$ascii[/fnc], [fnc]$char[/fnc] */ KVSCF(lf) diff --git a/src/kvirc/kvs/kvi_kvs_corefunctions_mr.cpp b/src/kvirc/kvs/kvi_kvs_corefunctions_mr.cpp index 661a35770..a39c132f6 100644 --- a/src/kvirc/kvs/kvi_kvs_corefunctions_mr.cpp +++ b/src/kvirc/kvs/kvi_kvs_corefunctions_mr.cpp @@ -361,7 +361,7 @@ namespace KviKvsCoreFunctions Please note that writing $null is semantically equivalent to writing 0 or even [fnc]$nothing[/fnc] in place of the handle, but $null increases code readability. @seealso: - [fnc]$new()[/fnc], [fnc]$nothing[/fnc] + [fnc]$new[/fnc], [fnc]$nothing[/fnc] */ KVSCF(nullCKEYWORDWORKAROUND) @@ -385,7 +385,7 @@ namespace KviKvsCoreFunctions @description: Returns the RESET mIRC control character (CTRL+O).[br] @seealso: - [fnc]$k[/fnc],[fnc]$b[/fnc],[fnc]$u[/fnc],[fnc]$r[/fnc] + [fnc]$k[/fnc], [fnc]$b[/fnc], [fnc]$u[/fnc], [fnc]$r[/fnc] */ KVSCF(o) @@ -518,7 +518,7 @@ namespace KviKvsCoreFunctions @description: Returns the REVERSE mIRC control character (CTRL+R).[br] @seealso: - [fnc]$k[/fnc],[fnc]$b[/fnc],[fnc]$u[/fnc],[fnc]$o[/fnc] + [fnc]$k[/fnc], [fnc]$b[/fnc], [fnc]$u[/fnc], [fnc]$o[/fnc] */ KVSCF(r) @@ -598,7 +598,7 @@ namespace KviKvsCoreFunctions Note that since KVIrc does most of the casting work automatically you shouldn't need to use this function. @seealso: - [fnc]$int()[/fnc] + [fnc]$int[/fnc] */ KVSCF(real) diff --git a/src/kvirc/kvs/kvi_kvs_corefunctions_sz.cpp b/src/kvirc/kvs/kvi_kvs_corefunctions_sz.cpp index 0d47bdba6..3fb132aa3 100644 --- a/src/kvirc/kvs/kvi_kvs_corefunctions_sz.cpp +++ b/src/kvirc/kvs/kvi_kvs_corefunctions_sz.cpp @@ -321,8 +321,8 @@ namespace KviKvsCoreFunctions Note that since KVIrc does most of the casting work automatically you shouldn't need to use this function. @seealso: - [fnc]$real()[/fnc] - [fnc]$integer()[/fnc] + [fnc]$real[/fnc] + [fnc]$integer[/fnc] */ KVSCF(string) @@ -830,7 +830,7 @@ namespace KviKvsCoreFunctions @description: Returns the UNDERLINE mIRC control character (CTRL+U).[br] @seealso: - [fnc]$k[/fnc],[fnc]$b[/fnc],[fnc]$r[/fnc],[fnc]$o[/fnc] + [fnc]$k[/fnc], [fnc]$b[/fnc], [fnc]$r[/fnc], [fnc]$o[/fnc] */ KVSCF(u) @@ -857,7 +857,7 @@ namespace KviKvsCoreFunctions If <char> is composed of more than one character then an array of UNICODE code points is returned. @seealso: - [fnc]$cr[/fnc],[fnc]$lf[/fnc],[fnc]$char[/fnc] + [fnc]$cr[/fnc], [fnc]$lf[/fnc], [fnc]$char[/fnc] */ KVSCF(unicode) @@ -895,7 +895,7 @@ namespace KviKvsCoreFunctions Returns the time since the Epoch (00:00:00 UTC, January 1, 1970), measured in seconds. @seealso: - [fnc]$time[/fnc], [fnc]$date[/fnc], [fnc]$hptimestamp[/fnc] + [fnc]$date[/fnc], [fnc]$hpTimeStamp[/fnc] */ KVSCF(unixtime) @@ -966,7 +966,7 @@ namespace KviKvsCoreFunctions in this interval of time KVIrc knows only the user's nickname. This function will return the string "*" in this case.[br] @seealso: - [fnc]$iswellknown[/fnc], [$fnc]$hostname[/fnc], [cmd]awhois[/cmd] + [fnc]$isWellKnown[/fnc], [$fnc]$hostname[/fnc], [cmd]awhois[/cmd] */ KVSCF(username) diff --git a/src/kvirc/kvs/kvi_kvs_coresimplecommands_af.cpp b/src/kvirc/kvs/kvi_kvs_coresimplecommands_af.cpp index b99b8ee58..39fabce05 100644 --- a/src/kvirc/kvs/kvi_kvs_coresimplecommands_af.cpp +++ b/src/kvirc/kvs/kvi_kvs_coresimplecommands_af.cpp @@ -223,7 +223,11 @@ namespace KviKvsCoreSimpleCommands ban Maxim,Gizmo!*@*,*!root@* [/example] @seealso: - [cmd]op[/cmd],[cmd]deop[/cmd],[cmd]voice[/cmd],[cmd]devoice[/cmd],[cmd]unban[/cmd] + [cmd]op[/cmd], + [cmd]deop[/cmd], + [cmd]voice[/cmd], + [cmd]devoice[/cmd], + [cmd]unban[/cmd] */ KVSCSC(ban) @@ -668,7 +672,7 @@ namespace KviKvsCoreSimpleCommands about inexisting items or inexisting popup menus.[br] See [cmd]defpopup[/cmd] for more informations.[br] @seealso: - [cmd]defpopup[/cmd],[cmd]popup[/cmd] + [cmd]defpopup[/cmd], [cmd]popup[/cmd] */ // FIXME: #warning "Separator should have the expression too ?" @@ -728,7 +732,7 @@ namespace KviKvsCoreSimpleCommands deop Pragma,Crocodile [/example] @seealso: - [cmd]op[/cmd],[cmd]voice[/cmd],[cmd]devoice[/cmd] + [cmd]op[/cmd], [cmd]voice[/cmd], [cmd]devoice[/cmd] */ KVSCSC(deop) @@ -760,7 +764,7 @@ namespace KviKvsCoreSimpleCommands devoice Pragma,Crocodile [/example] @seealso: - [cmd]op[/cmd],[cmd]deop[/cmd],[cmd]voice[/cmd] + [cmd]op[/cmd], [cmd]deop[/cmd], [cmd]voice[/cmd] */ KVSCSC(devoice) diff --git a/src/kvirc/kvs/kvi_kvs_coresimplecommands_mr.cpp b/src/kvirc/kvs/kvi_kvs_coresimplecommands_mr.cpp index 43dada66f..3bbfccb18 100644 --- a/src/kvirc/kvs/kvi_kvs_coresimplecommands_mr.cpp +++ b/src/kvirc/kvs/kvi_kvs_coresimplecommands_mr.cpp @@ -308,7 +308,7 @@ namespace KviKvsCoreSimpleCommands op Pragma,Crocodile [/example] @seealso: - [cmd]deop[/cmd],[cmd]voice[/cmd],[cmd]devoice[/cmd] + [cmd]deop[/cmd], [cmd]voice[/cmd], [cmd]devoice[/cmd] */ KVSCSC(op) @@ -392,7 +392,7 @@ namespace KviKvsCoreSimpleCommands #ifdef COMPILE_ON_WINDOWS if(KVI_OPTION_BOOL(KviOption_boolUseSystemUrlHandlers)) { - ShellExecute(NULL, "open", szUrl.local8Bit().data(),
+ ShellExecute(NULL, "open", szUrl.local8Bit().data(), NULL, NULL, SW_SHOWNORMAL); } else { #endif @@ -492,7 +492,7 @@ namespace KviKvsCoreSimpleCommands option fontIrcView helvetica,24,5,1,50 [/example] @seealso: - [fnc]$option[/fnc]() + [fnc]$option[/fnc] */ KVSCSC(option) @@ -860,7 +860,7 @@ namespace KviKvsCoreSimpleCommands if(!pMenu) { delete pPopupParams; - pPopupParams = 0; + pPopupParams = 0; KVSCSC_pContext->error(__tr2qs("Popup %Q is not defined"),&szPopupName); return false; } @@ -868,7 +868,7 @@ namespace KviKvsCoreSimpleCommands if(pMenu->isLocked()) { delete pPopupParams; - pPopupParams = 0; + pPopupParams = 0; KVSCSC_pContext->error(__tr2qs("A popup menu cannot be popped up twice")); return false; } @@ -1046,7 +1046,7 @@ namespace KviKvsCoreSimpleCommands quit @syntax: quit [-f] [-u] [quit-message:string] - quit -q + quit -q @short: Terminates the current IRC connection or the entier application @switches: diff --git a/src/kvirc/kvs/kvi_kvs_coresimplecommands_sz.cpp b/src/kvirc/kvs/kvi_kvs_coresimplecommands_sz.cpp index 81b17db27..332414ca4 100644 --- a/src/kvirc/kvs/kvi_kvs_coresimplecommands_sz.cpp +++ b/src/kvirc/kvs/kvi_kvs_coresimplecommands_sz.cpp @@ -581,7 +581,7 @@ namespace KviKvsCoreSimpleCommands This command is [doc:connection_dependant_commands]connection dependant[/doc]. @examples: [example] - topic #kvirc KVIrc 3.0.0 has been released! + topic #kvirc KVIrc 3.4.0 has been released! [/example] */ @@ -775,7 +775,11 @@ namespace KviKvsCoreSimpleCommands unban -r=[fnc]$channel[/fnc](#kvirc,[fnc]$context[/fnc](irc.myirc.net,Pragma)) Maxim,Gizmo!*@*,*!root*@* [/example] @seealso: - [cmd]op[/cmd],[cmd]deop[/cmd],[cmd]voice[/cmd],[cmd]devoice[/cmd],[cmd]ban[/cmd] + [cmd]op[/cmd], + [cmd]deop[/cmd], + [cmd]voice[/cmd], + [cmd]devoice[/cmd], + [cmd]ban[/cmd] */ KVSCSC(unban) @@ -825,7 +829,7 @@ namespace KviKvsCoreSimpleCommands voice Pragma,Crocodile [/example] @seealso: - [cmd]op[/cmd],[cmd]deop[/cmd],[cmd]devoice[/cmd] + [cmd]op[/cmd], [cmd]deop[/cmd], [cmd]devoice[/cmd] */ KVSCSC(voice) |
