OSDN Git Service

Updated copyright year.
[mutilities/MUtilities.git] / README.html
index b0736ab..83a04d4 100644 (file)
@@ -1,12 +1,19 @@
 <!DOCTYPE html>
-<html>
+<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
 <head>
-  <meta charset="utf-8">
-  <meta name="generator" content="pandoc">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
-  <meta name="author" content="Created by LoRd_MuldeR &lt;mulder2@gmx&gt; – check http://muldersoft.com/ for news and updates!">
+  <meta charset="utf-8" />
+  <meta name="generator" content="pandoc" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
+  <meta name="author" content="Created by LoRd_MuldeR &lt;mulder2@gmx&gt; – check http://muldersoft.com/ for news and updates!" />
   <title>MUtilities – README</title>
-  <style type="text/css">code{white-space: pre;}</style>
+  <style>
+    code{white-space: pre-wrap;}
+    span.smallcaps{font-variant: small-caps;}
+    span.underline{text-decoration: underline;}
+    div.column{display: inline-block; vertical-align: top; width: 50%;}
+    div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
+    ul.task-list{list-style: none;}
+  </style>
   <!--[if lt IE 9]>
     <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
   <![endif]-->
   </style>
 </head>
 <body>
-<header>
+<header id="title-block-header">
 <h1 class="title">MUtilities – README</h1>
-<h2 class="author">Created by LoRd_MuldeR &lt;<script type="text/javascript">
-<!--
-h='&#x67;&#x6d;&#120;';a='&#64;';n='&#x6d;&#x75;&#108;&#100;&#x65;&#114;&#50;';e=n+a+h;
-document.write('<a h'+'ref'+'="ma'+'ilto'+':'+e+'" clas'+'s="em' + 'ail">'+e+'<\/'+'a'+'>');
-// -->
-</script><noscript>&#x6d;&#x75;&#108;&#100;&#x65;&#114;&#50;&#32;&#x61;&#116;&#32;&#x67;&#x6d;&#120;</noscript>&gt; – check <a href="http://muldersoft.com/" class="uri">http://muldersoft.com/</a> for news and updates!</h2>
+<p class="author">Created by LoRd_MuldeR &lt;<a href="mailto:mulder2@gmx" class="email">mulder2@gmx</a>&gt; – check <a href="http://muldersoft.com/" class="uri">http://muldersoft.com/</a> for news and updates!</p>
 </header>
-<nav id="TOC">
+<nav id="TOC" role="doc-toc">
 <ul>
 <li><a href="#introduction"><span class="toc-section-number">1</span> Introduction</a></li>
 <li><a href="#project-structure"><span class="toc-section-number">2</span> Project Structure</a></li>
-<li><a href="#example"><span class="toc-section-number">3</span> Example</a><ul>
+<li><a href="#example"><span class="toc-section-number">3</span> Example</a>
+<ul>
 <li><a href="#build-notes"><span class="toc-section-number">3.1</span> Build Notes</a></li>
 </ul></li>
 <li><a href="#api-documentation"><span class="toc-section-number">4</span> API Documentation</a></li>
@@ -50,9 +53,9 @@ document.write('<a h'+'ref'+'="ma'+'ilto'+':'+e+'" clas'+'s="em' + 'ail">'+e+'<\
 <li><a href="#acknowledgement"><span class="toc-section-number">6</span> Acknowledgement</a></li>
 </ul>
 </nav>
-<h1 id="introduction"><span class="header-section-number">1</span> Introduction</h1>
-<p>The <strong>MUtilities</strong> library is a collection of routines and classes to extend the <a href="http://qt-project.org/"><em>Qt cross-platform framework</em></a>. It contains various convenience and utility functions as well as wrappers for OS-specific functionalities. The library was originally created as a &quot;side product&quot; of the <a href="http://lamexp.sourceforge.net/"><strong>LameXP</strong></a> application: Over the years, a lot of code, <strong>not</strong> really specific to <em>LameXP</em>, had accumulated in the <em>LameXP</em> code base. Some of that code even had been used in other projects too, in a &quot;copy &amp; paste&quot; 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 <strong>MUtilities</strong> (aka &quot;MuldeR's Utilities for Qt&quot;) library. This library now forms the foundation of <em>LameXP</em> and <a href="https://github.com/lordmulder"><em>other OpenSource projects</em></a>.</p>
-<h1 id="project-structure"><span class="header-section-number">2</span> Project Structure</h1>
+<h1 data-number="1" id="introduction"><span class="header-section-number">1</span> Introduction</h1>
+<p>The <strong>MUtilities</strong> library is a collection of routines and classes to extend the <a href="http://qt-project.org/"><em>Qt cross-platform framework</em></a>. 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 <a href="http://lamexp.sourceforge.net/"><strong>LameXP</strong></a> application: Over the years, a lot of code, <strong>not</strong> really specific to <em>LameXP</em>, had accumulated in the <em>LameXP</em> code base. Some of that code even had been used in other projects too, in a "copy &amp; 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 <strong>MUtilities</strong> (aka "MuldeR's Utilities for Qt") library. This library now forms the foundation of <em>LameXP</em> and <a href="https://github.com/lordmulder"><em>other OpenSource projects</em></a>.</p>
+<h1 data-number="2" id="project-structure"><span class="header-section-number">2</span> Project Structure</h1>
 <p>The <em>MUtilities</em> project directory is organized as follows:</p>
 <ul>
 <li><code>bin/</code> – compiled library files (static or shared), link those files in projects that use the MUtilities library</li>
@@ -65,7 +68,7 @@ document.write('<a h'+'ref'+'="ma'+'ilto'+':'+e+'" clas'+'s="em' + 'ail">'+e+'<\
 <li><code>test/</code> – unit tests, based on Google Test framework</li>
 <li><code>tmp/</code> – temporary files, automatically generated during the build process</li>
 </ul>
-<h1 id="example"><span class="header-section-number">3</span> Example</h1>
+<h1 data-number="3" id="example"><span class="header-section-number">3</span> Example</h1>
 <p>Here is a minimal example on how to use the <em>MUtilities</em> library in your project:</p>
 <pre><code>//MUtils
 #include &lt;MUtils/Global.h&gt;
@@ -74,19 +77,19 @@ int main(int argc, char **argv)
 {
     qDebug(&quot;Random number: %u\n&quot;, MUtils::next_rand_u32());
 }</code></pre>
-<h2 id="build-notes"><span class="header-section-number">3.1</span> Build Notes</h2>
+<h2 data-number="3.1" id="build-notes"><span class="header-section-number">3.1</span> Build Notes</h2>
 <ul>
 <li>In order to use the <em>MUtilities</em> library in your project, your build environment must have already been set up for building Qt-based projects. Setting up Qt is <em>not</em> covered by this document.</li>
-<li>Additionally, make sure that <em>MUtilities'</em> <code>include/</code> directory is contained in your &quot;Additional Include Directories&quot; and that the <em>MUtilities'</em> <code>bin/</code> directory is contained in your &quot;Additional Library Directories&quot;.</li>
+<li>Additionally, make sure that <em>MUtilities'</em> <code>include/</code> directory is contained in your "Additional Include Directories" and that the <em>MUtilities'</em> <code>bin/</code> directory is contained in your "Additional Library Directories".</li>
 <li>Finally, make sure that your project links against the <code>MUtils32-1.lib</code> library file. For each build configuration, pick the proper <strong>.lib</strong> file from the corresponding <code>bin/&lt;platform&gt;/&lt;config&gt;/</code> directory!</li>
-<li>If your projects intends to use the <em>MUtilities</em> library as a <strong>static</strong> library, then the macro <code>MUTILS_STATIC_LIB</code> <em>must</em> be added to your project's &quot;Preprocessor Definitions&quot;.</li>
+<li>If your projects intends to use the <em>MUtilities</em> library as a <strong>static</strong> library, then the macro <code>MUTILS_STATIC_LIB</code> <em>must</em> be added to your project's "Preprocessor Definitions".</li>
 </ul>
-<h1 id="api-documentation"><span class="header-section-number">4</span> API Documentation</h1>
+<h1 data-number="4" id="api-documentation"><span class="header-section-number">4</span> API Documentation</h1>
 <p>A fully-fledged documentation of the <em>MUtilities</em> programming interface (API) is available thanks to <a href="http://www.stack.nl/~dimitri/doxygen/"><em>Doxygen</em></a>. Please see <a href="docs/index.html"><strong><code>docs/index.html</code></strong></a> for details!</p>
-<h1 id="license"><span class="header-section-number">5</span> License</h1>
+<h1 data-number="5" id="license"><span class="header-section-number">5</span> License</h1>
 <p>This library is free software. It is released under the terms of the <a href="https://www.gnu.org/licenses/lgpl-2.1.html"><em>GNU Lesser General Public License (LGPL), Version 2.1</em></a>.</p>
 <pre><code>MUtilities - MuldeR&#39;s Utilities for Qt
-Copyright (C) 2004-2019 LoRd_MuldeR &lt;MuldeR2@GMX.de&gt;. Some rights reserved.
+Copyright (C) 2004-2021 LoRd_MuldeR &lt;MuldeR2@GMX.de&gt;. 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
@@ -101,15 +104,10 @@ 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.</code></pre>
-<h1 id="acknowledgement"><span class="header-section-number">6</span> Acknowledgement</h1>
+<h1 data-number="6" id="acknowledgement"><span class="header-section-number">6</span> Acknowledgement</h1>
 <p>The following people have contributed in the development of the MUtilities library:</p>
 <ul>
-<li><strong>John Buonagurio &lt;<script type="text/javascript">
-<!--
-h='&#x65;&#120;&#112;&#x6f;&#110;&#x65;&#110;&#116;&#46;&#x63;&#x6f;&#x6d;';a='&#64;';n='&#106;&#98;&#x75;&#x6f;&#110;&#x61;&#x67;&#x75;&#114;&#x69;&#x6f;';e=n+a+h;
-document.write('<a h'+'ref'+'="ma'+'ilto'+':'+e+'" clas'+'s="em' + 'ail">'+e+'<\/'+'a'+'>');
-// -->
-</script><noscript>&#106;&#98;&#x75;&#x6f;&#110;&#x61;&#x67;&#x75;&#114;&#x69;&#x6f;&#32;&#x61;&#116;&#32;&#x65;&#120;&#112;&#x6f;&#110;&#x65;&#110;&#116;&#32;&#100;&#x6f;&#116;&#32;&#x63;&#x6f;&#x6d;</noscript>&gt;</strong><br />
+<li><strong>John Buonagurio &lt;<a href="mailto:jbuonagurio@exponent.com" class="email">jbuonagurio@exponent.com</a>&gt;</strong><br />
 Support for Qt5</li>
 </ul>
 <p>The following third-party code is used in the MUtilities library:</p>
@@ -118,12 +116,7 @@ Support for Qt5</li>
 Implementation by the Keccak, Keyak and Ketje Teams, namely, Guido Bertoni, Joan Daemen, Michaël Peeters, Gilles Van Assche and Ronny Van Keer<br />
 No Copyright / Dedicated to the Public Domain</p></li>
 <li><p><strong>Natural Order String Comparison</strong><br />
-Copyright (C) 2000, 2004 by Martin Pool &lt;<script type="text/javascript">
-<!--
-h='&#x73;&#x6f;&#x75;&#114;&#x63;&#x65;&#102;&#114;&#x6f;&#x67;&#46;&#110;&#x65;&#116;';a='&#64;';n='&#x6d;&#98;&#112;';e=n+a+h;
-document.write('<a h'+'ref'+'="ma'+'ilto'+':'+e+'" clas'+'s="em' + 'ail">'+e+'<\/'+'a'+'>');
-// -->
-</script><noscript>&#x6d;&#98;&#112;&#32;&#x61;&#116;&#32;&#x73;&#x6f;&#x75;&#114;&#x63;&#x65;&#102;&#114;&#x6f;&#x67;&#32;&#100;&#x6f;&#116;&#32;&#110;&#x65;&#116;</noscript>&gt;<br />
+Copyright (C) 2000, 2004 by Martin Pool &lt;<a href="mailto:mbp@sourcefrog.net" class="email">mbp@sourcefrog.net</a>&gt;<br />
 Released under the zlib License</p></li>
 <li><p><strong>Adler-32 Checksum Algorithm (from zlib)</strong><br />
 Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler<br />