deploy: 1ce42ea

Author: NewYaroslav

doxygen_crawl.html

@@ -934,13 +934,19 @@
 <a href="groups__mql5_8dox.html"/>
 <a href="index.html"/>
 <a href="index.html#config_sec"/>
+<a href="index.html#docs_sec"/>
 <a href="index.html#examples_sec"/>
 <a href="index.html#features_sec"/>
+<a href="index.html#install_pkg"/>
 <a href="index.html#install_sec"/>
+<a href="index.html#install_submodule"/>
+<a href="index.html#install_vcpkg"/>
 <a href="index.html#intro_sec"/>
+<a href="index.html#invariants_sec"/>
 <a href="index.html#license_sec"/>
 <a href="index.html#motivation_sec"/>
 <a href="index.html#repo_sec"/>
+<a href="index.html#tested_sec"/>
 <a href="initialization_8hpp.html"/>
 <a href="initialization_8hpp_source.html"/>
 <a href="initialization_8mqh.html"/>

index.html

@@ -144,6 +144,14 @@ <h1><a class="anchor" id="config_sec"></a>
 <li><code>TIME_SHIELD_ENABLE_NTP_CLIENT</code> — builds the NTP client when set to <code>1</code>.</li>
 </ul>
 <p>All public symbols are declared inside the <code><a class="el" href="namespacetime__shield.html" title="Main namespace for the Time Shield library.">time_shield</a></code> namespace.</p>
+<h1><a class="anchor" id="invariants_sec"></a>
+API Invariants</h1>
+<ul>
+<li><code>ts_t</code> represents Unix time in seconds as a signed 64-bit integer with microsecond precision available through conversions.</li>
+<li><code>fts_t</code> stores time as double precision seconds; conversions maintain microsecond accuracy.</li>
+<li>ISO8601 parsing assumes the proleptic Gregorian calendar without leap seconds.</li>
+<li>Functions avoid throwing exceptions and use no dynamic memory internally; utilities returning <code>std::string</code> rely on the caller for allocations.</li>
+</ul>
 <h1><a class="anchor" id="examples_sec"></a>
 Examples</h1>
 <p>Here is a simple demonstration:</p>
@@ -186,23 +194,54 @@ <h1><a class="anchor" id="examples_sec"></a>
 </ul>
 <h1><a class="anchor" id="install_sec"></a>
 Installation</h1>
-<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>
+<h2><a class="anchor" id="install_pkg"></a>
+Install and <code>find_package</code></h2>
+<p>After installing the library (e.g., via <code>cmake --install</code>), locate it with <code>find_package</code>:</p>
+<div class="fragment"><div class="line">cmake_minimum_required(VERSION 3.18)</div>
+<div class="line">project(app LANGUAGES CXX)</div>
+<div class="line"> </div>
+<div class="line">find_package(TimeShield CONFIG REQUIRED)</div>
+<div class="line"> </div>
+<div class="line">add_executable(app main.cpp)</div>
+<div class="line">target_link_libraries(app PRIVATE time_shield::time_shield)</div>
+</div><!-- fragment --><h2><a class="anchor" id="install_submodule"></a>
+Git submodule with <code>add_subdirectory</code></h2>
+<p>Vendor the library as a submodule:</p>
+<div class="fragment"><div class="line">git submodule add https://github.com/NewYaroslav/time-shield-cpp external/time-shield-cpp</div>
+</div><!-- fragment --><p>Then include it:</p>
+<div class="fragment"><div class="line">add_subdirectory(external/time-shield-cpp)</div>
+<div class="line"> </div>
+<div class="line">add_executable(app main.cpp)</div>
+<div class="line">target_link_libraries(app PRIVATE time_shield::time_shield)</div>
+</div><!-- fragment --><h2><a class="anchor" id="install_vcpkg"></a>
+vcpkg overlay</h2>
+<p>Install via a local overlay port:</p>
+<div class="fragment"><div class="line">vcpkg install time-shield-cpp --overlay-ports=./vcpkg-overlay/ports</div>
+</div><!-- fragment --><p>Use the vcpkg toolchain when configuring CMake:</p>
+<div class="fragment"><div class="line">cmake -B build -S . -DCMAKE_TOOLCHAIN_FILE=/path/to/vcpkg/scripts/buildsystems/vcpkg.cmake</div>
+</div><!-- fragment --><p>The port is intended to be upstreamed to microsoft/vcpkg.</p>
+<p>For MQL5/MetaTrader, run <code>install_mql5.bat</code> to copy the <code>.mqh</code> files to your include directory.</p>
+<p>To build the C++ examples use the helper scripts:</p>
 <ul>
-<li>Run <code>build-examples.bat</code> to compile example programs with MSVC or your preferred toolchain.</li>
+<li><code>build-examples.bat</code> for Windows</li>
+<li><code>build_examples.sh</code> for Linux/macOS</li>
+<li><code>build-cb.bat</code> to generate a Code::Blocks project</li>
 </ul>
+<h1><a class="anchor" id="tested_sec"></a>
+Tested Platforms</h1>
+<table class="markdownTable">
+<tr class="markdownTableHead">
+<th class="markdownTableHeadNone">Platform   </th><th class="markdownTableHeadNone">Compilers   </th><th class="markdownTableHeadNone">C++ Standards    </th></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyNone">Windows   </td><td class="markdownTableBodyNone">MSVC, ClangCL   </td><td class="markdownTableBodyNone">11, 14, 17    </td></tr>
+<tr class="markdownTableRowEven">
+<td class="markdownTableBodyNone">Linux   </td><td class="markdownTableBodyNone">GCC, Clang   </td><td class="markdownTableBodyNone">11, 14, 17    </td></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyNone">macOS   </td><td class="markdownTableBodyNone">Apple Clang   </td><td class="markdownTableBodyNone">11, 14, 17   </td></tr>
+</table>
+<h1><a class="anchor" id="docs_sec"></a>
+Online Documentation</h1>
+<p>The latest generated API reference is available at newyaroslav.github.io/time-shield-cpp.</p>
 <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

@@ -29,8 +29,15 @@ var NAVTREE =
     [ "Why Time Shield?", "index.html#motivation_sec", null ],
     [ "Features", "index.html#features_sec", null ],
     [ "Configuration", "index.html#config_sec", null ],
+    [ "API Invariants", "index.html#invariants_sec", null ],
     [ "Examples", "index.html#examples_sec", null ],
-    [ "Installation", "index.html#install_sec", null ],
+    [ "Installation", "index.html#install_sec", [
+      [ "Install and find_package", "index.html#install_pkg", null ],
+      [ "Git submodule with add_subdirectory", "index.html#install_submodule", null ],
+      [ "vcpkg overlay", "index.html#install_vcpkg", null ]
+    ] ],
+    [ "Tested Platforms", "index.html#tested_sec", null ],
+    [ "Online Documentation", "index.html#docs_sec", null ],
     [ "Repository", "index.html#repo_sec", null ],
     [ "License", "index.html#license_sec", null ],
     [ "Topics", "topics.html", "topics" ],
@@ -71,7 +78,7 @@ var NAVTREEINDEX =
 "group__time__conversions.html#ga921fb410961c8321bd21b83a5569c8d4",
 "group__time__enums.html#gga5fa51beb76e014adfffcd028fe1804aca44f6ae61dc2e43df007f846b8ea4acf9",
 "group__time__structures.html#ga1721af7fc3d8b705db317fd69c4c520e",
-"time__utils_8hpp_source.html"
+"time__shield_8hpp_source.html"
 ];
 
 var SYNCONMSG = 'click to disable panel synchronization';