aboutsummaryrefslogtreecommitdiffstats
path: root/src/modules/perl/libkviperl.cpp
diff options
context:
space:
mode:
authorGravatar un1versal2016-03-02 12:15:44 +0000
committerGravatar un1versal2016-03-14 04:57:12 +0000
commitf138911b65dfce85c551f9e2e4bbeb595d6c6755 (patch)
tree701d5eec803c30160be47f8762b5838e57bc44dd /src/modules/perl/libkviperl.cpp
parentcleanup: add or remove empty lines between documentation blocks & code (diff)
downloadKVIrc-f138911b65dfce85c551f9e2e4bbeb595d6c6755.tar.gz
KVIrc-f138911b65dfce85c551f9e2e4bbeb595d6c6755.tar.bz2
KVIrc-f138911b65dfce85c551f9e2e4bbeb595d6c6755.zip
documentation: formatting/indentation + minor syntax fixes
+ Dont use double quotes to emphasise words in normal circumstances. + improve indenting + consistency (good for readability when editing source) + also replace single quotes
Diffstat (limited to 'src/modules/perl/libkviperl.cpp')
-rw-r--r--src/modules/perl/libkviperl.cpp9
1 files changed, 4 insertions, 5 deletions
diff --git a/src/modules/perl/libkviperl.cpp b/src/modules/perl/libkviperl.cpp
index 3e8f3c834..9048d72cc 100644
--- a/src/modules/perl/libkviperl.cpp
+++ b/src/modules/perl/libkviperl.cpp
@@ -253,11 +253,11 @@
Note also that you must either escape the $ at the beginning of KVIrc identifiers
or use single quotes to prevent Perl from interpreting the $ as the beginning of a variable.
[example]
- [comment]// This will not work as expected[/comment]
+ [comment]# This will not work as expected[/comment]
[cmd]perl.begin[/cmd]
KVIrc::echo(KVIrc::eval("return $window.caption"));
[cmd]perl.end[/cmd]
- [comment]// But these will do[/comment]
+ [comment]# But these will do[/comment]
[cmd]perl.begin[/cmd]
KVIrc::echo(KVIrc::eval("return \$window.caption"));
KVIrc::echo(KVIrc::eval('return $window.caption'));
@@ -304,7 +304,7 @@
eval %tmp;
}
perlexec "/home/pragma/myperlscript.pl" "param1" "param2" "param3"
- [comment]// or even[/comment]
+ [comment]# or even[/comment]
[cmd]echo[/cmd] $perlexec("/home/pragma/computeprimelargerthan.pl","10000")
[/example]
[br]
@@ -543,7 +543,6 @@ static bool perl_kvs_cmd_destroy(KviKvsModuleCommandCall * c)
return true;
}
-
/*
@doc: perl.isAvailable
@type:
@@ -555,7 +554,7 @@ static bool perl_kvs_cmd_destroy(KviKvsModuleCommandCall * c)
@syntax:
$perl.isAvailable
@description:
- Returns 1 if the Perl scripting support is available and 0 otherwise.
+ Returns [b]1[/b] if the Perl scripting support is available and [b]0[/b] otherwise.
*/
static bool perl_kvs_fnc_isAvailable(KviKvsModuleFunctionCall * c)