Skip to content

Commit

Permalink
Update libnick docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nlogozzo committed Jul 8, 2024
1 parent e32f602 commit f916398
Show file tree
Hide file tree
Showing 27 changed files with 86 additions and 100 deletions.
6 changes: 2 additions & 4 deletions docs/libnick/doxygen_crawl.html
Original file line number Diff line number Diff line change
Expand Up @@ -831,8 +831,6 @@
<a href="index.html#autotoc_md26"/>
<a href="index.html#autotoc_md27"/>
<a href="index.html#autotoc_md28"/>
<a href="index.html#autotoc_md29"/>
<a href="index.html#autotoc_md30"/>
<a href="index.html#autotoc_md6"/>
<a href="index.html#autotoc_md7"/>
<a href="index.html#autotoc_md8"/>
Expand Down Expand Up @@ -917,9 +915,9 @@
<a href="namespace_nickvision_1_1_helpers_1_1_string_helpers.html#aa8c01477f778b9ee01d6428f77f06894"/>
<a href="namespace_nickvision_1_1_helpers_1_1_string_helpers.html#aab30b376853a003cd472c7c1237ff555"/>
<a href="namespace_nickvision_1_1_helpers_1_1_string_helpers.html#ab4e773ed06578f94e8681d92ab391ab6"/>
<a href="namespace_nickvision_1_1_helpers_1_1_string_helpers.html#ab7dfa1729b5862f7e707d0c3c4b5112d"/>
<a href="namespace_nickvision_1_1_helpers_1_1_string_helpers.html#aba6f15d091f02ecaa513e260bd0b603f"/>
<a href="namespace_nickvision_1_1_helpers_1_1_string_helpers.html#ac190bdeb28cfa3cc79e03e84f401263a"/>
<a href="namespace_nickvision_1_1_helpers_1_1_string_helpers.html#aee4d1db22614b18367df4fef47f3bc00"/>
<a href="namespace_nickvision_1_1_helpers_1_1_string_helpers.html#af0f3a4f3297882aa3154d6515ec94ad4"/>
<a href="namespace_nickvision_1_1_helpers_1_1_string_helpers.html#afe6a384f9e68cbd2bee687bf435a2657"/>
<a href="namespace_nickvision_1_1_keyring.html"/>
Expand Down Expand Up @@ -1108,9 +1106,9 @@
<a href="stringhelpers_8h.html#aab30b376853a003cd472c7c1237ff555"/>
<a href="stringhelpers_8h.html#ab327acd0a24a2ccb9dfc3af0a807172f"/>
<a href="stringhelpers_8h.html#ab4e773ed06578f94e8681d92ab391ab6"/>
<a href="stringhelpers_8h.html#ab7dfa1729b5862f7e707d0c3c4b5112d"/>
<a href="stringhelpers_8h.html#aba6f15d091f02ecaa513e260bd0b603f"/>
<a href="stringhelpers_8h.html#ac190bdeb28cfa3cc79e03e84f401263a"/>
<a href="stringhelpers_8h.html#aee4d1db22614b18367df4fef47f3bc00"/>
<a href="stringhelpers_8h.html#af0f3a4f3297882aa3154d6515ec94ad4"/>
<a href="stringhelpers_8h.html#afe6a384f9e68cbd2bee687bf435a2657"/>
<a href="suspendinhibitor_8h.html"/>
Expand Down
61 changes: 25 additions & 36 deletions docs/libnick/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,39 +93,28 @@
<p><b>A cross-platform base for native <a class="el" href="namespace_nickvision.html">Nickvision</a> applications.</b></p>
<p>libnick provides <a class="el" href="namespace_nickvision.html">Nickvision</a> apps with a common set of cross-platform APIs for managing system and desktop app functionality such as network management, taskbar icons, translations, app updates, and more.</p>
<h1><a class="anchor" id="autotoc_md6"></a>
2024.7.0</h1>
2024.7.1</h1>
<h2><a class="anchor" id="autotoc_md7"></a>
Breaking Changes</h2>
<h3><a class="anchor" id="autotoc_md8"></a>
Filesystem</h3>
Helpers</h3>
<ul>
<li>Removed application directories from <code><a class="el" href="namespace_nickvision_1_1_filesystem.html#ad36e956435e29b3f3a7a3a4aaeef7cda" title="Supported user directories.">Nickvision::Filesystem::UserDirectory</a></code> enum </li>
<li>The default value of <code>StringHelpers::join</code>'s <code>separateLast</code> parameter is now <code>false</code> </li>
</ul>
<h2><a class="anchor" id="autotoc_md9"></a>
New APIs</h2>
<h3><a class="anchor" id="autotoc_md10"></a>
Filesystem</h3>
<ul>
<li>Added <code><a class="el" href="namespace_nickvision_1_1_filesystem.html#a4717a89817d6be7efd53d2fc45261238" title="Supported application user directories.">Nickvision::Filesystem::ApplicationUserDirectory</a></code> enum</li>
<li>Added <code><a class="el" href="namespace_nickvision_1_1_filesystem_1_1_user_directories.html#ad7d5e368c05fcf0d2b2b3a9729960e14" title="Gets the path of a user directory.">Nickvision::Filesystem::UserDirectories::get()</a></code> function overload for <code><a class="el" href="namespace_nickvision_1_1_filesystem.html#a4717a89817d6be7efd53d2fc45261238" title="Supported application user directories.">Nickvision::Filesystem::ApplicationUserDirectory</a></code> support </li>
</ul>
<h3><a class="anchor" id="autotoc_md11"></a>
Helpers</h3>
<ul>
<li>Added <code><a class="el" href="namespace_nickvision_1_1_helpers_1_1_string_helpers.html#a9a875c80187b20111e113a3c5b5107c4" title="Normalizes a string for use in a filename.">Nickvision::Helpers::StringHelpers::normalizeForFilename()</a></code></li>
<li>Added <code><a class="el" href="namespace_nickvision_1_1_helpers_1_1_string_helpers.html#af0f3a4f3297882aa3154d6515ec94ad4" title="Replaces a substring within a string with a new string.">Nickvision::Helpers::StringHelpers::replace()</a></code> character overload </li>
</ul>
<h2><a class="anchor" id="autotoc_md12"></a>
<p>None </p>
<h2><a class="anchor" id="autotoc_md10"></a>
Fixes</h2>
<h3><a class="anchor" id="autotoc_md13"></a>
Update</h3>
<h3><a class="anchor" id="autotoc_md11"></a>
System</h3>
<ul>
<li>Fixed an issue where <code>Nickvision::Update::Updater::windowsUpdate()</code> did not work correctly</li>
<li>Fixed an issue where <code>SuspendInhibitor</code> did not work correctly on Linux systems</li>
</ul>
<h1><a class="anchor" id="autotoc_md14"></a>
<h1><a class="anchor" id="autotoc_md12"></a>
Dependencies</h1>
<p>The following are a list of dependencies used by libnick.</p>
<h2><a class="anchor" id="autotoc_md15"></a>
<h2><a class="anchor" id="autotoc_md13"></a>
All Platforms</h2>
<ul>
<li>gtest</li>
Expand All @@ -134,12 +123,12 @@ <h2><a class="anchor" id="autotoc_md15"></a>
<li>libintl</li>
<li>maddy</li>
</ul>
<h2><a class="anchor" id="autotoc_md16"></a>
<h2><a class="anchor" id="autotoc_md14"></a>
Windows</h2>
<p>The above dependencies must be installed, <em>plus</em> the following for Windows systems:</p><ul>
<li>sqlcipher</li>
</ul>
<h2><a class="anchor" id="autotoc_md17"></a>
<h2><a class="anchor" id="autotoc_md15"></a>
Linux</h2>
<p>The above dependencies must be installed, <em>plus</em> the following for Linux systems:</p><ul>
<li>glib</li>
Expand All @@ -150,7 +139,7 @@ <h2><a class="anchor" id="autotoc_md17"></a>
</ul>
</li>
</ul>
<h2><a class="anchor" id="autotoc_md18"></a>
<h2><a class="anchor" id="autotoc_md16"></a>
macOS</h2>
<p>The above dependencies must be installed, <em>plus</em> the following for macOS systems:</p><ul>
<li>glib</li>
Expand All @@ -160,55 +149,55 @@ <h2><a class="anchor" id="autotoc_md18"></a>
</ul>
</li>
</ul>
<h1><a class="anchor" id="autotoc_md19"></a>
<h1><a class="anchor" id="autotoc_md17"></a>
Consuming libnick via vcpkg</h1>
<p>libnick is available through <code>vcpkg</code>.</p>
<p>Simply install and configure vcpkg for your system, and run: </p><div class="fragment"><div class="line">vcpkg install libnick</div>
</div><!-- fragment --><p> You can then use libnick from cmake with the following: </p><div class="fragment"><div class="line">find_package(libnick CONFIG REQUIRED)</div>
<div class="line">target_link_libraries(main PRIVATE libnick::libnick)</div>
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md20"></a>
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md18"></a>
Building and Installing Manually</h1>
<p>libnick uses <code>vcpkg</code> to manage its dependencies and <code>cmake</code> as its build system.</p>
<p>Ensure both <code>vcpkg</code> and <code>cmake</code> are installed on your system before building and installing libnick.</p>
<p>A C++20 compiler is also required to build libnick.</p>
<h2><a class="anchor" id="autotoc_md21"></a>
<h2><a class="anchor" id="autotoc_md19"></a>
Configuring vcpkg</h2>
<ol type="1">
<li>Set the <code>VCPKG_ROOT</code> environment variable to the path of your vcpkg installation's root directory. </li>
</ol>
<h3><a class="anchor" id="autotoc_md22"></a>
<h3><a class="anchor" id="autotoc_md20"></a>
Windows</h3>
<ol type="1">
<li>Set the <code>VCPKG_DEFAULT_TRIPLET</code> environment variable to <code>x64-windows</code></li>
</ol>
<ol type="1">
<li>Run <code>vcpkg install curl gettext-libintl gtest jsoncpp maddy sqlcipher</code> </li>
</ol>
<h3><a class="anchor" id="autotoc_md23"></a>
<h3><a class="anchor" id="autotoc_md21"></a>
Linux</h3>
<ol type="1">
<li>Set the <code>VCPKG_DEFAULT_TRIPLET</code> environment variable to <code>x64-linux</code></li>
</ol>
<ol type="1">
<li>Run <code>vcpkg install curl gettext-libintl glib gtest jsoncpp libsecret libuuid maddy openssl</code> </li>
</ol>
<h3><a class="anchor" id="autotoc_md24"></a>
<h3><a class="anchor" id="autotoc_md22"></a>
macOS (Intel)</h3>
<ol type="1">
<li>Set the <code>VCPKG_DEFAULT_TRIPLET</code> environment variable to <code>x64-osx</code></li>
</ol>
<ol type="1">
<li>Run <code>vcpkg install curl gettext-libintl glib gtest jsoncpp libsecret maddy openssl</code> </li>
</ol>
<h3><a class="anchor" id="autotoc_md25"></a>
<h3><a class="anchor" id="autotoc_md23"></a>
macOS (Apple Silicon)</h3>
<ol type="1">
<li>Set the <code>VCPKG_DEFAULT_TRIPLET</code> environment variable to <code>arm64-osx</code></li>
</ol>
<ol type="1">
<li>Run <code>vcpkg install curl gettext-libintl glib gtest jsoncpp libsecret maddy openssl</code></li>
</ol>
<h2><a class="anchor" id="autotoc_md26"></a>
<h2><a class="anchor" id="autotoc_md24"></a>
Building</h2>
<ol type="1">
<li>First, clone/download the repo.</li>
Expand All @@ -219,7 +208,7 @@ <h2><a class="anchor" id="autotoc_md26"></a>
<ol type="1">
<li>Create a new <code>build</code> directory and <code>cd</code> into it. </li>
</ol>
<h3><a class="anchor" id="autotoc_md27"></a>
<h3><a class="anchor" id="autotoc_md25"></a>
Windows</h3>
<ol type="1">
<li>From the <code>build</code> folder, run <code>cmake .. -G "Visual Studio 17 2022"</code>.<ul>
Expand All @@ -234,7 +223,7 @@ <h3><a class="anchor" id="autotoc_md27"></a>
<ol type="1">
<li>After these commands complete, libnick will be successfully built and its binaries can be found in the <code>Release</code> folder of the <code>build</code> folder. </li>
</ol>
<h3><a class="anchor" id="autotoc_md28"></a>
<h3><a class="anchor" id="autotoc_md26"></a>
Linux</h3>
<ol type="1">
<li>From the <code>build</code> folder, run <code>cmake .. -DCMAKE_BUILD_TYPE=Release</code>.<ul>
Expand All @@ -249,7 +238,7 @@ <h3><a class="anchor" id="autotoc_md28"></a>
<ol type="1">
<li>After these commands complete, libnick will be successfully built and its binaries can be found in the <code>build</code> folder. </li>
</ol>
<h3><a class="anchor" id="autotoc_md29"></a>
<h3><a class="anchor" id="autotoc_md27"></a>
macOS</h3>
<ol type="1">
<li>From the <code>build</code> folder, run <code>cmake .. -DCMAKE_BUILD_TYPE=Release</code>.<ul>
Expand All @@ -264,7 +253,7 @@ <h3><a class="anchor" id="autotoc_md29"></a>
<ol type="1">
<li>After these commands complete, libnick will be successfully built and its binaries can be found in the <code>build</code> folder.</li>
</ol>
<h2><a class="anchor" id="autotoc_md30"></a>
<h2><a class="anchor" id="autotoc_md28"></a>
Installing</h2>
<ol type="1">
<li>To install libnick to the system, from the <code>build</code> folder, run <code>cmake --install .</code>.<ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,9 @@
<tr class="memitem:a4ec483a6f43eacbc1ba01c76ac778205" id="r_a4ec483a6f43eacbc1ba01c76ac778205"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4ec483a6f43eacbc1ba01c76ac778205">isValidUrl</a> (const std::string &amp;s)</td></tr>
<tr class="memdesc:a4ec483a6f43eacbc1ba01c76ac778205"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets whether or not the provided string is a valid url. <br /></td></tr>
<tr class="separator:a4ec483a6f43eacbc1ba01c76ac778205"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee4d1db22614b18367df4fef47f3bc00" id="r_aee4d1db22614b18367df4fef47f3bc00"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aee4d1db22614b18367df4fef47f3bc00">join</a> (const std::vector&lt; std::string &gt; &amp;values, const std::string &amp;separator, bool separateLast=true)</td></tr>
<tr class="memdesc:aee4d1db22614b18367df4fef47f3bc00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Concatenates the elements of a string list using the specified separator between each element. <br /></td></tr>
<tr class="separator:aee4d1db22614b18367df4fef47f3bc00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7dfa1729b5862f7e707d0c3c4b5112d" id="r_ab7dfa1729b5862f7e707d0c3c4b5112d"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab7dfa1729b5862f7e707d0c3c4b5112d">join</a> (const std::vector&lt; std::string &gt; &amp;values, const std::string &amp;separator, bool separateLast=false)</td></tr>
<tr class="memdesc:ab7dfa1729b5862f7e707d0c3c4b5112d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Concatenates the elements of a string list using the specified separator between each element. <br /></td></tr>
<tr class="separator:ab7dfa1729b5862f7e707d0c3c4b5112d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d435349b1fc5726a5bcc2a7c6b8fca4" id="r_a7d435349b1fc5726a5bcc2a7c6b8fca4"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7d435349b1fc5726a5bcc2a7c6b8fca4">lower</a> (std::string s)</td></tr>
<tr class="memdesc:a7d435349b1fc5726a5bcc2a7c6b8fca4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a fully lowercase string from the provided string. <br /></td></tr>
<tr class="separator:a7d435349b1fc5726a5bcc2a7c6b8fca4"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -236,8 +236,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a4ec483a6f43eacbc1ba01c76

</div>
</div>
<a id="aee4d1db22614b18367df4fef47f3bc00" name="aee4d1db22614b18367df4fef47f3bc00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee4d1db22614b18367df4fef47f3bc00">&#9670;&#160;</a></span>join()</h2>
<a id="ab7dfa1729b5862f7e707d0c3c4b5112d" name="ab7dfa1729b5862f7e707d0c3c4b5112d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7dfa1729b5862f7e707d0c3c4b5112d">&#9670;&#160;</a></span>join()</h2>

<div class="memitem">
<div class="memproto">
Expand All @@ -255,7 +255,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aee4d1db22614b18367df4fef
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>separateLast</em></span><span class="paramdefsep"> = </span><span class="paramdefval">true</span>&#160;)</td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>separateLast</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
Expand Down
2 changes: 1 addition & 1 deletion docs/libnick/namespacemembers.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ <h3><a id="index_i" name="index_i"></a>- i -</h3><ul>


<h3><a id="index_j" name="index_j"></a>- j -</h3><ul>
<li>join()&#160;:&#160;<a class="el" href="namespace_nickvision_1_1_helpers_1_1_string_helpers.html#aee4d1db22614b18367df4fef47f3bc00">Nickvision::Helpers::StringHelpers</a></li>
<li>join()&#160;:&#160;<a class="el" href="namespace_nickvision_1_1_helpers_1_1_string_helpers.html#ab7dfa1729b5862f7e707d0c3c4b5112d">Nickvision::Helpers::StringHelpers</a></li>
</ul>


Expand Down
2 changes: 1 addition & 1 deletion docs/libnick/namespacemembers_func.html
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ <h3><a id="index_i" name="index_i"></a>- i -</h3><ul>


<h3><a id="index_j" name="index_j"></a>- j -</h3><ul>
<li>join()&#160;:&#160;<a class="el" href="namespace_nickvision_1_1_helpers_1_1_string_helpers.html#aee4d1db22614b18367df4fef47f3bc00">Nickvision::Helpers::StringHelpers</a></li>
<li>join()&#160;:&#160;<a class="el" href="namespace_nickvision_1_1_helpers_1_1_string_helpers.html#ab7dfa1729b5862f7e707d0c3c4b5112d">Nickvision::Helpers::StringHelpers</a></li>
</ul>


Expand Down
2 changes: 1 addition & 1 deletion docs/libnick/search/all_0.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
var searchData=
[
['0_0',['2024.7.0',['../index.html#autotoc_md6',1,'']]]
['1_0',['2024.7.1',['../index.html#autotoc_md6',1,'']]]
];
2 changes: 1 addition & 1 deletion docs/libnick/search/all_1.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
var searchData=
[
['2024_207_200_0',['2024.7.0',['../index.html#autotoc_md6',1,'']]]
['2024_207_201_0',['2024.7.1',['../index.html#autotoc_md6',1,'']]]
];
8 changes: 4 additions & 4 deletions docs/libnick/search/all_10.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/libnick/search/all_13.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit f916398

Please sign in to comment.