API-Documentation: Add the Utils-library.

Fix API after doc template change.
This commit is contained in:
Friedemann Kleint
2011-03-02 17:13:33 +01:00
parent b37cd3325c
commit 505256fab9
63 changed files with 458 additions and 301 deletions

View File

@@ -41,8 +41,32 @@
#include <QtCore/QDir>
#include <QtCore/QFile>
namespace Utils {
/*!
\class Utils::SftpChannel
\brief This class provides SFTP operations.
Objects are created via SshConnection::createSftpChannel().
The channel needs to be initialized with
a call to initialize() and is closed via closeChannel(). After closing
a channel, no more operations are possible. It cannot be re-opened
using initialize(); use SshConnection::createSftpChannel() if you need
a new one.
After the initialized() signal has been emitted, operations can be started.
All SFTP operations are asynchronous (non-blocking) and can be in-flight
simultaneously (though callers must ensure that concurrently running jobs
are independent of each other, e.g. they must not write to the same file).
Operations are identified by their job id, which is returned by
the respective member function. If the function can right away detect that
the operation cannot succeed, it returns SftpInvalidJob. If an error occurs
later, the finished() signal is emitted for the respective job with a
non-empty error string.
Note that directory names must not have a trailing slash.
*/
namespace Utils {
namespace Internal {
namespace {
const quint32 ProtocolVersion = 3;