diff options
| author | 2016-03-02 12:15:44 +0000 | |
|---|---|---|
| committer | 2016-03-14 04:57:12 +0000 | |
| commit | f138911b65dfce85c551f9e2e4bbeb595d6c6755 (patch) | |
| tree | 701d5eec803c30160be47f8762b5838e57bc44dd /src/modules/notifier/libkvinotifier.cpp | |
| parent | cleanup: add or remove empty lines between documentation blocks & code (diff) | |
| download | KVIrc-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/notifier/libkvinotifier.cpp')
| -rw-r--r-- | src/modules/notifier/libkvinotifier.cpp | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/src/modules/notifier/libkvinotifier.cpp b/src/modules/notifier/libkvinotifier.cpp index b6c6584e7..49236b55a 100644 --- a/src/modules/notifier/libkvinotifier.cpp +++ b/src/modules/notifier/libkvinotifier.cpp @@ -68,7 +68,7 @@ kvi_time_t g_tNotifierDisabledUntil = 0; any color and/or font specification since the notifier is skinnable and you don't know which color will result in a visible text. [b]Please note that the user can forcibly disable the notifier - for a limited period of time (a sort of "don't bug me" option).[/b] + for a limited period of time (a sort of [i]don't bug me[/i] option).[/b] @switches: !sw: -n | --noanim Do not animate @@ -111,6 +111,7 @@ kvi_time_t g_tNotifierDisabledUntil = 0; notifier.message -t=10 This message will be shown only for 10 seconds [/example] */ + static bool notifier_kvs_cmd_message(KviKvsModuleCommandCall * c) { QString szMessage; @@ -177,10 +178,11 @@ static bool notifier_kvs_cmd_message(KviKvsModuleCommandCall * c) @description: Hide the notifier window [b]Please note that the user can forcibly disable the notifier - for a limited period of time (a sort of "don't bug me" option).[/b] + for a limited period of time (a sort of [i]don't bug me[/i] option).[/b] @seealso: [cmd]notifier.show[/cmd] [cmd]notifier.message[/cmd] [fnc]$notifier.isEnabled[/fnc] */ + static bool notifier_kvs_cmd_hide(KviKvsModuleCommandCall * c) { if(g_pNotifierWindow) @@ -207,10 +209,11 @@ static bool notifier_kvs_cmd_hide(KviKvsModuleCommandCall * c) not animated.[br] The notifier is shown [b]only[/b] if it contains some messages. [b]Please note that the user can forcibly disable the notifier - for a limited period of time (a sort of "don't bug me" option).[/b] + for a limited period of time (a sort of [i]don't bug me[/i] option).[/b] @seealso: [cmd]notifier.hide[/cmd] [cmd]notifier.message[/cmd] [fnc]$notifier.isEnabled[/fnc] */ + static bool notifier_kvs_cmd_show(KviKvsModuleCommandCall * c) { if(!g_pNotifierWindow) @@ -231,22 +234,23 @@ static bool notifier_kvs_cmd_show(KviKvsModuleCommandCall * c) @title: $notifier.isEnabled @short: - Returns 1 if the notifier window is enabled + Returns [b]1[/b] if the notifier window is enabled @syntax: <boolean> $notifier.isEnabled @description: - Returns 1 if the notifier window is enabled and 0 otherwise. - The user can forcibly disable the notifier as a sort of "don't bug me" + Returns [b]1[/b] if the notifier window is enabled and [b]0[/b] otherwise. + The user can forcibly disable the notifier as a sort of [i]don't bug me[/i] feature for a limited period of time. When the notifier is disabled the messages sent to it will not be shown.[br] The only method that you (the scripter) can use to forcibly re-enable the notifier is to unload the module and - reload it...but [b]don't do it[/b] :)[br] + reload it, but [b]don't do it[/b] :)[br] There is also a global option that allows forcibly disabling the notifier forever, this option could be overridden with [cmd]option[/cmd] - instead.. but again [b]don't do it[/b] :)[br] + instead, but again [b]don't do it[/b] :)[br] */ + static bool notifier_kvs_fnc_isEnabled(KviKvsModuleFunctionCall * c) { bool bCheck; |
