author | zecke <zecke> | 2003-04-16 10:59:24 (UTC) |
---|---|---|
committer | zecke <zecke> | 2003-04-16 10:59:24 (UTC) |
commit | 5b9d1ddde859ff783f95babf1887fa40e6bfe0be (patch) (side-by-side diff) | |
tree | 0a8596c4de5145e5f469a6c0d8dbd2f946ef0817 /libopie/oprocess.h | |
parent | eeb29547890a2d162de66d7d5b98d3840a7e2d79 (diff) | |
download | opie-5b9d1ddde859ff783f95babf1887fa40e6bfe0be.zip opie-5b9d1ddde859ff783f95babf1887fa40e6bfe0be.tar.gz opie-5b9d1ddde859ff783f95babf1887fa40e6bfe0be.tar.bz2 |
API docu fixes...
if using \fn infront of a function make sure to name the right function
ljp please see my comment in oticker about constness
-rw-r--r-- | libopie/oprocess.h | 24 |
1 files changed, 15 insertions, 9 deletions
diff --git a/libopie/oprocess.h b/libopie/oprocess.h index bf5fe0e..f2853b0 100644 --- a/libopie/oprocess.h +++ b/libopie/oprocess.h @@ -47,5 +47,5 @@ class OProcessPrivate; * @sect General usage and features * - *This class allows a KDE application to start child processes without having + *This class allows a KDE and OPIE application to start child processes without having *to worry about UN*X signal handling issues and zombie process reaping. * @@ -189,5 +189,11 @@ public: */ OProcess(QObject *parent = 0, const char *name = 0); + /** + * Constructor + */ OProcess(const QString &arg0, QObject *parent = 0, const char *name = 0); + /** + * Constructor + */ OProcess(const QStringList &args, QObject *parent = 0, const char *name = 0); @@ -411,5 +417,5 @@ public: */ bool runPrivileged() const; - + /** * Modifies the environment of the process to be started. @@ -419,5 +425,5 @@ public: /** - * Changes the current working directory (CWD) of the process + * Changes the current working directory (CWD) of the process * to be started. * This function must be called before starting the process. @@ -453,5 +459,5 @@ public: * child process. */ - void detach(); + void detach(); @@ -487,6 +493,6 @@ signals: * been received on stdout. * - * To actually get these signals, the respective communications link - * (stdout/stderr) has to be turned on in @ref start() and the + * To actually get these signals, the respective communications link + * (stdout/stderr) has to be turned on in @ref start() and the * @p NoRead flag should have been passed. * @@ -495,5 +501,5 @@ signals: * to ensure that this signal is not emitted when no one is connected * to it, otherwise this signal will not be emitted. - * + * * The data still has to be read from file descriptor @p fd. **/ @@ -551,5 +557,5 @@ protected: /** - * Sets up the environment according to the data passed via + * Sets up the environment according to the data passed via * setEnvironment(...) */ @@ -713,5 +719,5 @@ protected: private: /** - * Searches for a valid shell. + * Searches for a valid shell. * Here is the algorithm used for finding an executable shell: * |