aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorGravatar un1versal2016-05-08 02:15:47 +0100
committerGravatar un1versal2016-05-08 02:34:20 +0100
commitcfab43d4f685c1fda71893024cc420d316dcfa62 (patch)
treef34e565bf5a5328241f52ca280b8a07018e740b1 /src
parentMerge pull request #1973 from un1versal/The-Emperor's-New-Clothes (diff)
downloadKVIrc-cfab43d4f685c1fda71893024cc420d316dcfa62.tar.gz
KVIrc-cfab43d4f685c1fda71893024cc420d316dcfa62.tar.bz2
KVIrc-cfab43d4f685c1fda71893024cc420d316dcfa62.zip
documentation minor formatting fixes
Diffstat (limited to 'src')
-rw-r--r--src/kvirc/kvs/KviKvsCoreFunctions_sz.cpp2
-rw-r--r--src/kvirc/kvs/KviKvsCoreSimpleCommands_af.cpp30
-rw-r--r--src/kvirc/kvs/KviKvsCoreSimpleCommands_gl.cpp10
-rw-r--r--src/modules/help/libkvihelp.cpp10
-rw-r--r--src/modules/http/libkvihttp.cpp22
5 files changed, 37 insertions, 37 deletions
diff --git a/src/kvirc/kvs/KviKvsCoreFunctions_sz.cpp b/src/kvirc/kvs/KviKvsCoreFunctions_sz.cpp
index ae230cbfd..e6240a44a 100644
--- a/src/kvirc/kvs/KviKvsCoreFunctions_sz.cpp
+++ b/src/kvirc/kvs/KviKvsCoreFunctions_sz.cpp
@@ -83,7 +83,7 @@ namespace KviKvsCoreFunctions
Returns the actual script context's name. Useful only for custom debug.
@seealso:
[cmd]debug[/cmd]
-*/
+ */
KVSCF(scriptContextName)
{
diff --git a/src/kvirc/kvs/KviKvsCoreSimpleCommands_af.cpp b/src/kvirc/kvs/KviKvsCoreSimpleCommands_af.cpp
index 292f0edc4..d36961e6f 100644
--- a/src/kvirc/kvs/KviKvsCoreSimpleCommands_af.cpp
+++ b/src/kvirc/kvs/KviKvsCoreSimpleCommands_af.cpp
@@ -513,10 +513,10 @@ namespace KviKvsCoreSimpleCommands
that implement the CAP capability.
@examples:
[example]
- cap LS
- cap REQ identify-msg
- cap LIST
- cap REQ -identify-msg
+ cap LS
+ cap REQ identify-msg
+ cap LIST
+ cap REQ -identify-msg
[/example]
*/
@@ -568,7 +568,7 @@ namespace KviKvsCoreSimpleCommands
This command is [doc:connection_dependent_commands]connection dependent[/doc].
@examples:
[example]
- chanadmin Pragma,Crocodile
+ chanadmin Pragma,Crocodile
[/example]
@seealso:
[cmd]chanowner[/cmd], [cmd]dechanowner[/cmd], [cmd]dechanadmin[/cmd], [cmd]op[/cmd], [cmd]deop[/cmd], [cmd]halfop[/cmd], [cmd]dehalfop[/cmd], [cmd]voice[/cmd], [cmd]devoice[/cmd], [cmd]userop[/cmd], [cmd]deuserop[/cmd]
@@ -598,7 +598,7 @@ namespace KviKvsCoreSimpleCommands
This command is [doc:connection_dependent_commands]connection dependent[/doc].
@examples:
[example]
- chanowner Pragma,Crocodile
+ chanowner Pragma,Crocodile
[/example]
@seealso:
[cmd]dechanowner[/cmd], [cmd]chanadmin[/cmd], [cmd]dechanadmin[/cmd], [cmd]op[/cmd], [cmd]deop[/cmd], [cmd]halfop[/cmd], [cmd]dehalfop[/cmd], [cmd]voice[/cmd], [cmd]devoice[/cmd], [cmd]userop[/cmd], [cmd]deuserop[/cmd]
@@ -650,7 +650,7 @@ namespace KviKvsCoreSimpleCommands
This command is [doc:connection_dependent_commands]connection dependent[/doc].[br]
@examples:
[example]
- ctcp Pragma VERSION
+ ctcp Pragma VERSION
[/example]
*/
@@ -742,7 +742,7 @@ namespace KviKvsCoreSimpleCommands
This command is [doc:connection_dependent_commands]connection dependent[/doc].
@examples:
[example]
- dechanadmin Pragma,Crocodile
+ dechanadmin Pragma,Crocodile
[/example]
@seealso:
[cmd]chanowner[/cmd], [cmd]dechanowner[/cmd], [cmd]chanadmin[/cmd], [cmd]op[/cmd], [cmd]deop[/cmd], [cmd]halfop[/cmd], [cmd]dehalfop[/cmd], [cmd]voice[/cmd], [cmd]devoice[/cmd], [cmd]userop[/cmd], [cmd]deuserop[/cmd]
@@ -772,7 +772,7 @@ namespace KviKvsCoreSimpleCommands
This command is [doc:connection_dependent_commands]connection dependent[/doc].
@examples:
[example]
- dechanowner Pragma,Crocodile
+ dechanowner Pragma,Crocodile
[/example]
@seealso:
[cmd]chanowner[/cmd], [cmd]chanadmin[/cmd], [cmd]dechanadmin[/cmd], [cmd]op[/cmd], [cmd]deop[/cmd], [cmd]halfop[/cmd], [cmd]dehalfop[/cmd], [cmd]voice[/cmd], [cmd]devoice[/cmd], [cmd]userop[/cmd], [cmd]deuserop[/cmd]
@@ -802,7 +802,7 @@ namespace KviKvsCoreSimpleCommands
This command is [doc:connection_dependent_commands]connection dependent[/doc].
@examples:
[example]
- dehalfop Pragma,Crocodile
+ dehalfop Pragma,Crocodile
[/example]
@seealso:
[cmd]op[/cmd], [cmd]deop[/cmd], [cmd]halfop[/cmd], [cmd]voice[/cmd], [cmd]devoice[/cmd]
@@ -1086,8 +1086,8 @@ namespace KviKvsCoreSimpleCommands
or not timestamp at all.[br]
@examples:
[example]
- echo Hey! this is my first echo test!
- echo -i=[fnc]$msgtype[/fnc](parsererror) this has the colors of the parser error messages
+ echo Hey! this is my first echo test!
+ echo -i=[fnc]$msgtype[/fnc](parsererror) this has the colors of the parser error messages
[/example]
@seealso:
[fnc]$window[/fnc],
@@ -1200,8 +1200,8 @@ namespace KviKvsCoreSimpleCommands
The KVIrc view widgets support clickable sockets that can be realized by using special [doc:escape_sequences]escape sequences[/doc].[br]
@examples:
[example]
- echoprivmsg Test * * This is a test message
- echoprivmsg -i=$msgtype(ChanPrivmsgCrypted) Pragma pragma staff.kvirc.net Hi people! :)
+ echoprivmsg Test * * This is a test message
+ echoprivmsg -i=$msgtype(ChanPrivmsgCrypted) Pragma pragma staff.kvirc.net Hi people! :)
[/example]
@seealso:
[fnc]$window[/fnc],
@@ -1562,7 +1562,7 @@ namespace KviKvsCoreSimpleCommands
@short:
Closes KVIrc
@description:
- It closes KVIrc application
+ It closes the KVIrc application
*/
KVSCSC(exit)
diff --git a/src/kvirc/kvs/KviKvsCoreSimpleCommands_gl.cpp b/src/kvirc/kvs/KviKvsCoreSimpleCommands_gl.cpp
index 89ccc9300..99c1a4054 100644
--- a/src/kvirc/kvs/KviKvsCoreSimpleCommands_gl.cpp
+++ b/src/kvirc/kvs/KviKvsCoreSimpleCommands_gl.cpp
@@ -270,8 +270,8 @@ namespace KviKvsCoreSimpleCommands
the socketspy window (if open). The -q switch suppresses only the console warnings.
@examples:
[example]
- [comment]Injects the string as we were sending a query message[/comment][br]
- inject :foo!bar@foobar PRIVMSG HelLViS69 :message
+ [comment]Injects the string as we were sending a query message[/comment][br]
+ inject :foo!bar@foobar PRIVMSG HelLViS69 :message
[/example]
*/
@@ -374,8 +374,8 @@ namespace KviKvsCoreSimpleCommands
This command is [doc:connection_dependent_commands]connection dependent[/doc].[br]
@examples:
[example]
- join #kvirc
- join #linux-it,#xmms,#kde linus
+ join #kvirc
+ join #linux-it,#xmms,#kde linus
[/example]
*/
@@ -446,7 +446,7 @@ namespace KviKvsCoreSimpleCommands
This command is [doc:connection_dependent_commands]connection dependent[/doc].
@examples:
[example]
- kick Pragma Go coding in Pascal!
+ kick Pragma Go coding in Pascal!
[/example]
*/
diff --git a/src/modules/help/libkvihelp.cpp b/src/modules/help/libkvihelp.cpp
index d526c77a5..03dc93b3a 100644
--- a/src/modules/help/libkvihelp.cpp
+++ b/src/modules/help/libkvihelp.cpp
@@ -72,11 +72,11 @@ KviPointerList<HelpWindow> * g_pHelpWindowList = nullptr;
if there are other help browsers already open.[br]
@examples:
[example]
- help.open /home/pragma/myfile.html //absolute path
- help.open cmd_snd.play.html //relative path
- help.open "Binding operator" //keyword search, remember quoting
- help.open OnNickServAuth //keyword search for an event
- help.open \$my.user //keyword search, $ needs to be escaped
+ help.open /home/pragma/myfile.html //absolute path
+ help.open cmd_snd.play.html //relative path
+ help.open "Binding operator" //keyword search, remember quoting
+ help.open OnNickServAuth //keyword search for an event
+ help.open \$my.user //keyword search, $ needs to be escaped
[/example]
*/
diff --git a/src/modules/http/libkvihttp.cpp b/src/modules/http/libkvihttp.cpp
index 0db294d0a..fe490646f 100644
--- a/src/modules/http/libkvihttp.cpp
+++ b/src/modules/http/libkvihttp.cpp
@@ -193,7 +193,7 @@ static bool http_kvs_complete_get(KviKvsModuleCommandCall * c, QString & szUrl,
Don't show the save file dialog but determine automatically a file name.
The file is put in the KVIrc incoming directory and the file name
is the processed URL.[br]
-
+ [br]
!sw: -e=<existing_file_action> | --existing-file-action=<existing_file_action>
Specifies the action to be taken when the local file already exists.[br]
The action can be one of "i","e","o" or "r".[br]
@@ -203,7 +203,7 @@ static bool http_kvs_complete_get(KviKvsModuleCommandCall * c, QString & szUrl,
"o" causes the existing file to be overwritten and "r" will attempt to resume
a interrupted transfer.[br]
The default is to rename the incoming file.[br]
-
+ [br]
!sw: -m=<max_content_length> | --max-len=<max_content_length>
Causes content longer than <max_content_length> to be discarded.[br]
This is mainly to prevent you from automatically downloading 300 MiB files
@@ -213,7 +213,7 @@ static bool http_kvs_complete_get(KviKvsModuleCommandCall * c, QString & szUrl,
If the Content-length header is missing then the transfer is interrupted when
the received data length exceeds <max_content_length>.[br]
-m=0 means "accept any content length" (which is the default).[br]
-
+ [br]
!sw: -o=<content_offset> | --offset=<content_offset>
Causes the download to start from position <content offset>.[br]
This can be used to download only a part of the file starting at byte <content_offset>.[br]
@@ -223,18 +223,18 @@ static bool http_kvs_complete_get(KviKvsModuleCommandCall * c, QString & szUrl,
and -e=r then the file will be resumed, the transfer will start at the specified offset
and the received stream will be appended to the existing file.(avoid it unless you know what you're doing:
it's easy to download broken files).[br]
-
+ [br]
!sw: -t=<timeout_in_seconds> | --timeout=<timeout_in_seconds>
Changes the default connection timeout to the <timeout_in_seconds>.
A connection stuck for more than <timeout_in_seconds> seconds will be simply aborted.
The default timeout is 60 seconds and is appropriate for most operations. Use with care.[br]
-
+ [br]
!sw: -h | --head
Causes the connection to use the HTTP HEAD method that effectively
does not transfer real data. The server sends only the response headers.
This might be used in conjunction with the -v option to print the headers to the
active window.[br]
-
+ [br]
!sw: -w=<flags> | --winctrl
This switch controls the creation and visualization of the transfer window.
<flags> can be any combination of 'm','n' and 'h'.
@@ -242,25 +242,25 @@ static bool http_kvs_complete_get(KviKvsModuleCommandCall * c, QString & szUrl,
Note that with 'h' the user has no possibility to interact with the transfer.
The 'm' flag causes the transfer window to be created as "minimized". 'm' does nothing
if the window already exists. The 'n' flag causes the window to be [b]not[/b] activated (brought to top).
-
+ [br]
!sw: -i=<magic identifier> | --identifier=<magic identifier>
This identifier is passed as $3 parameter to the [event:OnHTTPGetTerminated]OnHTTPGetTerminated[/event]
when this transfer terminates. If this switch is not present then an empty string is used.
With [cmd]http.asyncGet[/cmd] this parameter is passed to the callback command instead.
-
+ [br]
!sw: -p=<post data> | --post-data=<post data>
The request is sent in form of a POST request. <post data> is the urlencoded payload of
the request. -p is incompatible with -h.
-
+ [br]
!sw: -q | --quiet
Do not notify download completion in the notifier window nor in the console.
-
+ [br]
!sw: -y | --no-output
Suppress any output in the file transfer window. This will effectively disable
the file transfer window highlighting (so the user will not be alerted by a failed
download unless he's really watching the window). This is useful when you're notifying
failures in some other way...
-
+ [br]
!sw: -c | --clear
Automatically remove the transfer from the transfer list when terminated
@seealso: