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/objects/libkviobjects.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/objects/libkviobjects.cpp')
| -rw-r--r-- | src/modules/objects/libkviobjects.cpp | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/src/modules/objects/libkviobjects.cpp b/src/modules/objects/libkviobjects.cpp index c862eed37..caf3f8a04 100644 --- a/src/modules/objects/libkviobjects.cpp +++ b/src/modules/objects/libkviobjects.cpp @@ -624,32 +624,32 @@ static bool objects_kvs_cmd_disconnect(KviKvsModuleCommandCall * c) static bool objects_kvs_fnc_listObjects(KviKvsModuleFunctionCall * cmd) { -/* - @doc: objects.dump - @type: - function - @title: - $objects.dump - @keyterms: - dump objects - @short: - Dump the KVIrc widgets. - @syntax: - <array> $objects.dump(<print:boolean>) - @description: - This function return an array containing a representation of the widgets tree in KVIrc;[br] - If the <print> flag is enabled, the array will be printed in the current window, too. - @examples: - [example] - %A[]=$objects.dump(0) - %i=0 - while (%i != %A[]#) - { - echo %A[%i] - %i++ - } - [/example] -*/ + /* + @doc: objects.dump + @type: + function + @title: + $objects.dump + @keyterms: + dump objects + @short: + Dump the KVIrc widgets. + @syntax: + <array> $objects.dump(<print:boolean>) + @description: + This function return an array containing a representation of the widgets tree in KVIrc;[br] + If the <print> flag is enabled, the array will be printed in the current window, too. + @examples: + [example] + %A[]=$objects.dump(0) + %i=0 + while (%i != %A[]#) + { + echo %A[%i] + %i++ + } + [/example] + */ bool bFlag; |
