kio: documentation updates

Signed-off-by: Ivailo Monev <xakepa10@gmail.com>
This commit is contained in:
Ivailo Monev 2024-03-29 10:15:33 +02:00
parent 08a76dd091
commit f1521944ed
3 changed files with 5 additions and 7 deletions

View file

@ -127,7 +127,7 @@ namespace KIO {
// (2) The actual protocol that the io-slave uses.
//
// These two often match, but not necessarily. Most notably, they don't
// match when doing ftp via a proxy.
// match when a slave is used for more than one protocol (e.g. curl).
// In that case (1) is ftp, but (2) is http.
//
// JobData::protocol stores (2) while Job::url().protocol() returns (1).

View file

@ -40,12 +40,11 @@ namespace KIO
* Provides information about I/O (Internet, etc.) settings chosen/set by the end user.
*
* KProtocolManager has a heap of static functions that allows only read access to KDE's IO related
* settings. These include proxy, file transfer resumption, timeout and user-agent related
* settings.
* settings. These file transfer resumption, timeout and user-agent related settings.
*
* The information provided by this class is generic enough to be applicable to any application
* that makes use of KDE's IO sub-system. Note that this mean the proxy, timeout etc. settings
* are saved in a separate user-specific config file and not in the config file of the application.
* that makes use of KDE's IO sub-system. Note that this mean the timeout etc. settings are saved
* in a separate user-specific config file and not in the config file of the application.
*
* Original author:
* @author Torben Weis <weis@kde.org>

View file

@ -483,7 +483,6 @@ public:
/**
* Used for any command that is specific to this slave (protocol)
* Examples are : HTTP POST, mount and unmount (kio_file)
*
* @param data packed data; the meaning is completely dependent on the
* slave, but usually starts with an int for the command number.
@ -493,7 +492,7 @@ public:
/**
* Called by the scheduler to tell the slave that the configuration
* changed (i.e. proxy settings) .
* changed (i.e. timeout settings) .
*/
virtual void reparseConfiguration();