aboutsummaryrefslogtreecommitdiffstats
path: root/src/modules/objects/KvsObject_dockWindow.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/objects/KvsObject_dockWindow.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/objects/KvsObject_dockWindow.cpp')
-rw-r--r--src/modules/objects/KvsObject_dockWindow.cpp6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/modules/objects/KvsObject_dockWindow.cpp b/src/modules/objects/KvsObject_dockWindow.cpp
index dcc97379e..02b0545e8 100644
--- a/src/modules/objects/KvsObject_dockWindow.cpp
+++ b/src/modules/objects/KvsObject_dockWindow.cpp
@@ -51,14 +51,14 @@
The widget must be a child of this dock window (otherwise strange things may happen).
!fn: $setAllowedDockAreas(<docks:string>)
Sets the allowed main window dock areas for this dock window.[br]
- <docks> must be a combination of "l","r","t","b","f" and "m".[br]
- "l" stands for left dock area, "r" stands for right dock area, "t" stands for the top dock areas, "b" stands for the bottom dock area, "f" stands for "floating" and "m" for "minimized".[br]
+ <docks> must be a combination of [i]l[/i], [i]r[/i], [i]t[/i], [i]b[/i], [b]f[/b] and [b]m[/b].[br]
+ [b]l[/b] stands for left dock area, [b]r[/b] stands for right dock area, [b]t[/b] stands for the top dock areas, [b]b[/b] stands for the bottom dock area,
+ [b]f[/b] stands for [i]floating[/i] and [b]m[/b] for [i]minimized[/i].[br]
If a flag is present then the related block area is enabled,otherwise it is disabled.
!fn: $dock(<dockarea:string>)
Docks this dock window to the specified dockarea of the main KVIrc window which can be one of "l" (left dock area), "t" (top dock area), "r" (right dock area), "b" (bottom dock area), "f" (floating) and "m" (minimized).
*/
-
KVSO_BEGIN_REGISTERCLASS(KvsObject_dockWindow,"dockwindow","widget")
KVSO_REGISTER_HANDLER_BY_NAME(KvsObject_dockWindow,addWidget)
KVSO_REGISTER_HANDLER_BY_NAME(KvsObject_dockWindow,setAllowedDockAreas)