diff options
| author |  un1versal | 2016-03-02 12:15:44 +0000 |
|---|---|---|
| committer | un1versal | 2016-03-14 04:57:12 +0000 |
| commit | f138911b65dfce85c551f9e2e4bbeb595d6c6755 (patch) | |
| tree | 701d5eec803c30160be47f8762b5838e57bc44dd /src/modules/window | |
| 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/window')
| -rw-r--r-- | src/modules/window/libkviwindow.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/modules/window/libkviwindow.cpp b/src/modules/window/libkviwindow.cpp index 7f23dfb71..1b9125d1f 100644 --- a/src/modules/window/libkviwindow.cpp +++ b/src/modules/window/libkviwindow.cpp @@ -370,7 +370,7 @@ static bool window_kvs_fnc_activityTemperature(KviKvsModuleFunctionCall * c) $window.isDocked $window.isDocked(<window_id>) @description: - Returns 1 if the window specified by <window_id> is currently docked and 0 otherwise. + Returns [b]1[/b] if the window specified by <window_id> is currently docked and [b]0[/b] otherwise. The form with no parameters works on the current window. If the specified window doesn't exist then 0 is returned. @seealso: @@ -400,7 +400,7 @@ static bool window_kvs_fnc_isDocked(KviKvsModuleFunctionCall * c) $window.hasInput $window.hasInput(<window_id>) @description: - Returns 1 if the window specified by <window_id> has an input field and 0 otherwise. + Returns [b]1[/b] if the window specified by <window_id> has an input field and [b]0[/b] otherwise. The form with no parameters works on the current window. If the specified window doesn't exist then 0 is returned. @seealso: @@ -430,8 +430,8 @@ static bool window_kvs_fnc_hasInput(KviKvsModuleFunctionCall * c) $window.hasUserFocus $window.hasUserFocus(<window_id>) @description: - Returns 1 if the window specified by <window_id> has - currently the user focus and 0 otherwise. + Returns [b]1[/b] if the window specified by <window_id> has + currently the user focus and [b]0[/b] otherwise. The form with no parameters works on the current window. If the specified window doesn't exist then 0 is returned. A window has the user focus if it is the KVIrc's active @@ -493,7 +493,7 @@ static bool window_kvs_fnc_console(KviKvsModuleFunctionCall * c) $window.hasOutput $window.hasOutput(<window_id>) @description: - Returns 1 if the window specified by <window_id> has a text output widget and 0 otherwise. + Returns [b]1[/b] if the window specified by <window_id> has a text output widget and [b]0[/b] otherwise. The form with no parameters works on the current window. If the specified window doesn't exist then 0 is returned. @seealso: |