From fdaf38800d73f09ed053af0e70e64a9ec17a42f1 Mon Sep 17 00:00:00 2001 From: LoRd_MuldeR Date: Sat, 7 Jan 2017 18:40:46 +0100 Subject: [PATCH] Some documentation updates. --- docs/annotated.html | 2 +- .../d08/class_m_utils_1_1_job_object-members.html | 10 +- docs/d2/d13/_startup_8h_source.html | 2 +- docs/d3/da6/namespace_m_utils.html | 1 + docs/d4/d85/_job_object_8h.html | 104 ++++++++++++++ docs/d4/d85/_job_object_8h_source.html | 4 +- docs/dc/dd3/class_m_utils_1_1_job_object.html | 149 ++++++++++++++++++++- docs/dir_b076b53667bc06ebb413a190e197fc7b.html | 3 + docs/files.html | 2 +- docs/functions.html | 15 +++ docs/functions_func.html | 15 +++ docs/hierarchy.html | 2 +- docs/index.html | 1 + docs/search/all_1.js | 1 + docs/search/all_13.html | 26 ++++ docs/search/all_13.js | 4 + docs/search/all_8.js | 3 +- docs/search/all_9.js | 4 +- docs/search/all_f.js | 1 + docs/search/files_3.html | 26 ++++ docs/search/files_3.js | 4 + docs/search/functions_0.js | 1 + docs/search/functions_3.js | 3 +- docs/search/functions_4.js | 3 +- docs/search/functions_5.js | 6 +- docs/search/functions_6.js | 5 +- docs/search/functions_7.js | 4 +- docs/search/functions_8.js | 6 +- docs/search/functions_9.js | 5 +- docs/search/functions_a.html | 26 ++++ docs/search/functions_a.js | 4 + docs/search/functions_b.html | 26 ++++ docs/search/functions_b.js | 4 + docs/search/searchdata.js | 6 +- include/MUtils/JobObject.h | 54 ++++++++ include/MUtilsInfo.dox | 1 + 36 files changed, 496 insertions(+), 37 deletions(-) create mode 100644 docs/d4/d85/_job_object_8h.html create mode 100644 docs/search/all_13.html create mode 100644 docs/search/all_13.js create mode 100644 docs/search/files_3.html create mode 100644 docs/search/files_3.js create mode 100644 docs/search/functions_a.html create mode 100644 docs/search/functions_a.js create mode 100644 docs/search/functions_b.html create mode 100644 docs/search/functions_b.js diff --git a/docs/annotated.html b/docs/annotated.html index 5c17dd8..88491a3 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -76,7 +76,7 @@ $(function() {  ▼NRegistry  CRegistryKey  CIPCChannel - CJobObject + CJobObjectThis class represents a job object  CTaskbar7  CUpdateChecker  CUpdateCheckerInfo diff --git a/docs/d1/d08/class_m_utils_1_1_job_object-members.html b/docs/d1/d08/class_m_utils_1_1_job_object-members.html index ee3bfe0..69e3c6c 100644 --- a/docs/d1/d08/class_m_utils_1_1_job_object-members.html +++ b/docs/d1/d08/class_m_utils_1_1_job_object-members.html @@ -70,11 +70,11 @@ $(function() {

This is the complete list of members for MUtils::JobObject, including all inherited members.

- - - - - + + + + +
addProcessToJob(const QProcess *const process) (defined in MUtils::JobObject)MUtils::JobObject
isObjectCreated(void) (defined in MUtils::JobObject)MUtils::JobObject
JobObject(void) (defined in MUtils::JobObject)MUtils::JobObject
terminateJob(const quint32 &exitCode) (defined in MUtils::JobObject)MUtils::JobObject
~JobObject(void) (defined in MUtils::JobObject)MUtils::JobObject
addProcessToJob(const QProcess *const process)MUtils::JobObject
isObjectCreated(void)MUtils::JobObject
JobObject(void)MUtils::JobObject
terminateJob(const quint32 &exitCode)MUtils::JobObject
~JobObject(void)MUtils::JobObject
diff --git a/docs/d2/d13/_startup_8h_source.html b/docs/d2/d13/_startup_8h_source.html index d57bfc3..39b5f1b 100644 --- a/docs/d2/d13/_startup_8h_source.html +++ b/docs/d2/d13/_startup_8h_source.html @@ -67,7 +67,7 @@ $(function() {
Startup.h
-
1 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2017 LoRd_MuldeR <MuldeR2@GMX.de>
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 //
19 // http://www.gnu.org/licenses/lgpl-2.1.txt
21 
22 #pragma once
23 
24 //MUtils
25 #include <MUtils/Global.h>
26 
27 //Forward Declarations
28 class QApplication;
29 
31 
32 namespace MUtils
33 {
34  namespace Startup
35  {
36  //Main Function
37  typedef int (main_function_t)(int &argc, char **argv);
38 
39  //Startup Application
40  MUTILS_API int startup(int &argc, char **argv, main_function_t *const entry_point, const char* const appName, const bool &debugConsole);
41 
42  //Initialize Qt
43  MUTILS_API QApplication *create_qt(int &argc, char **argv, const QString &appName);
44  }
45 }
46 
Global.h
This file contains miscellaneous functions that are generally useful for Qt-based applications...
+
1 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2017 LoRd_MuldeR <MuldeR2@GMX.de>
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 //
19 // http://www.gnu.org/licenses/lgpl-2.1.txt
21 
22 #pragma once
23 
24 //MUtils
25 #include <MUtils/Global.h>
26 
27 //Forward Declarations
28 class QApplication;
29 
31 
32 namespace MUtils
33 {
34  namespace Startup
35  {
36  //Main Function
37  typedef int (main_function_t)(int &argc, char **argv);
38 
39  //Startup Application
40  MUTILS_API int startup(int &argc, char **argv, main_function_t *const entry_point, const char* const appName, const bool &debugConsole);
41 
42  //Initialize Qt
43  MUTILS_API QApplication *create_qt(int &argc, char **argv, const QString &appName, const QString &appAuthor = QLatin1String("LoRd_MuldeR"), const QString &appDomain = QLatin1String("muldersoft.com"));
44  }
45 }
46 
Global.h
This file contains miscellaneous functions that are generally useful for Qt-based applications...
MUtils
Global MUtils namespace.
Definition: CPUFeatures.h:37
diff --git a/docs/d3/da6/namespace_m_utils.html b/docs/d3/da6/namespace_m_utils.html index ee3f6f1..ff31992 100644 --- a/docs/d3/da6/namespace_m_utils.html +++ b/docs/d3/da6/namespace_m_utils.html @@ -83,6 +83,7 @@ Classes class  IPCChannel   class  JobObject + This class represents a job object. More...
  class  Taskbar7   diff --git a/docs/d4/d85/_job_object_8h.html b/docs/d4/d85/_job_object_8h.html new file mode 100644 index 0000000..546f45c --- /dev/null +++ b/docs/d4/d85/_job_object_8h.html @@ -0,0 +1,104 @@ + + + + + + + +MuldeR's Utilities for Qt: include/MUtils/JobObject.h File Reference + + + + + + + + + +
+
+ + + + + + +
+
MuldeR's Utilities for Qt +
+
MUtilities
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Classes | +Namespaces
+
+
JobObject.h File Reference
+
+
+ +

This file contains function for creating and managing job objects. +More...

+
#include <MUtils/Global.h>
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  MUtils::JobObject
 This class represents a job object. More...
 
+ + + + +

+Namespaces

 MUtils
 Global MUtils namespace.
 
+

Detailed Description

+

This file contains function for creating and managing job objects.

+

Each instance of MUtils::JobObject represents a job object. Call MUtils::JobObject::addProcessToJob() to add another sub-process to the job object. Call MUtils::JobObject::terminateJob() to terminate all sub-processes that currently belong to the job object at once.

+

Note that all sub-processes that belong to the job object will be terminated when this process exits, gracefully or due to a crash. All sub-process belonging to a job object also are terminated when the corresponding MUtils::JobObject instance is destroyed.

+
+ +
+Generated by   +doxygen + 1.8.12 +
+ + diff --git a/docs/d4/d85/_job_object_8h_source.html b/docs/d4/d85/_job_object_8h_source.html index 5404730..680e9bf 100644 --- a/docs/d4/d85/_job_object_8h_source.html +++ b/docs/d4/d85/_job_object_8h_source.html @@ -67,8 +67,8 @@ $(function() {
JobObject.h
-
1 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2017 LoRd_MuldeR <MuldeR2@GMX.de>
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 //
19 // http://www.gnu.org/licenses/lgpl-2.1.txt
21 
22 #pragma once
23 
24 #include <MUtils/Global.h>
25 
26 class QProcess;
27 
28 namespace MUtils
29 {
30  class MUTILS_API JobObject
31  {
32  public:
33  JobObject(void);
34  ~JobObject(void);
35 
36  bool isObjectCreated(void);
37  bool addProcessToJob(const QProcess *const process);
38  bool terminateJob(const quint32 &exitCode);
39 
40  private:
41  uintptr_t m_jobPtr;
42  MUTILS_NO_COPY(JobObject)
43  };
44 }
Global.h
This file contains miscellaneous functions that are generally useful for Qt-based applications...
-
MUtils::JobObject
Definition: JobObject.h:30
+Go to the documentation of this file.
1 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2017 LoRd_MuldeR <MuldeR2@GMX.de>
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 //
19 // http://www.gnu.org/licenses/lgpl-2.1.txt
21 
31 #pragma once
32 
33 #include <MUtils/Global.h>
34 
35 class QProcess;
36 
37 namespace MUtils
38 {
46  class MUTILS_API JobObject
47  {
48  public:
54  JobObject(void);
55 
61  ~JobObject(void);
62 
70  bool isObjectCreated(void);
71 
81  bool addProcessToJob(const QProcess *const process);
82 
92  bool terminateJob(const quint32 &exitCode);
93 
94  private:
95  uintptr_t m_jobPtr;
96  MUTILS_NO_COPY(JobObject)
97  };
98 }
Global.h
This file contains miscellaneous functions that are generally useful for Qt-based applications...
+
MUtils::JobObject
This class represents a job object.
Definition: JobObject.h:46
MUtils
Global MUtils namespace.
Definition: CPUFeatures.h:37
MUTILS_NO_COPY
#define MUTILS_NO_COPY(CLASS)
Disables copy constructor and assignment operator in the specified class. This macro should be used i...
Definition: Global.h:362
diff --git a/docs/dc/dd3/class_m_utils_1_1_job_object.html b/docs/dc/dd3/class_m_utils_1_1_job_object.html index 73a8095..d7327db 100644 --- a/docs/dc/dd3/class_m_utils_1_1_job_object.html +++ b/docs/dc/dd3/class_m_utils_1_1_job_object.html @@ -70,19 +70,156 @@ $(function() {
MUtils::JobObject Class Reference
+ +

This class represents a job object. + More...

+ +

#include <JobObject.h>

- + + + + + + + + - + + - + +

Public Member Functions

-bool isObjectCreated (void)
 JobObject (void)
 Create a new JobObject instance. More...
 
 ~JobObject (void)
 Destroys the JobObject instance. More...
 
bool isObjectCreated (void)
 Test whether job object was created successfully. More...
 
-bool addProcessToJob (const QProcess *const process)
bool addProcessToJob (const QProcess *const process)
 Add a process to the job object. More...
 
-bool terminateJob (const quint32 &exitCode)
bool terminateJob (const quint32 &exitCode)
 Terminate all sub-processes of the job object. More...
 
+

Detailed Description

+

This class represents a job object.

+

Call addProcessToJob() to add another sub-process to this job object. Call terminateJob() to terminate all sub-processes that belong to this job object. Note that all sub-processes that belong to this job object will also be terminated when this process exits, gracefully or due to a crash.

+

Also, when the JobObject instance is destroyed, all sub-process that belong to its corresponding job object and that are still running will be terminated!

+

Constructor & Destructor Documentation

+ +

§ JobObject()

+ +
+
+ + + + + + + + +
MUtils::JobObject::JobObject (void )
+
+ +

Create a new JobObject instance.

+

Creating a new JobObject instance automatically creates a new job object on the system-level. Check isObjectCreated() to test whether the job object was successfully created or not.

+ +
+
+ +

§ ~JobObject()

+ +
+
+ + + + + + + + +
MUtils::JobObject::~JobObject (void )
+
+ +

Destroys the JobObject instance.

+

If the job object still has any running sub-processes left when the corresponding JobObject instance is destroyed, these sub-process are terminated!

+ +
+
+

Member Function Documentation

+ +

§ addProcessToJob()

+ +
+
+ + + + + + + + +
bool MUtils::JobObject::addProcessToJob (const QProcess *const process)
+
+ +

Add a process to the job object.

+

This function adds a another sub-process to the job object that is represented by this JobObject instance. Job object limitations apply to the sub-process a

+
Parameters
+ + +
processA read-only pointer to the QProcess object that represents the sub-process to be added to the job object. The sub-process must be in the "running" state; otherwise the function will fail.
+
+
+
Returns
The function returns true, if and only if the process was successfully added to the job object; otherwise it returns false.
+ +
+
+ +

§ isObjectCreated()

+ +
+
+ + + + + + + + +
bool MUtils::JobObject::isObjectCreated (void )
+
+ +

Test whether job object was created successfully.

+

The job object will be created automatically when a new JobObject instance is created. However, the constructor has no to tell whether the job object was created successfully on the system-level. Call this function to test whether the job object has been created.

+
Returns
The function returns true, if and only if a job object was successfully created; otherwise it returns false.
+ +
+
+ +

§ terminateJob()

+ +
+
+ + + + + + + + +
bool MUtils::JobObject::terminateJob (const quint32 & exitCode)
+
+ +

Terminate all sub-processes of the job object.

+

This function immediately terminates all running sub-processes that belong to the job object represented by this JobObject instance at once.

+
Parameters
+ + +
exitCodeThe exit code to be set for the sub-process when they are terminated.
+
+
+
Returns
The function returns true, if the sub-processes were destroyed successfully, even if there were no running sub-process left; otherwise it returns false.
+ +
+
The documentation for this class was generated from the following file: diff --git a/docs/dir_b076b53667bc06ebb413a190e197fc7b.html b/docs/dir_b076b53667bc06ebb413a190e197fc7b.html index 93eb456..003379c 100644 --- a/docs/dir_b076b53667bc06ebb413a190e197fc7b.html +++ b/docs/dir_b076b53667bc06ebb413a190e197fc7b.html @@ -79,6 +79,9 @@ Files file  Hash.h [code]  This file contains function for cryptographic hash computation.
  +file  JobObject.h [code] + This file contains function for creating and managing job objects.
+ 
diff --git a/docs/files.html b/docs/files.html index 97c20a6..3be8164 100644 --- a/docs/files.html +++ b/docs/files.html @@ -74,7 +74,7 @@ $(function() {  GUI.h  Hash.hThis file contains function for cryptographic hash computation  IPCChannel.h - JobObject.h + JobObject.hThis file contains function for creating and managing job objects  OSSupport.h  Registry.h  Sound.h diff --git a/docs/functions.html b/docs/functions.html index 01730b7..d0e845a 100644 --- a/docs/functions.html +++ b/docs/functions.html @@ -60,6 +60,9 @@ $(function() {
Here is a list of all documented class members with links to the class documentation for each member:
diff --git a/docs/functions_func.html b/docs/functions_func.html index eabd5f0..2704eed 100644 --- a/docs/functions_func.html +++ b/docs/functions_func.html @@ -60,12 +60,27 @@ $(function() {
 
diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 6d3bd03..b92fa37 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -69,7 +69,7 @@ $(function() {  CMUtils::OS::Version::_os_version_t  CMUtils::Hash::HashThis abstract class specifies the generic interface for all support hash algorithms  CMUtils::IPCChannel - CMUtils::JobObject + CMUtils::JobObjectThis class represents a job object  ▼CQThread  CMUtils::UpdateChecker  CMUtils::Registry::RegistryKey diff --git a/docs/index.html b/docs/index.html index 56001ac..bef1b84 100644 --- a/docs/index.html +++ b/docs/index.html @@ -70,6 +70,7 @@ $(function() {
  • Global.h – miscellaneous useful functions
  • CPUFeatures.h – functions for detection information about the CPU
  • Hash.h – functions for cryptographic hash computation
    • +
  • JobObject.h – functions for creating and managing job objects

    • Example

    Here is a minimal example on how to use the MUtilities library in your project: 

    //MUtils
diff --git a/docs/search/all_1.js b/docs/search/all_1.js
index b41c51c..1b1214a 100644
--- a/docs/search/all_1.js
+++ b/docs/search/all_1.js
@@ -1,4 +1,5 @@
 var searchData=
 [
+  ['addprocesstojob',['addProcessToJob',['../dc/dd3/class_m_utils_1_1_job_object.html#a1ea821a376842494b0d0ef0b17bfaecc',1,'MUtils::JobObject']]],
   ['available_5fcodepages',['available_codepages',['../d3/da6/namespace_m_utils.html#a2275e64c3c74dea855c39b66be67f705',1,'MUtils']]]
 ];
diff --git a/docs/search/all_13.html b/docs/search/all_13.html
new file mode 100644
index 0000000..516a9b6
--- /dev/null
+++ b/docs/search/all_13.html
@@ -0,0 +1,26 @@
+
+
+
+
+
+
+
+
+
+
    
+
    Loading...
    
+
    
+
+
    Searching...
    
+
    No Matches
    
+
+
    
+
+
diff --git a/docs/search/all_13.js b/docs/search/all_13.js
new file mode 100644
index 0000000..f761a33
--- /dev/null
+++ b/docs/search/all_13.js
@@ -0,0 +1,4 @@
+var searchData=
+[
+  ['_7ejobobject',['~JobObject',['../dc/dd3/class_m_utils_1_1_job_object.html#a0e2d6461729d16b615548e7b1594c893',1,'MUtils::JobObject']]]
+];
diff --git a/docs/search/all_8.js b/docs/search/all_8.js
index 327b7eb..8f71d38 100644
--- a/docs/search/all_8.js
+++ b/docs/search/all_8.js
@@ -2,5 +2,6 @@ var searchData=
 [
   ['idstr',['idstr',['../dd/de2/struct_m_utils_1_1_c_p_u_fetaures_1_1__cpu__info__t.html#a58ab7955a771f842c3f16abd8cebb931',1,'MUtils::CPUFetaures::_cpu_info_t']]],
   ['init_5fprocess',['init_process',['../d3/da6/namespace_m_utils.html#a0ecb5d72f33a7b6feadd7deb8ed46cc3',1,'MUtils']]],
-  ['ipcchannel',['IPCChannel',['../d5/dfe/class_m_utils_1_1_i_p_c_channel.html',1,'MUtils']]]
+  ['ipcchannel',['IPCChannel',['../d5/dfe/class_m_utils_1_1_i_p_c_channel.html',1,'MUtils']]],
+  ['isobjectcreated',['isObjectCreated',['../dc/dd3/class_m_utils_1_1_job_object.html#a1d86b1a284da53bbcf92713d494c2304',1,'MUtils::JobObject']]]
 ];
diff --git a/docs/search/all_9.js b/docs/search/all_9.js
index e409b67..226103d 100644
--- a/docs/search/all_9.js
+++ b/docs/search/all_9.js
@@ -1,4 +1,6 @@
 var searchData=
 [
-  ['jobobject',['JobObject',['../dc/dd3/class_m_utils_1_1_job_object.html',1,'MUtils']]]
+  ['jobobject',['JobObject',['../dc/dd3/class_m_utils_1_1_job_object.html',1,'MUtils']]],
+  ['jobobject',['JobObject',['../dc/dd3/class_m_utils_1_1_job_object.html#a4ec8b0013bca35149def434b738d80fb',1,'MUtils::JobObject']]],
+  ['jobobject_2eh',['JobObject.h',['../d4/d85/_job_object_8h.html',1,'']]]
 ];
diff --git a/docs/search/all_f.js b/docs/search/all_f.js
index b0a2bec..994a96b 100644
--- a/docs/search/all_f.js
+++ b/docs/search/all_f.js
@@ -2,6 +2,7 @@ var searchData=
 [
   ['taskbar7',['Taskbar7',['../d2/d52/class_m_utils_1_1_taskbar7.html',1,'MUtils']]],
   ['temp_5ffolder',['temp_folder',['../d3/da6/namespace_m_utils.html#a3f198156e8be91f3e74dd9ed69ffaa34',1,'MUtils']]],
+  ['terminatejob',['terminateJob',['../dc/dd3/class_m_utils_1_1_job_object.html#abe785eacf0468533ca90c6f77d734cda',1,'MUtils::JobObject']]],
   ['trim_5fleft',['trim_left',['../d3/da6/namespace_m_utils.html#a20b8fc56856ee904caaded756399e705',1,'MUtils::trim_left(QString &str)'],['../d3/da6/namespace_m_utils.html#ae43bc17b6fa4ee2287099c4ae095483b',1,'MUtils::trim_left(const QString &str)']]],
   ['trim_5fright',['trim_right',['../d3/da6/namespace_m_utils.html#a6118cf23d2b771fae1ad159c7ea6686a',1,'MUtils::trim_right(QString &str)'],['../d3/da6/namespace_m_utils.html#a3bcb0fce5181ded3c54456379147009d',1,'MUtils::trim_right(const QString &str)']]]
 ];
diff --git a/docs/search/files_3.html b/docs/search/files_3.html
new file mode 100644
index 0000000..3442829
--- /dev/null
+++ b/docs/search/files_3.html
@@ -0,0 +1,26 @@
+
+
+
+
+
+
+
+
+
+
    
+
    Loading...
    
+
    
+
+
    Searching...
    
+
    No Matches
    
+
+
    
+
+
diff --git a/docs/search/files_3.js b/docs/search/files_3.js
new file mode 100644
index 0000000..dec9b11
--- /dev/null
+++ b/docs/search/files_3.js
@@ -0,0 +1,4 @@
+var searchData=
+[
+  ['jobobject_2eh',['JobObject.h',['../d4/d85/_job_object_8h.html',1,'']]]
+];
diff --git a/docs/search/functions_0.js b/docs/search/functions_0.js
index b41c51c..1b1214a 100644
--- a/docs/search/functions_0.js
+++ b/docs/search/functions_0.js
@@ -1,4 +1,5 @@
 var searchData=
 [
+  ['addprocesstojob',['addProcessToJob',['../dc/dd3/class_m_utils_1_1_job_object.html#a1ea821a376842494b0d0ef0b17bfaecc',1,'MUtils::JobObject']]],
   ['available_5fcodepages',['available_codepages',['../d3/da6/namespace_m_utils.html#a2275e64c3c74dea855c39b66be67f705',1,'MUtils']]]
 ];
diff --git a/docs/search/functions_3.js b/docs/search/functions_3.js
index 895c41d..edd0b20 100644
--- a/docs/search/functions_3.js
+++ b/docs/search/functions_3.js
@@ -1,4 +1,5 @@
 var searchData=
 [
-  ['init_5fprocess',['init_process',['../d3/da6/namespace_m_utils.html#a0ecb5d72f33a7b6feadd7deb8ed46cc3',1,'MUtils']]]
+  ['init_5fprocess',['init_process',['../d3/da6/namespace_m_utils.html#a0ecb5d72f33a7b6feadd7deb8ed46cc3',1,'MUtils']]],
+  ['isobjectcreated',['isObjectCreated',['../dc/dd3/class_m_utils_1_1_job_object.html#a1d86b1a284da53bbcf92713d494c2304',1,'MUtils::JobObject']]]
 ];
diff --git a/docs/search/functions_4.js b/docs/search/functions_4.js
index 041659c..156915e 100644
--- a/docs/search/functions_4.js
+++ b/docs/search/functions_4.js
@@ -1,5 +1,4 @@
 var searchData=
 [
-  ['make_5ftemp_5ffile',['make_temp_file',['../d3/da6/namespace_m_utils.html#a29461116550863e8730f3f4ec479bbcb',1,'MUtils']]],
-  ['make_5funique_5ffile',['make_unique_file',['../d3/da6/namespace_m_utils.html#af9afe3821ae9bef7bdf56a4183fdea0d',1,'MUtils']]]
+  ['jobobject',['JobObject',['../dc/dd3/class_m_utils_1_1_job_object.html#a4ec8b0013bca35149def434b738d80fb',1,'MUtils::JobObject']]]
 ];
diff --git a/docs/search/functions_5.js b/docs/search/functions_5.js
index ecffc94..041659c 100644
--- a/docs/search/functions_5.js
+++ b/docs/search/functions_5.js
@@ -1,7 +1,5 @@
 var searchData=
 [
-  ['natural_5fstring_5fsort',['natural_string_sort',['../d3/da6/namespace_m_utils.html#a4d4c545ea06892f6487f15a48808564f',1,'MUtils']]],
-  ['next_5frand_5fstr',['next_rand_str',['../d3/da6/namespace_m_utils.html#ac583617546d5ae100ce7436546d9662c',1,'MUtils']]],
-  ['next_5frand_5fu32',['next_rand_u32',['../d3/da6/namespace_m_utils.html#a1c9832c1d645a2c90e9bd52d57d843b3',1,'MUtils']]],
-  ['next_5frand_5fu64',['next_rand_u64',['../d3/da6/namespace_m_utils.html#ad7edd4aece64faf3aa16c9509243608c',1,'MUtils']]]
+  ['make_5ftemp_5ffile',['make_temp_file',['../d3/da6/namespace_m_utils.html#a29461116550863e8730f3f4ec479bbcb',1,'MUtils']]],
+  ['make_5funique_5ffile',['make_unique_file',['../d3/da6/namespace_m_utils.html#af9afe3821ae9bef7bdf56a4183fdea0d',1,'MUtils']]]
 ];
diff --git a/docs/search/functions_6.js b/docs/search/functions_6.js
index f923f06..ecffc94 100644
--- a/docs/search/functions_6.js
+++ b/docs/search/functions_6.js
@@ -1,4 +1,7 @@
 var searchData=
 [
-  ['parity',['parity',['../d3/da6/namespace_m_utils.html#aea4a212153b09b24b04f30ef5159f29b',1,'MUtils']]]
+  ['natural_5fstring_5fsort',['natural_string_sort',['../d3/da6/namespace_m_utils.html#a4d4c545ea06892f6487f15a48808564f',1,'MUtils']]],
+  ['next_5frand_5fstr',['next_rand_str',['../d3/da6/namespace_m_utils.html#ac583617546d5ae100ce7436546d9662c',1,'MUtils']]],
+  ['next_5frand_5fu32',['next_rand_u32',['../d3/da6/namespace_m_utils.html#a1c9832c1d645a2c90e9bd52d57d843b3',1,'MUtils']]],
+  ['next_5frand_5fu64',['next_rand_u64',['../d3/da6/namespace_m_utils.html#ad7edd4aece64faf3aa16c9509243608c',1,'MUtils']]]
 ];
diff --git a/docs/search/functions_7.js b/docs/search/functions_7.js
index 86f9020..f923f06 100644
--- a/docs/search/functions_7.js
+++ b/docs/search/functions_7.js
@@ -1,6 +1,4 @@
 var searchData=
 [
-  ['regexp_5fparse_5fuint32',['regexp_parse_uint32',['../d3/da6/namespace_m_utils.html#ad2a851b289ee66873d3a1ec86f5f34eb',1,'MUtils::regexp_parse_uint32(const QRegExp &regexp, quint32 &value)'],['../d3/da6/namespace_m_utils.html#a81704d66d34e37d3e0e159b5f436babf',1,'MUtils::regexp_parse_uint32(const QRegExp &regexp, quint32 *values, const size_t &count)']]],
-  ['remove_5fdirectory',['remove_directory',['../d3/da6/namespace_m_utils.html#a4d451ddc82668d1298f2922f62474b5d',1,'MUtils']]],
-  ['remove_5ffile',['remove_file',['../d3/da6/namespace_m_utils.html#a5a14e75627eebd09efc37898d74c5ac6',1,'MUtils']]]
+  ['parity',['parity',['../d3/da6/namespace_m_utils.html#aea4a212153b09b24b04f30ef5159f29b',1,'MUtils']]]
 ];
diff --git a/docs/search/functions_8.js b/docs/search/functions_8.js
index 7d9d593..86f9020 100644
--- a/docs/search/functions_8.js
+++ b/docs/search/functions_8.js
@@ -1,6 +1,6 @@
 var searchData=
 [
-  ['temp_5ffolder',['temp_folder',['../d3/da6/namespace_m_utils.html#a3f198156e8be91f3e74dd9ed69ffaa34',1,'MUtils']]],
-  ['trim_5fleft',['trim_left',['../d3/da6/namespace_m_utils.html#a20b8fc56856ee904caaded756399e705',1,'MUtils::trim_left(QString &str)'],['../d3/da6/namespace_m_utils.html#ae43bc17b6fa4ee2287099c4ae095483b',1,'MUtils::trim_left(const QString &str)']]],
-  ['trim_5fright',['trim_right',['../d3/da6/namespace_m_utils.html#a6118cf23d2b771fae1ad159c7ea6686a',1,'MUtils::trim_right(QString &str)'],['../d3/da6/namespace_m_utils.html#a3bcb0fce5181ded3c54456379147009d',1,'MUtils::trim_right(const QString &str)']]]
+  ['regexp_5fparse_5fuint32',['regexp_parse_uint32',['../d3/da6/namespace_m_utils.html#ad2a851b289ee66873d3a1ec86f5f34eb',1,'MUtils::regexp_parse_uint32(const QRegExp &regexp, quint32 &value)'],['../d3/da6/namespace_m_utils.html#a81704d66d34e37d3e0e159b5f436babf',1,'MUtils::regexp_parse_uint32(const QRegExp &regexp, quint32 *values, const size_t &count)']]],
+  ['remove_5fdirectory',['remove_directory',['../d3/da6/namespace_m_utils.html#a4d451ddc82668d1298f2922f62474b5d',1,'MUtils']]],
+  ['remove_5ffile',['remove_file',['../d3/da6/namespace_m_utils.html#a5a14e75627eebd09efc37898d74c5ac6',1,'MUtils']]]
 ];
diff --git a/docs/search/functions_9.js b/docs/search/functions_9.js
index f75715a..511278c 100644
--- a/docs/search/functions_9.js
+++ b/docs/search/functions_9.js
@@ -1,4 +1,7 @@
 var searchData=
 [
-  ['update',['update',['../da/db0/class_m_utils_1_1_hash_1_1_hash.html#a5c36bd2ea671928f9f5bd897dcfbef15',1,'MUtils::Hash::Hash::update(const quint8 *const data, const quint32 len)'],['../da/db0/class_m_utils_1_1_hash_1_1_hash.html#a16bef08766de745913b3fd7c338bf5aa',1,'MUtils::Hash::Hash::update(const QByteArray &data)'],['../da/db0/class_m_utils_1_1_hash_1_1_hash.html#ace90c97585350dd246b6c655a3de571f',1,'MUtils::Hash::Hash::update(QFile &file)']]]
+  ['temp_5ffolder',['temp_folder',['../d3/da6/namespace_m_utils.html#a3f198156e8be91f3e74dd9ed69ffaa34',1,'MUtils']]],
+  ['terminatejob',['terminateJob',['../dc/dd3/class_m_utils_1_1_job_object.html#abe785eacf0468533ca90c6f77d734cda',1,'MUtils::JobObject']]],
+  ['trim_5fleft',['trim_left',['../d3/da6/namespace_m_utils.html#a20b8fc56856ee904caaded756399e705',1,'MUtils::trim_left(QString &str)'],['../d3/da6/namespace_m_utils.html#ae43bc17b6fa4ee2287099c4ae095483b',1,'MUtils::trim_left(const QString &str)']]],
+  ['trim_5fright',['trim_right',['../d3/da6/namespace_m_utils.html#a6118cf23d2b771fae1ad159c7ea6686a',1,'MUtils::trim_right(QString &str)'],['../d3/da6/namespace_m_utils.html#a3bcb0fce5181ded3c54456379147009d',1,'MUtils::trim_right(const QString &str)']]]
 ];
diff --git a/docs/search/functions_a.html b/docs/search/functions_a.html
new file mode 100644
index 0000000..8ca8f11
--- /dev/null
+++ b/docs/search/functions_a.html
@@ -0,0 +1,26 @@
+
+
+
+
+
+
+
+
+
+
    
+
    Loading...
    
+
    
+
+
    Searching...
    
+
    No Matches
    
+
+
    
+
+
diff --git a/docs/search/functions_a.js b/docs/search/functions_a.js
new file mode 100644
index 0000000..f75715a
--- /dev/null
+++ b/docs/search/functions_a.js
@@ -0,0 +1,4 @@
+var searchData=
+[
+  ['update',['update',['../da/db0/class_m_utils_1_1_hash_1_1_hash.html#a5c36bd2ea671928f9f5bd897dcfbef15',1,'MUtils::Hash::Hash::update(const quint8 *const data, const quint32 len)'],['../da/db0/class_m_utils_1_1_hash_1_1_hash.html#a16bef08766de745913b3fd7c338bf5aa',1,'MUtils::Hash::Hash::update(const QByteArray &data)'],['../da/db0/class_m_utils_1_1_hash_1_1_hash.html#ace90c97585350dd246b6c655a3de571f',1,'MUtils::Hash::Hash::update(QFile &file)']]]
+];
diff --git a/docs/search/functions_b.html b/docs/search/functions_b.html
new file mode 100644
index 0000000..a6efa74
--- /dev/null
+++ b/docs/search/functions_b.html
@@ -0,0 +1,26 @@
+
+
+
+
+
+
+
+
+
+
    
+
    Loading...
    
+
    
+
+
    Searching...
    
+
    No Matches
    
+
+
    
+
+
diff --git a/docs/search/functions_b.js b/docs/search/functions_b.js
new file mode 100644
index 0000000..f761a33
--- /dev/null
+++ b/docs/search/functions_b.js
@@ -0,0 +1,4 @@
+var searchData=
+[
+  ['_7ejobobject',['~JobObject',['../dc/dd3/class_m_utils_1_1_job_object.html#a0e2d6461729d16b615548e7b1594c893',1,'MUtils::JobObject']]]
+];
diff --git a/docs/search/searchdata.js b/docs/search/searchdata.js
index 8bc0d42..a871ea9 100644
--- a/docs/search/searchdata.js
+++ b/docs/search/searchdata.js
@@ -1,10 +1,10 @@
 var indexSectionsWithContent =
 {
-  0: "_abcdfghijmnprstuvx",
+  0: "_abcdfghijmnprstuvx~",
   1: "_hijrtuv",
   2: "m",
-  3: "cgh",
-  4: "acdimnprtu",
+  3: "cghj",
+  4: "acdijmnprtu~",
   5: "bcfhimsvx",
   6: "c",
   7: "m"
diff --git a/include/MUtils/JobObject.h b/include/MUtils/JobObject.h
index 4461eca..b4ad98b 100644
--- a/include/MUtils/JobObject.h
+++ b/include/MUtils/JobObject.h
@@ -19,6 +19,15 @@
 // http://www.gnu.org/licenses/lgpl-2.1.txt
 //////////////////////////////////////////////////////////////////////////////////
 
+/**
+* @file
+* @brief This file contains function for creating and managing job objects
+*
+* Each instance of MUtils::JobObject represents a job object. Call MUtils::JobObject::addProcessToJob() to add another sub-process to the job object. Call MUtils::JobObject::terminateJob() to terminate *all* sub-processes that currently belong to the job object at once.
+* 
+* Note that all sub-processes that belong to the job object will be terminated when *this* process exits, gracefully or due to a crash. All sub-process belonging to a job object also are terminated when the corresponding MUtils::JobObject instance is destroyed.
+*/
+
 #pragma once
 
 #include 
@@ -27,14 +36,59 @@ class QProcess;
 
 namespace MUtils
 {
+	/**
+	* @brief This class represents a job object
+	*
+	* Call addProcessToJob() to add another sub-process to this job object. Call terminateJob() to terminate all sub-processes that belong to this job object. Note that all sub-processes that belong to this job object will also be terminated when *this* process exits, gracefully or due to a crash.
+	*
+	* Also, when the JobObject instance is destroyed, all sub-process that belong to its corresponding job object and that are still running will be terminated!
+	*/
 	class MUTILS_API JobObject
 	{
 	public:
+		/**
+		* \brief Create a new JobObject instance
+		*
+		* Creating a new JobObject instance automatically creates a new job object on the system-level. Check isObjectCreated() to test whether the job object was successfully created or not.
+		*/
 		JobObject(void);
+		
+		/**
+		* \brief Destroys the JobObject instance
+		*
+		* If the job object still has any running sub-processes left when the corresponding JobObject instance is destroyed, these sub-process are terminated!
+		*/
 		~JobObject(void);
 
+		/**
+		* \brief Test whether job object was created successfully
+		*
+		* The job object will be created automatically when a new JobObject instance is created. However, the constructor has **no** to tell whether the job object was created successfully on the system-level. Call this function to test whether the job object has been created.
+		*
+		* \return The function returns `true`, if and only if a job object was successfully created; otherwise it returns `false`.
+		*/
 		bool isObjectCreated(void);
+		
+		/**
+		* \brief Add a process to the job object
+		*
+		* This function adds a another sub-process to the job object that is represented by this JobObject instance. Job object limitations apply to the sub-process a
+		*
+		* \param process A read-only pointer to the [QProcess](http://doc.qt.io/qt-4.8/qprocess.html) object that represents the sub-process to be added to the job object. The sub-process must be in the "running" state; otherwise the function will fail.
+		*
+		* \return The function returns `true`, if and only if the process was successfully added to the job object; otherwise it returns `false`.
+		*/
 		bool addProcessToJob(const QProcess *const process);
+		
+		/**
+		* \brief Terminate all sub-processes of the job object
+		*
+		* This function immediately terminates *all* running sub-processes that belong to the job object represented by this JobObject instance at once.
+		*
+		* \param exitCode The exit code to be set for the sub-process when they are terminated.
+		*
+		* \return The function returns `true`, if the sub-processes were destroyed successfully, even if there were no running sub-process left; otherwise it returns `false`.
+		*/
 		bool terminateJob(const quint32 &exitCode);
 
 	private:
diff --git a/include/MUtilsInfo.dox b/include/MUtilsInfo.dox
index e1a2da0..9d6cd27 100644
--- a/include/MUtilsInfo.dox
+++ b/include/MUtilsInfo.dox
@@ -12,6 +12,7 @@
  * - **Global.h** – miscellaneous useful functions
  * - **CPUFeatures.h** – functions for detection information about the CPU
  * - **Hash.h** – functions for cryptographic hash computation
+ * - **JobObject.h** – functions for creating and managing job objects
  * 
  * 
  * # Example
-- 
2.11.0