diff --git a/README.html b/README.html index 83a04d4..c7ce357 100644 --- a/README.html +++ b/README.html @@ -7,16 +7,154 @@
The MUtilities library is a collection of routines and classes to extend the Qt cross-platform framework. It contains various convenience and utility functions as well as wrappers for OS-specific functionalities. The library was originally created as a "side product" of the LameXP application: Over the years, a lot of code, not really specific to LameXP, had accumulated in the LameXP code base. Some of that code even had been used in other projects too, in a "copy & paste" fashion – which had lead to redundancy and much complicated maintenance. In order to clean-up the LameXP code base, to eliminate the ugly redundancy and to simplify maintenance, the code in question has finally been refactored into the MUtilities (aka "MuldeR's Utilities for Qt") library. This library now forms the foundation of LameXP and other OpenSource projects.
-The MUtilities project directory is organized as follows:
+The MUtilities library is a collection of routines +and classes to extend the Qt +cross-platform framework. It contains various convenience and +utility functions as well as wrappers for OS-specific functionalities. +The library was originally created as a "side product" of the LameXP +application: Over the years, a lot of code, not really +specific to LameXP, had accumulated in the LameXP code +base. Some of that code even had been used in other projects too, in a +"copy & paste" fashion – which had lead to redundancy and much +complicated maintenance. In order to clean-up the LameXP code base, to +eliminate the ugly redundancy and to simplify maintenance, the code in +question has finally been refactored into the +MUtilities (aka "MuldeR's Utilities for Qt") library. +This library now forms the foundation of LameXP and other OpenSource +projects.
+The MUtilities project directory is organized as +follows:
bin/
– compiled library files (static or shared), link those files in projects that use the MUtilities librarydocs/
– programming interface documentation, generated with Doxygen tooletc/
– miscellaneous files, everything that doesn't fit in anywhere elseinclude/
– public header files, include this directory in projects that use the MUtilities libraryobj/
– object code files, intermediate files generated during the build processres/
– resource files, required for building the MUtilities librarysrc/
– source code files, required for building the MUtilities library (third-party code in src/3rd_party/
)bin/
– compiled library files (static or shared), link
+those files in projects that use the MUtilities librarydocs/
– programming interface documentation, generated
+with Doxygen tooletc/
– miscellaneous files, everything that doesn't fit
+in anywhere elseinclude/
– public header files, include this directory
+in projects that use the MUtilities libraryobj/
– object code files, intermediate files generated
+during the build processres/
– resource files, required for building the
+MUtilities librarysrc/
– source code files, required for building the
+MUtilities library (third-party code in
+src/3rd_party/
)test/
– unit tests, based on Google Test frameworktmp/
– temporary files, automatically generated during the build processtmp/
– temporary files, automatically generated during
+the build processHere is a minimal example on how to use the MUtilities library in your project:
+Here is a minimal example on how to use the MUtilities +library in your project:
//MUtils
#include <MUtils/Global.h>
@@ -77,19 +258,41 @@ int main(int argc, char **argv)
{
qDebug("Random number: %u\n", MUtils::next_rand_u32());
}
-include/
directory is contained in your "Additional Include Directories" and that the MUtilities' bin/
directory is contained in your "Additional Library Directories".MUtils32-1.lib
library file. For each build configuration, pick the proper .lib file from the corresponding bin/<platform>/<config>/
directory!MUTILS_STATIC_LIB
must be added to your project's "Preprocessor Definitions".include/
directory is contained in your "Additional Include
+Directories" and that the MUtilities' bin/
+directory is contained in your "Additional Library Directories".MUtils32-1.lib
library file. For each build configuration,
+pick the proper .lib file from the corresponding
+bin/<platform>/<config>/
directory!MUTILS_STATIC_LIB
must be added to your project's
+"Preprocessor Definitions".A fully-fledged documentation of the MUtilities programming interface (API) is available thanks to Doxygen. Please see docs/index.html
for details!
This library is free software. It is released under the terms of the GNU Lesser General Public License (LGPL), Version 2.1.
+A fully-fledged documentation of the MUtilities programming
+interface (API) is available thanks to Doxygen.
+Please see docs/index.html
+for details!
This library is free software. It is released under the terms of the +GNU Lesser +General Public License (LGPL), Version 2.1.
MUtilities - MuldeR's Utilities for Qt
-Copyright (C) 2004-2021 LoRd_MuldeR <MuldeR2@GMX.de>. Some rights reserved.
+Copyright (C) 2004-2022 LoRd_MuldeR <MuldeR2@GMX.de>. Some rights reserved.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
@@ -104,19 +307,27 @@ Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-The following people have contributed in the development of the MUtilities library:
+The following people have contributed in the development of the +MUtilities library:
The following third-party code is used in the MUtilities library:
Keccak/SHA-3 Reference Implementation
-Implementation by the Keccak, Keyak and Ketje Teams, namely, Guido Bertoni, Joan Daemen, Michaël Peeters, Gilles Van Assche and Ronny Van Keer
+Implementation by the Keccak, Keyak and Ketje Teams, namely, Guido
+Bertoni, Joan Daemen, Michaël Peeters, Gilles Van Assche and Ronny Van
+Keer
No Copyright / Dedicated to the Public Domain
Natural Order String Comparison
-Copyright (C) 2000, 2004 by Martin Pool <mbp@sourcefrog.net>
+Copyright (C) 2000, 2004 by Martin Pool <mbp@sourcefrog.net>
Released under the zlib License
Adler-32 Checksum Algorithm (from zlib)
Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler
diff --git a/docs/d0/dd7/_version_8h_source.html b/docs/d0/dd7/_version_8h_source.html
index 74846e4..ef83896 100644
--- a/docs/d0/dd7/_version_8h_source.html
+++ b/docs/d0/dd7/_version_8h_source.html
@@ -67,7 +67,7 @@ $(function() {
Operating system version constant.
Microsoft(R) Windows Vista
+MUTILS_API const os_version_t MUtils::OS::Version::WINDOWS_WIN10 | +
Operating system version constant.
+Microsoft(R) Windows 10
+ +MUTILS_API const os_version_t MUtils::OS::Version::WINDOWS_WIN11 | +
Operating system version constant.
+Microsoft(R) Windows 11
+Operating system version constant.
Microsoft(R) Windows XP
- - - -MUTILS_API const os_version_t MUtils::OS::Version::WINDOWS_WN100 | -
Operating system version constant.
-Microsoft(R) Windows 10
-digest(const bool bAsHex=true) | MUtils::Hash::Hash | inline |
finalize(void)=0 (defined in MUtils::Hash::Hash) | MUtils::Hash::Hash | protectedpure virtual |
Hash(const char *key=NULL) (defined in MUtils::Hash::Hash) | MUtils::Hash::Hash | inlineprotected |
Hash(const char *=NULL) (defined in MUtils::Hash::Hash) | MUtils::Hash::Hash | inlineprotected |
process(const quint8 *const data, const quint32 len)=0 (defined in MUtils::Hash::Hash) | MUtils::Hash::Hash | protectedpure virtual |
update(const quint8 *const data, const quint32 len) | MUtils::Hash::Hash | inline |
update(const QByteArray &data) | MUtils::Hash::Hash | inline |
MUTILS_API const os_version_t | MUtils::OS::Version::WINDOWS_WIN81 | |
Operating system version constant. More... | ||
MUTILS_API const os_version_t | MUtils::OS::Version::WINDOWS_WN100 | |
Operating system version constant. More... | ||
MUTILS_API const os_version_t | MUtils::OS::Version::WINDOWS_WIN10 | |
Operating system version constant. More... | ||
MUTILS_API const os_version_t | MUtils::OS::Version::WINDOWS_WIN11 | |
Operating system version constant. More... | ||
MUTILS_API const os_version_t | MUtils::OS::Version::UNKNOWN_OPSYS | |
Operating system version constant. More... | ||