Publish 'docs/html' to 'gh-pages' in 'NewYaroslav/time-shield-cpp'

Author: NewYaroslav

doxygen_crawl.html

@@ -891,10 +891,12 @@
 <a href="groups_8dox.html"/>
 <a href="groups__mql5_8dox.html"/>
 <a href="index.html"/>
+<a href="index.html#examples_sec"/>
 <a href="index.html#features_sec"/>
 <a href="index.html#install_sec"/>
 <a href="index.html#intro_sec"/>
 <a href="index.html#license_sec"/>
+<a href="index.html#motivation_sec"/>
 <a href="index.html#repo_sec"/>
 <a href="index.html#usage_sec"/>
 <a href="initialization_8hpp.html"/>

index.html

@@ -111,21 +111,32 @@
   <div class="headertitle"><div class="title">Time Shield Library </div></div>
 </div><!--header-->
 <div class="contents">
-<div class="textblock"><p><b>Version:</b> <code>1.0.0</code></p>
+<div class="textblock"><p><b>Version:</b> <code>1.0.1</code></p>
 <h1><a class="anchor" id="intro_sec"></a>
 Introduction</h1>
-<p>The Time Shield Library is a comprehensive C++ library designed for time manipulation, formatting, and conversion. This library aims to provide a robust and flexible set of tools for handling various time-related tasks with ease.</p>
+<p>The Time Shield Library is a comprehensive C++ library designed for time manipulation, formatting, and conversion. It was built for practical and engineering tasks, especially in constrained or performance-critical environments.</p>
+<h1><a class="anchor" id="motivation_sec"></a>
+Why Time Shield?</h1>
+<p>Unlike <code>std::chrono</code> or more academic libraries like <code>HowardHinnant/date</code>, Time Shield is designed to be simple, portable, and suitable for scenarios like logging, serialization, MQL5 usage, and date/time formatting.</p>
+<ul>
+<li>Uses simple types (<code>int64_t</code>, <code>double</code>) like <code>ts_t</code>, <code>fts_t</code> for timestamps — easy to serialize and store.</li>
+<li>Supports multiple time representations: Unix, floating-point seconds, ms/us precision, OLE Automation, Julian dates.</li>
+<li>Includes utilities for rounding, ISO8601 formatting/parsing, time parts, and boundary calculations.</li>
+<li>Header-only and cross-platform; most modules require only STL and <code>&lt;cstdint&gt;</code>.</li>
+<li>MQL5-compatible — does not use exceptions, STL containers, or dynamic memory.</li>
+<li>Modules requiring platform-specific APIs (like <code>NtpClient</code>) are isolated and optional.</li>
+</ul>
 <h1><a class="anchor" id="features_sec"></a>
 Features</h1>
 <ul>
 <li>Validation of dates and times</li>
-<li>Time and date formatting</li>
-<li>Time zone calculations</li>
-<li>Conversion between different time representations</li>
-<li>Utilities for time manipulation</li>
+<li>Time and date formatting (standard and custom)</li>
+<li>Time zone conversion functions</li>
+<li>ISO8601 string parsing</li>
+<li>Utilities for time manipulation and conversion</li>
 </ul>
 <h1><a class="anchor" id="usage_sec"></a>
-Usage</h1>
+Example</h1>
 <div class="fragment"><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="time__shield_8hpp.html">time_shield.hpp</a>&gt;</span></div>
 <div class="line"> </div>
 <div class="line"><span class="keywordtype">int</span> <a class="code hl_function" href="ntp__client__example_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>() {</div>
@@ -154,9 +165,36 @@ <h1><a class="anchor" id="usage_sec"></a>
 <div class="ttc" id="agroup__time__utils_html_ga450be3ba3ddf294da4c9bc4cd01f8216"><div class="ttname"><a href="group__time__utils.html#ga450be3ba3ddf294da4c9bc4cd01f8216">time_shield::timestamp</a></div><div class="ttdeci">const ts_t timestamp() noexcept</div><div class="ttdoc">Get the current UTC timestamp in seconds.</div><div class="ttdef"><b>Definition</b> <a href="time__utils_8hpp_source.html#l00131">time_utils.hpp:131</a></div></div>
 <div class="ttc" id="antp__client__example_8cpp_html_ae66f6b31b5ad750f1fe042a706a4e3d4"><div class="ttname"><a href="ntp__client__example_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div><div class="ttdeci">int main()</div><div class="ttdef"><b>Definition</b> <a href="ntp__client__example_8cpp_source.html#l00055">ntp_client_example.cpp:55</a></div></div>
 <div class="ttc" id="atime__shield_8hpp_html"><div class="ttname"><a href="time__shield_8hpp.html">time_shield.hpp</a></div><div class="ttdoc">Main header file for the Time Shield library.</div></div>
-</div><!-- fragment --><h1><a class="anchor" id="install_sec"></a>
+</div><!-- fragment --><h1><a class="anchor" id="examples_sec"></a>
+Examples</h1>
+<p>Located in the <code>examples/</code> folder:</p>
+<ul>
+<li><code><a class="el" href="time__utils__example_8cpp.html" title="Demonstrates functions from time_shield::time_utils.">time_utils_example.cpp</a></code> — get timestamps and parts</li>
+<li><code><a class="el" href="time__formatting__example_8cpp.html" title="Demonstrates functions from time_shield::time_formatting.">time_formatting_example.cpp</a></code> — to_string, ISO8601, MQL5</li>
+<li><code><a class="el" href="time__parser__example_8cpp.html" title="Demonstrates functions from time_shield::time_parser.">time_parser_example.cpp</a></code> — parse ISO8601</li>
+<li><code><a class="el" href="time__conversions__example_8cpp.html" title="Demonstrates functions from time_shield::time_conversions.">time_conversions_example.cpp</a></code> — convert between formats</li>
+<li><code><a class="el" href="time__zone__conversions__example_8cpp.html" title="Demonstrates functions from time_shield::time_zone_conversions.">time_zone_conversions_example.cpp</a></code> — CET/EET ↔ GMT</li>
+<li><code><a class="el" href="ntp__client__example_8cpp.html" title="Demonstrates usage of time_shield::NtpClient.">ntp_client_example.cpp</a></code> — NTP sync (Windows-only)</li>
+</ul>
+<h1><a class="anchor" id="install_sec"></a>
 Installation</h1>
-<p>To use the Time Shield Library in your project, include the header file <code><a class="el" href="time__shield_8hpp.html" title="Main header file for the Time Shield library.">time_shield.hpp</a></code> in your source code. Ensure that your project is set up to compile with standards from C++11 to C++17.</p>
+<p>Time Shield is a header-only library. To use it in your C++ project:</p>
+<ul>
+<li>Add the <code>include/time_shield_cpp</code> folder to your project's include paths.</li>
+<li>Include the main header:</li>
+</ul>
+<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="time__shield_8hpp.html">time_shield.hpp</a>&gt;</span></div>
+</div><!-- fragment --><p>No additional build steps or external dependencies are required.</p>
+<p>For MQL5/MetaTrader:</p>
+<ul>
+<li>Run <code>install_mql5.bat</code> to copy the necessary <code>.mqh</code> files to your MQL5 include directory.</li>
+<li>Include the main file in your MQL5 script:</li>
+</ul>
+<div class="fragment"><div class="line">#include &lt;TimeShield.mqh&gt;</div>
+</div><!-- fragment --><p>To build the C++ examples:</p>
+<ul>
+<li>Run <code>build-examples.bat</code> to compile example programs with MSVC or your preferred toolchain.</li>
+</ul>
 <h1><a class="anchor" id="repo_sec"></a>
 Repository</h1>
 <p><a href="https://github.com/NewYaroslav/time-shield-cpp">Time Shield Library GitHub repository</a></p>

navtreedata.js

@@ -26,8 +26,10 @@ var NAVTREE =
 [
   [ "Time Shield Library", "index.html", [
     [ "Introduction", "index.html#intro_sec", null ],
+    [ "Why Time Shield?", "index.html#motivation_sec", null ],
     [ "Features", "index.html#features_sec", null ],
-    [ "Usage", "index.html#usage_sec", null ],
+    [ "Example", "index.html#usage_sec", null ],
+    [ "Examples", "index.html#examples_sec", null ],
     [ "Installation", "index.html#install_sec", null ],
     [ "Repository", "index.html#repo_sec", null ],
     [ "License", "index.html#license_sec", null ],