diff options
author | Bernd Weimer <bernd.weimer@pelagicore.com> | 2019-09-25 11:18:08 +0200 |
---|---|---|
committer | Bernd Weimer <bernd.weimer@pelagicore.com> | 2019-09-25 18:59:30 +0200 |
commit | 5f05117fb8c31ad58937d6b5bd55139a697c2673 (patch) | |
tree | c2901f3121dee0baf8b92abf08ade4d0fdcdaa67 /src/plugin-interfaces/containerinterface.cpp | |
parent | ea7811529421975182f3de519da36ea610844eb9 (diff) |
Fix issues in container documentation
Change-Id: I2c0fd0ec92cc06475b37ee157f95f2bff8a1c851
Reviewed-by: Kavindra Palaraja <kpalaraja@luxoft.com>
Diffstat (limited to 'src/plugin-interfaces/containerinterface.cpp')
-rw-r--r-- | src/plugin-interfaces/containerinterface.cpp | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/src/plugin-interfaces/containerinterface.cpp b/src/plugin-interfaces/containerinterface.cpp index d5009720..0415f5d8 100644 --- a/src/plugin-interfaces/containerinterface.cpp +++ b/src/plugin-interfaces/containerinterface.cpp @@ -300,8 +300,9 @@ ContainerManagerInterface::~ContainerManagerInterface() { } The application-manager will only ever call this function once for any given instance. This function should return \c true in case it succeeded or \c false otherwise. In case it - returns \c true, the implementation needs to either emit the started() or errorOccurred() signal - (can be delayed) in response to this call. + returns \c true, the implementation needs to either emit the started() or + \l{QProcess::errorOccurred()}{errorOccurred()} signal (can be delayed) in response to this + call. \sa QProcess::start() */ @@ -330,7 +331,7 @@ ContainerManagerInterface::~ContainerManagerInterface() { } /*! \fn void ContainerInterface::kill() - Called by the application-manager, if it wants to kills the current process within the + Called by the application-manager, if it wants to kill the current process within the container, causing it to exit immediately. On Unix, the equivalent would be sending a \c SIGKILL signal. @@ -435,6 +436,6 @@ ContainerManagerInterface::~ContainerManagerInterface() { } In case the \a debugWrapperCommand is not empty, the plugin is requested to execute the binary set by ContainterInterface::setProgram using this debug-wrapper. The plugin is responsible for - combining both and by handling the replacement of \c{%program%} and \c{%arguments%}. See the + combining both and for handling the replacement of \c{%program%} and \c{%arguments%}. See the \l{DebugWrappers} {debug-wrapper documentation} for more information. */ |