include/MUtilsInfo.dox

   1 /**
   2  * @mainpage
   3  *
   4  * # Introduction #
   5  *
   6  * The **MUtilities** library is a collection of routines and classes to extend the [*Qt cross-platform framework*](http://qt-project.org/). 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**](http://lamexp.sourceforge.net/) 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 &ndash; 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*](https://github.com/lordmulder).
   7  *
   8  *
   9  * # API Documentation
  10  *
  11  * The public API of the *MUtilities* library is defined in the following header files (select file for details):
  12  * - **Global.h** &ndash; miscellaneous useful functions
  13  * - **CPUFeatures.h** &ndash; functions for detection information about the CPU
  14  * - **Hash.h** &ndash; functions for cryptographic hash computation
  15  *
  16  *
  17  * # Example
  18  *
  19  * Here is a minimal example on how to use the *MUtilities* library in your project:
  20  *
  21  *     //MUtils
  22  *     #include <MUtils/Global.h>
  23  *
  24  *     int main(int argc, char **argv)
  25  *     {
  26  *         qDebug("Random number: %u\n", MUtils::next_rand_u32());
  27  *     }
  28  *
  29  *
  30  * # License
  31  *
  32  * This library is free software. It is released under the terms of the [*GNU Lesser General Public License (LGPL), Version 2.1*](https://www.gnu.org/licenses/lgpl-2.1.html).
  33  *
  34  *     MUtilities - MuldeR's Utilities for Qt
  35  *     Copyright (C) 2004-2016 LoRd_MuldeR <MuldeR2@GMX.de>. Some rights reserved.
  36  *
  37  *     This library is free software; you can redistribute it and/or
  38  *     modify it under the terms of the GNU Lesser General Public
  39  *     License as published by the Free Software Foundation; either
  40  *     version 2.1 of the License, or (at your option) any later version.
  41  *
  42  *     This library is distributed in the hope that it will be useful,
  43  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
  44  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  45  *     Lesser General Public License for more details.
  46  *
  47  *     You should have received a copy of the GNU Lesser General Public
  48  *     License along with this library; if not, write to the Free Software
  49  *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.
  50  *
  51  *
  52  * # Acknowledgement
  53  *
  54  * The following third-party code is used in the MUtilities library:
  55  *
  56  * - **Keccak/SHA-3 Reference Implementation**
  57  *   Implementation by the Keccak, Keyak and Ketje Teams, namely, Guido Bertoni, Joan Daemen, Michaël Peeters, Gilles Van Assche and Ronny Van Keer
  58  *   No Copyright / Dedicated to the Public Domain
  59  *
  60  * - **Natural Order String Comparison**
  61  *   Copyright (C) 2000, 2004 by Martin Pool <mbp@sourcefrog.net>
  62  *   Released under the zlib License
  63  *
  64  * - **Adler-32 Checksum Algorithm (from zlib)**
  65  *   Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler
  66  *   Released under the zlib License
  67  */