From 17dbb1081047058eab03bb78681f48b697bc6daf Mon Sep 17 00:00:00 2001 From: LoRd_MuldeR Date: Mon, 2 Apr 2018 18:34:29 +0200 Subject: [PATCH] Documentation was updated. --- docs/annotated.html | 15 +-- docs/classes.html | 7 +- docs/d0/dd7/_version_8h_source.html | 2 +- docs/d2/dad/_hash_8h_source.html | 2 +- docs/d3/da6/namespace_m_utils.html | 42 ++++++++ docs/d4/d85/_job_object_8h_source.html | 2 +- docs/d5/d3b/_global_8h.html | 18 ++++ docs/d5/d3b/_global_8h_source.html | 5 +- .../d46/struct_m_utils_1_1__fp__parts__t.html | 98 +++++++++++++++++++ ...uct_m_utils_1_1__fp__parts__t-members.html | 82 ++++++++++++++++ docs/hierarchy.html | 23 ++--- docs/menudata.js | 1 + docs/namespacemembers.html | 10 ++ docs/namespacemembers_func.html | 3 + docs/namespacemembers_type.html | 3 + docs/search/all_0.js | 1 + docs/search/all_2.js | 3 +- docs/search/all_5.js | 3 +- docs/search/classes_0.js | 1 + docs/search/functions_1.js | 4 +- docs/search/functions_2.js | 5 +- docs/search/functions_3.js | 3 +- docs/search/functions_4.js | 3 +- docs/search/functions_5.js | 3 +- docs/search/functions_6.js | 3 +- docs/search/functions_7.js | 7 +- docs/search/functions_8.js | 6 +- docs/search/functions_9.js | 4 +- docs/search/functions_a.js | 4 +- docs/search/functions_b.js | 5 +- docs/search/functions_c.js | 5 +- docs/search/functions_d.js | 2 +- docs/search/functions_e.html | 26 +++++ docs/search/functions_e.js | 4 + docs/search/searchdata.js | 4 +- docs/search/typedefs_1.js | 2 +- docs/search/typedefs_2.html | 26 +++++ docs/search/typedefs_2.js | 4 + include/MUtils/Global.h | 12 +-- src/Global.cpp | 12 ++- 40 files changed, 399 insertions(+), 66 deletions(-) create mode 100644 docs/da/d46/struct_m_utils_1_1__fp__parts__t.html create mode 100644 docs/df/d5e/struct_m_utils_1_1__fp__parts__t-members.html create mode 100644 docs/search/functions_e.html create mode 100644 docs/search/functions_e.js create mode 100644 docs/search/typedefs_2.html create mode 100644 docs/search/typedefs_2.js diff --git a/docs/annotated.html b/docs/annotated.html index 813bb4b..18fc209 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -75,13 +75,14 @@ $(function() {  C_os_version_tThis struct contains version information about the underlaying operating system. See _os_version_t for details!  NRegistry  CRegistryKey - CIPCChannel - CJobObjectThis class represents a job object - CLazyLazy initialization template class - CTaskbar7 - CUpdateChecker - CUpdateCheckerInfo - CVersion + C_fp_parts_tThis struct containes the parts (integral and fractional part) of a floating-point number + CIPCChannel + CJobObjectThis class represents a job object + CLazyLazy initialization template class + CTaskbar7 + CUpdateChecker + CUpdateCheckerInfo + CVersion diff --git a/docs/classes.html b/docs/classes.html index b051da8..43bc9a1 100644 --- a/docs/classes.html +++ b/docs/classes.html @@ -73,13 +73,14 @@ $(function() {
  v  
_cpu_info_t (MUtils::CPUFetaures)   IPCChannel (MUtils)   Lazy (MUtils)   Taskbar7 (MUtils)    -_os_version_t (MUtils::OS::Version)   
  j  
+_fp_parts_t (MUtils)   
  j  
  r  
  u  
Version (MUtils)    +_os_version_t (MUtils::OS::Version)   
  h  
- -JobObject (MUtils)   RegistryKey (MUtils::Registry)   UpdateChecker (MUtils)    +JobObject (MUtils)   RegistryKey (MUtils::Registry)   UpdateChecker (MUtils)    + Hash (MUtils::Hash)    diff --git a/docs/d0/dd7/_version_8h_source.html b/docs/d0/dd7/_version_8h_source.html index 3cd9d9b..f96d5ee 100644 --- a/docs/d0/dd7/_version_8h_source.html +++ b/docs/d0/dd7/_version_8h_source.html @@ -67,7 +67,7 @@ $(function() {
Version.h
-
1 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2018 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 //Qt
28 #include <QString>
29 #include <QDate>
30 #include <QTime>
31 
32 namespace MUtils
33 {
34  class Version
35  {
36  public:
37  //Get Library Version Numbers
38  MUTILS_API static const quint32 &lib_version_major(void);
39  MUTILS_API static const quint32 &lib_version_minor(void);
40 
41  //Get Library Build Date/Time
42  MUTILS_API static const QDate lib_build_date(void);
43  MUTILS_API static const QTime lib_build_time(void);
44 
45  //Get Application Build Date/Time
46  MUTILS_API static const QDate app_build_date(const char *const date_str = build_date_raw());
47  MUTILS_API static const QTime app_build_time(const char *const time_str = build_time_raw());
48 
49  //Compiler detection
50  static const char *const compiler_version(void)
51  {
52  static const char *const COMPILER_VERS =
53  #if defined(__INTEL_COMPILER)
54  #if (__INTEL_COMPILER >= 1500)
55  "ICL 15." MUTILS_MAKE_STRING(__INTEL_COMPILER_BUILD_DATE);
56  #elif (__INTEL_COMPILER >= 1400)
57  "ICL 14." MUTILS_MAKE_STRING(__INTEL_COMPILER_BUILD_DATE);
58  #elif (__INTEL_COMPILER >= 1300)
59  "ICL 13." MUTILS_MAKE_STRING(__INTEL_COMPILER_BUILD_DATE);
60  #elif (__INTEL_COMPILER >= 1200)
61  "ICL 12." MUTILS_MAKE_STRING(__INTEL_COMPILER_BUILD_DATE);
62  #elif (__INTEL_COMPILER >= 1100)
63  "ICL 11.x";
64  #elif (__INTEL_COMPILER >= 1000)
65  "ICL 10.x";
66  #else
67  #error Compiler is not supported!
68  #endif
69  #elif defined(_MSC_VER)
70  #if (_MSC_VER == 1912)
71  #if((_MSC_FULL_VER >= 191225830) && (_MSC_FULL_VER <= 191225834))
72  "MSVC 2017.5";
73  #else
74  #error Compiler version is not supported yet!
75  #endif
76  #elif (_MSC_VER == 1911)
77  #if((_MSC_FULL_VER >= 191125542) && (_MSC_FULL_VER <= 191125547))
78  "MSVC 2017.4";
79  #elif((_MSC_FULL_VER >= 191125506) && (_MSC_FULL_VER <= 191125508))
80  "MSVC 2017.3";
81  #else
82  #error Compiler version is not supported yet!
83  #endif
84  #elif (_MSC_VER == 1910)
85  #if ((_MSC_FULL_VER >= 191025017) && (_MSC_FULL_VER <= 191025019))
86  "MSVC 2017.2";
87  #else
88  #error Compiler version is not supported yet!
89  #endif
90  #elif (_MSC_VER == 1900)
91  #if (_MSC_FULL_VER == 190023026)
92  "MSVC 2015";
93  #elif (_MSC_FULL_VER == 190023506)
94  "MSVC 2015.1";
95  #elif (_MSC_FULL_VER == 190023918)
96  "MSVC 2015.2";
97  #elif (_MSC_FULL_VER == 190024210) || (_MSC_FULL_VER == 190024215)
98  "MSVC 2015.3";
99  #else
100  #error Compiler version is not supported yet!
101  #endif
102  #elif (_MSC_VER == 1800)
103  #if (_MSC_FULL_VER == 180021005)
104  "MSVC 2013";
105  #elif (_MSC_FULL_VER == 180030501)
106  "MSVC 2013.2";
107  #elif (_MSC_FULL_VER == 180030723)
108  "MSVC 2013.3";
109  #elif (_MSC_FULL_VER == 180031101)
110  "MSVC 2013.4";
111  #elif (_MSC_FULL_VER == 180040629)
112  "MSVC 2013.5";
113  #else
114  #error Compiler version is not supported yet!
115  #endif
116  #elif (_MSC_VER == 1700)
117  #if (_MSC_FULL_VER == 170050727)
118  "MSVC 2012";
119  #elif (_MSC_FULL_VER == 170051106)
120  "MSVC 2012.1";
121  #elif (_MSC_FULL_VER == 170060315)
122  "MSVC 2012.2";
123  #elif (_MSC_FULL_VER == 170060610)
124  "MSVC 2012.3";
125  #elif (_MSC_FULL_VER == 170061030)
126  "MSVC 2012.4";
127  #else
128  #error Compiler version is not supported yet!
129  #endif
130  #elif (_MSC_VER == 1600)
131  #if (_MSC_FULL_VER >= 160040219)
132  "MSVC 2010-SP1";
133  #else
134  "MSVC 2010";
135  #endif
136  #elif (_MSC_VER == 1500)
137  #if (_MSC_FULL_VER >= 150030729)
138  "MSVC 2008-SP1";
139  #else
140  "MSVC 2008";
141  #endif
142  #else
143  #error Compiler is not supported!
144  #endif
145  #else
146  #error Compiler is not supported!
147  #endif
148  return COMPILER_VERS;
149  }
150 
151  //Architecture detection
152  static const char *const compiler_arch(void)
153  {
154  static const char *const COMPILER_ARCH =
155  #if defined(_M_X64)
156  "x64";
157  #elif defined(_M_IX86)
158  "x86";
159  #else
160  #error Architecture is not supported!
161  #endif
162  return COMPILER_ARCH;
163  }
164 
165  private:
166  //Raw Build date
167  static const char *const build_date_raw(void)
168  {
169  static const char *const RAW_BUILD_DATE = __DATE__;
170  return RAW_BUILD_DATE;
171  }
172 
173  //Raw Build time
174  static const char *const build_time_raw(void)
175  {
176  static const char *const RAW_BUILD_TIME = __TIME__;
177  return RAW_BUILD_TIME;
178  }
179 
180  //Disable construction
181  Version(void) { throw 666; }
182  Version(const Version&) { throw 666; }
183  };
184 }
185 
Definition: Version.h:34
+
1 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2018 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 //Qt
28 #include <QString>
29 #include <QDate>
30 #include <QTime>
31 
32 namespace MUtils
33 {
34  class Version
35  {
36  public:
37  //Get Library Version Numbers
38  MUTILS_API static const quint32 &lib_version_major(void);
39  MUTILS_API static const quint32 &lib_version_minor(void);
40 
41  //Get Library Build Date/Time
42  MUTILS_API static const QDate lib_build_date(void);
43  MUTILS_API static const QTime lib_build_time(void);
44 
45  //Get Application Build Date/Time
46  MUTILS_API static const QDate app_build_date(const char *const date_str = build_date_raw());
47  MUTILS_API static const QTime app_build_time(const char *const time_str = build_time_raw());
48 
49  //Compiler detection
50  static const char *const compiler_version(void)
51  {
52  static const char *const COMPILER_VERS =
53  #if defined(__INTEL_COMPILER)
54  #if (__INTEL_COMPILER >= 1500)
55  "ICL 15." MUTILS_MAKE_STRING(__INTEL_COMPILER_BUILD_DATE);
56  #elif (__INTEL_COMPILER >= 1400)
57  "ICL 14." MUTILS_MAKE_STRING(__INTEL_COMPILER_BUILD_DATE);
58  #elif (__INTEL_COMPILER >= 1300)
59  "ICL 13." MUTILS_MAKE_STRING(__INTEL_COMPILER_BUILD_DATE);
60  #elif (__INTEL_COMPILER >= 1200)
61  "ICL 12." MUTILS_MAKE_STRING(__INTEL_COMPILER_BUILD_DATE);
62  #elif (__INTEL_COMPILER >= 1100)
63  "ICL 11.x";
64  #elif (__INTEL_COMPILER >= 1000)
65  "ICL 10.x";
66  #else
67  #error Compiler is not supported!
68  #endif
69  #elif defined(_MSC_VER)
70  #if (_MSC_VER == 1913)
71  #if((_MSC_FULL_VER >= 191326128) && (_MSC_FULL_VER <= 191326129))
72  "MSVC 2017.6";
73  #else
74  #error Compiler version is not supported yet!
75  #endif
76  #elif (_MSC_VER == 1912)
77  #if((_MSC_FULL_VER >= 191225830) && (_MSC_FULL_VER <= 191225835))
78  "MSVC 2017.5";
79  #else
80  #error Compiler version is not supported yet!
81  #endif
82  #elif (_MSC_VER == 1911)
83  #if((_MSC_FULL_VER >= 191125542) && (_MSC_FULL_VER <= 191125547))
84  "MSVC 2017.4";
85  #elif((_MSC_FULL_VER >= 191125506) && (_MSC_FULL_VER <= 191125508))
86  "MSVC 2017.3";
87  #else
88  #error Compiler version is not supported yet!
89  #endif
90  #elif (_MSC_VER == 1910)
91  #if ((_MSC_FULL_VER >= 191025017) && (_MSC_FULL_VER <= 191025019))
92  "MSVC 2017.2";
93  #else
94  #error Compiler version is not supported yet!
95  #endif
96  #elif (_MSC_VER == 1900)
97  #if (_MSC_FULL_VER == 190023026)
98  "MSVC 2015";
99  #elif (_MSC_FULL_VER == 190023506)
100  "MSVC 2015.1";
101  #elif (_MSC_FULL_VER == 190023918)
102  "MSVC 2015.2";
103  #elif (_MSC_FULL_VER == 190024210) || (_MSC_FULL_VER == 190024215)
104  "MSVC 2015.3";
105  #else
106  #error Compiler version is not supported yet!
107  #endif
108  #elif (_MSC_VER == 1800)
109  #if (_MSC_FULL_VER == 180021005)
110  "MSVC 2013";
111  #elif (_MSC_FULL_VER == 180030501)
112  "MSVC 2013.2";
113  #elif (_MSC_FULL_VER == 180030723)
114  "MSVC 2013.3";
115  #elif (_MSC_FULL_VER == 180031101)
116  "MSVC 2013.4";
117  #elif (_MSC_FULL_VER == 180040629)
118  "MSVC 2013.5";
119  #else
120  #error Compiler version is not supported yet!
121  #endif
122  #elif (_MSC_VER == 1700)
123  #if (_MSC_FULL_VER == 170050727)
124  "MSVC 2012";
125  #elif (_MSC_FULL_VER == 170051106)
126  "MSVC 2012.1";
127  #elif (_MSC_FULL_VER == 170060315)
128  "MSVC 2012.2";
129  #elif (_MSC_FULL_VER == 170060610)
130  "MSVC 2012.3";
131  #elif (_MSC_FULL_VER == 170061030)
132  "MSVC 2012.4";
133  #else
134  #error Compiler version is not supported yet!
135  #endif
136  #elif (_MSC_VER == 1600)
137  #if (_MSC_FULL_VER >= 160040219)
138  "MSVC 2010-SP1";
139  #else
140  "MSVC 2010";
141  #endif
142  #elif (_MSC_VER == 1500)
143  #if (_MSC_FULL_VER >= 150030729)
144  "MSVC 2008-SP1";
145  #else
146  "MSVC 2008";
147  #endif
148  #else
149  #error Compiler is not supported!
150  #endif
151  #else
152  #error Compiler is not supported!
153  #endif
154  return COMPILER_VERS;
155  }
156 
157  //Architecture detection
158  static const char *const compiler_arch(void)
159  {
160  static const char *const COMPILER_ARCH =
161  #if defined(_M_X64)
162  "x64";
163  #elif defined(_M_IX86)
164  "x86";
165  #else
166  #error Architecture is not supported!
167  #endif
168  return COMPILER_ARCH;
169  }
170 
171  private:
172  //Raw Build date
173  static const char *const build_date_raw(void)
174  {
175  static const char *const RAW_BUILD_DATE = __DATE__;
176  return RAW_BUILD_DATE;
177  }
178 
179  //Raw Build time
180  static const char *const build_time_raw(void)
181  {
182  static const char *const RAW_BUILD_TIME = __TIME__;
183  return RAW_BUILD_TIME;
184  }
185 
186  //Disable construction
187  Version(void) { throw 666; }
188  Version(const Version&) { throw 666; }
189  };
190 }
191 
Definition: Version.h:34
This file contains miscellaneous functions that are generally useful for Qt-based applications...
Global MUtils namespace.
Definition: CPUFeatures.h:37
diff --git a/docs/d2/dad/_hash_8h_source.html b/docs/d2/dad/_hash_8h_source.html index c5aa564..be19e65 100644 --- a/docs/d2/dad/_hash_8h_source.html +++ b/docs/d2/dad/_hash_8h_source.html @@ -73,7 +73,7 @@ $(function() {
static const quint16 HASH_BLAKE2_512
Hash algorithm identifier.
Definition: Hash.h:42
static const quint16 HASH_KECCAK_384
Hash algorithm identifier.
Definition: Hash.h:45
Global MUtils namespace.
Definition: CPUFeatures.h:37
-
#define MUTILS_NO_COPY(CLASS)
Disables copy constructor and assignment operator in the specified class. This macro should be used i...
Definition: Global.h:384
+
#define MUTILS_NO_COPY(CLASS)
Disables copy constructor and assignment operator in the specified class. This macro should be used i...
Definition: Global.h:400
MUTILS_API Hash * create(const quint16 &hashId, const char *const key=NULL)
Create instance of a hash function.
This abstract class specifies the generic interface for all support hash algorithms.
Definition: Hash.h:57
static const quint16 HASH_KECCAK_256
Hash algorithm identifier.
Definition: Hash.h:44
diff --git a/docs/d3/da6/namespace_m_utils.html b/docs/d3/da6/namespace_m_utils.html index aeb10ac..4ead94d 100644 --- a/docs/d3/da6/namespace_m_utils.html +++ b/docs/d3/da6/namespace_m_utils.html @@ -62,6 +62,7 @@ $(function() {
@@ -83,6 +84,9 @@ Namespaces + + + @@ -100,6 +104,13 @@ Classes

Classes

struct  _fp_parts_t
 This struct containes the parts (integral and fractional part) of a floating-point number. More...
 
class  IPCChannel
 
class  JobObject
class  Version
 
+ + + + +

+Typedefs

+typedef struct MUtils::_fp_parts_t fp_parts_t
 This struct containes the parts (integral and fractional part) of a floating-point number.
 
@@ -180,6 +191,9 @@ MUTILS_API bool  + + +

Functions

MUTILS_API const QString & temp_folder (void)
regexp_par
MUTILS_API QStringList available_codepages (const bool &noAliases=true)
 Retrieve a list of all available codepages. More...
 
MUTILS_API fp_parts_t break_fp (const double value)
 Break floating-point number into fractional and integral parts. More...
 
@@ -220,6 +234,34 @@ class MUTILS_API 

Variables

Taskbar7_
Returns
If the function succeeds, it returns a QStringList holding the names of all codepages available on the system; otherwise it returns a default-constructed QStringList.
+ + + +

§ break_fp()

+ +
+
+ + + + + + + + +
MUTILS_API fp_parts_t MUtils::break_fp (const double value)
+
+ +

Break floating-point number into fractional and integral parts.

+

The function returns a struct containing the fractional and the integral part of a given floating-point values as two separate values. This is a convenience warapper for the modf() function.

+
Parameters
+ + +
valueThe original floating-point value
+
+
+
Returns
Returns a struct containing the fractional and integral parts.
+
diff --git a/docs/d4/d85/_job_object_8h_source.html b/docs/d4/d85/_job_object_8h_source.html index e728c22..2af9f3d 100644 --- a/docs/d4/d85/_job_object_8h_source.html +++ b/docs/d4/d85/_job_object_8h_source.html @@ -70,7 +70,7 @@ $(function() { Go to the documentation of this file.
1 // MuldeR's Utilities for Qt
3 // Copyright (C) 2004-2018 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;
97  };
98 }
This file contains miscellaneous functions that are generally useful for Qt-based applications...
This class represents a job object.
Definition: JobObject.h:46
Global MUtils namespace.
Definition: CPUFeatures.h:37
-
#define MUTILS_NO_COPY(CLASS)
Disables copy constructor and assignment operator in the specified class. This macro should be used i...
Definition: Global.h:384
+
#define MUTILS_NO_COPY(CLASS)
Disables copy constructor and assignment operator in the specified class. This macro should be used i...
Definition: Global.h:400