summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--include/mts/MTS_System.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/include/mts/MTS_System.h b/include/mts/MTS_System.h
index cd9b9dd..d51a5ea 100644
--- a/include/mts/MTS_System.h
+++ b/include/mts/MTS_System.h
@@ -84,10 +84,11 @@ namespace MTS {
* list of arguments bypasing the system shell. If succeded, information about the spawned
* process is written to the \p child structure.
*
- * \param cmd name of the application to be executed
- * \param argv vector of arguments (excluding argument zero)
- * \param type open pipe for read from child or write to child
- * \return true on success, false on failure
+ * \param cmd name of the application to be executed
+ * \param argv vector of arguments (excluding argument zero)
+ * \param type open pipe for read from child or write to child
+ * \param child on success is populated with child process information, on failure is not defined
+ * \return true on success, false on failure
*/
static bool executeBackground(const std::string& cmd, const std::vector<std::string>& argv, PipeType type, ChildHandle& child);