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,6 +41,26 @@
#include <QtCore/QTimer>
/*!
\class SshRemoteProcess
\brief This class implements an SSH channel for running a remote process.
Objects are created via SshConnection::createRemoteProcess.
The process is started via the start() member function.
A closeChannel() function is provided, but rarely useful, because
\list
\i a) when the process ends, the channel is closed automatically, and
\i b) closing a channel will not necessarily kill the remote process.
\endlist
Therefore, the only sensible use case for calling closeChannel() is to
get rid of an SshRemoteProces object before the process is actually started.
Note that the process does not have a terminal, so you can't use it
for applications that require one.
*/
namespace Utils {
const QByteArray SshRemoteProcess::AbrtSignal("ABRT");