From 53830e0b96810dbf5bb71966a7cbbc6935213a98 Mon Sep 17 00:00:00 2001 From: LoRd_MuldeR Date: Mon, 19 Dec 2016 17:09:58 +0100 Subject: [PATCH] Some documentation updates. --- README.html | 33 ++++-- README.md | 22 +++- docs/annotated.html | 2 +- docs/classes.html | 2 +- docs/d0/d8a/class_m_utils_1_1_update_checker.html | 2 +- docs/d0/dd7/_version_8h_source.html | 2 +- ...nal_1_1_keccak_impl_1_1sponge_state_struct.html | 2 +- docs/d1/d01/class_m_utils_1_1_hash_1_1_blake2.html | 2 +- .../d08/class_m_utils_1_1_job_object-members.html | 2 +- docs/d1/d0a/_taskbar7_8h_source.html | 2 +- .../d0d/class_m_utils_1_1_update_checker_info.html | 2 +- docs/d1/d32/class_m_utils_1_1_version.html | 2 +- docs/d1/d37/_hash___blake2_8h_source.html | 2 +- docs/d1/d93/_i_p_c_channel_8h_source.html | 2 +- .../class_m_utils_1_1_hash_1_1_keccak-members.html | 2 +- ...1_c_p_u_fetaures_1_1__cpu__info__t-members.html | 2 +- docs/d2/d13/_startup_8h_source.html | 2 +- docs/d2/d52/class_m_utils_1_1_taskbar7.html | 2 +- .../class_m_utils_1_1_update_checker-members.html | 2 +- docs/d2/db5/_c_p_u_features_8h_source.html | 2 +- ...ss_m_utils_1_1_update_checker_info-members.html | 2 +- docs/d3/d13/class_m_utils_1_1_version-members.html | 2 +- ...keccak_impl_1_1sponge_state_struct-members.html | 2 +- docs/d3/d5c/_registry_8h_source.html | 2 +- docs/d3/dc1/_o_s_support_8h_source.html | 2 +- .../d3/dc6/class_m_utils_1_1_taskbar7-members.html | 2 +- docs/d3/dd5/_error_handler_8h_source.html | 2 +- docs/d4/d85/_job_object_8h_source.html | 2 +- docs/d5/d3b/_global_8h.html | 130 +++++++++++++++++++-- docs/d5/d3b/_global_8h_source.html | 6 +- docs/d5/db0/_sound_8h_source.html | 2 +- ..._s_1_1_version_1_1__os__version__t-members.html | 2 +- docs/d5/dfe/class_m_utils_1_1_i_p_c_channel.html | 2 +- docs/d6/d83/_update_checker_8h_source.html | 2 +- docs/d6/ddd/_terminal_8h_source.html | 2 +- docs/d7/d73/_translation_8h_source.html | 2 +- .../class_m_utils_1_1_i_p_c_channel-members.html | 2 +- ...lass_m_utils_1_1_registry_1_1_registry_key.html | 2 +- docs/da/d5d/_g_u_i_8h_source.html | 2 +- ...ls_1_1_o_s_1_1_version_1_1__os__version__t.html | 2 +- ...tils_1_1_registry_1_1_registry_key-members.html | 2 +- docs/dc/dd3/class_m_utils_1_1_job_object.html | 2 +- .../class_m_utils_1_1_hash_1_1_blake2-members.html | 2 +- docs/dd/d9f/class_m_utils_1_1_hash_1_1_keccak.html | 2 +- ...utils_1_1_c_p_u_fetaures_1_1__cpu__info__t.html | 2 +- docs/dd/dea/_hash___keccak_8h_source.html | 2 +- docs/df/d98/_exception_8h_source.html | 2 +- docs/dir_b076b53667bc06ebb413a190e197fc7b.html | 2 +- docs/dir_d44c64559bbebec7f509842c48db8b23.html | 2 +- docs/files.html | 2 +- docs/hierarchy.html | 2 +- docs/index.html | 2 +- docs/search/all_1.js | 2 +- docs/search/all_2.js | 2 +- docs/search/all_3.js | 2 +- docs/search/all_4.js | 2 +- docs/search/all_5.js | 2 +- docs/search/all_6.js | 4 +- docs/search/{all_6.js => all_7.js} | 0 docs/search/{all_7.js => all_8.js} | 0 docs/search/all_9.js | 4 +- docs/search/{all_9.js => all_a.js} | 1 + docs/search/{all_a.js => all_b.js} | 0 docs/search/{all_b.js => all_c.js} | 0 docs/search/all_d.js | 3 +- docs/search/all_e.html | 26 +++++ docs/search/{all_d.js => all_e.js} | 0 docs/search/functions_0.js | 3 +- docs/search/{functions_0.js => functions_1.js} | 0 docs/search/{functions_1.js => functions_2.js} | 0 docs/search/functions_3.js | 3 +- docs/search/functions_4.js | 12 +- docs/search/functions_5.html | 26 +++++ docs/search/{functions_4.js => functions_5.js} | 0 docs/search/searchdata.js | 4 +- include/MUtils/Global.h | 38 +++++- 76 files changed, 326 insertions(+), 95 deletions(-) copy docs/search/{all_6.js => all_7.js} (100%) rename docs/search/{all_7.js => all_8.js} (100%) copy docs/search/{all_9.js => all_a.js} (50%) rename docs/search/{all_a.js => all_b.js} (100%) rename docs/search/{all_b.js => all_c.js} (100%) create mode 100644 docs/search/all_e.html copy docs/search/{all_d.js => all_e.js} (100%) copy docs/search/{functions_0.js => functions_1.js} (100%) rename docs/search/{functions_1.js => functions_2.js} (100%) rewrite docs/search/functions_4.js (96%) create mode 100644 docs/search/functions_5.html copy docs/search/{functions_4.js => functions_5.js} (100%) diff --git a/README.html b/README.html index 41c5884..f379771 100644 --- a/README.html +++ b/README.html @@ -42,15 +42,18 @@ document.write(''+e+'<\

1 Introduction

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.

2 Project Structure

-

The MUtilities project directory is structured as follows:

+

The MUtilities project directory is organized as follows:

-

3 API Documentation

+

3 Example

+

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

+
//MUtils
+#include <MUtils/Global.h>
+
+int main(int argc, char **argv)
+{
+    qDebug("Random number: %u\n", MUtils::next_rand_u32());
+}
+

3.1 Build Notes

+ +

4 API Documentation

A fully-fledged documentation of the MUtilities programming interface (API) is available thanks to Doxygen. Please see docs/index.html for details!

-

4 License

+

5 License

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-2016 LoRd_MuldeR <MuldeR2@GMX.de>. Some rights reserved.
@@ -82,7 +101,7 @@ 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.
-

5 Acknowledgement

+

6 Acknowledgement

The following third-party code is used in the MUtilities library: