Skip to content

Commit

Permalink
Updated Doxygen documentation pages.
Browse files Browse the repository at this point in the history
  • Loading branch information
nthnn committed Jun 20, 2024
1 parent e88e430 commit 26ea454
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 11 deletions.
21 changes: 15 additions & 6 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,12 @@
</div><!--header-->
<div class="contents">
<div class="toc"><h3>Table of Contents</h3>
<ul><ul><li class="level2"><a href="#autotoc_md0">Getting Started</a><ul><li class="level3"><a href="#autotoc_md1">Installation</a></li>
<li class="level3"><a href="#autotoc_md2">Usage</a></li>
<ul><ul><li class="level2"><a href="#autotoc_md0">Screenshots</a></li>
<li class="level2"><a href="#autotoc_md1">Getting Started</a><ul><li class="level3"><a href="#autotoc_md2">Installation</a></li>
<li class="level3"><a href="#autotoc_md3">Usage</a></li>
</ul>
</li>
<li class="level2"><a href="#autotoc_md3">License</a></li>
<li class="level2"><a href="#autotoc_md4">License</a></li>
</ul>
</ul>
</div>
Expand All @@ -92,8 +93,16 @@
<li><b>Fallback Mode</b>: Starts the captive portal if no credentials are found or if the connection fails.</li>
</ul>
<h2><a class="anchor" id="autotoc_md0"></a>
Screenshots</h2>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">Captive Portal Index Page </th><th class="markdownTableHeadNone">Captive Portal Success Page </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><img src="misc/screenshots/screenshot-1.png" alt="Index Page" class="inline"/> </td><td class="markdownTableBodyNone"><img src="misc/screenshots/screenshot-2.png" alt="Success Page" class="inline"/> </td></tr>
</table>
<h2><a class="anchor" id="autotoc_md1"></a>
Getting Started</h2>
<h3><a class="anchor" id="autotoc_md1"></a>
<h3><a class="anchor" id="autotoc_md2"></a>
Installation</h3>
<ol type="1">
<li><p class="startli"><b>Clone the Repository</b>:</p>
Expand All @@ -104,7 +113,7 @@ <h3><a class="anchor" id="autotoc_md1"></a>
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;DynaConfig.h&gt;</span></div>
</div><!-- fragment --></li>
</ol>
<h3><a class="anchor" id="autotoc_md2"></a>
<h3><a class="anchor" id="autotoc_md3"></a>
Usage</h3>
<p>Here’s a basic example of how to use the <a class="el" href="d4/dcf/classDynaConfig.html" title="Manages dynamic WiFi configuration through a captive portal.">DynaConfig</a> library in your sketch:</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;<a class="code" href="d8/d2e/dynaconfig_8h.html">dynaconfig.h</a>&gt;</span></div>
Expand Down Expand Up @@ -152,7 +161,7 @@ <h3><a class="anchor" id="autotoc_md2"></a>
<div class="line">}</div>
<div class="ttc" id="aclassDynaConfig_html"><div class="ttname"><a href="d4/dcf/classDynaConfig.html">DynaConfig</a></div><div class="ttdoc">Manages dynamic WiFi configuration through a captive portal.</div><div class="ttdef"><b>Definition</b> dynaconfig.h:62</div></div>
<div class="ttc" id="adynaconfig_8h_html"><div class="ttname"><a href="d8/d2e/dynaconfig_8h.html">dynaconfig.h</a></div><div class="ttdoc">Provides the DynaConfig class for managing WiFi configuration via a captive portal.</div></div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md3"></a>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md4"></a>
License</h2>
<p>Copyright 2024 - Nathanne Isip</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/search/all_2.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ var searchData=
[
['getconfigpasskey_0',['getConfigPasskey',['../d4/dcf/classDynaConfig.html#ae0645302f2dc1055cc62b2f0f908eb5e',1,'DynaConfig']]],
['getconfigssid_1',['getConfigSSID',['../d4/dcf/classDynaConfig.html#a4567cb19220ac8776303973970b6ea5e',1,'DynaConfig']]],
['getting_20started_2',['Getting Started',['../index.html#autotoc_md0',1,'']]]
['getting_20started_2',['Getting Started',['../index.html#autotoc_md1',1,'']]]
];
2 changes: 1 addition & 1 deletion docs/search/all_4.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
var searchData=
[
['installation_0',['Installation',['../index.html#autotoc_md1',1,'']]]
['installation_0',['Installation',['../index.html#autotoc_md2',1,'']]]
];
2 changes: 1 addition & 1 deletion docs/search/all_5.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
var searchData=
[
['license_0',['License',['../index.html#autotoc_md3',1,'']]]
['license_0',['License',['../index.html#autotoc_md4',1,'']]]
];
3 changes: 2 additions & 1 deletion docs/search/all_7.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
var searchData=
[
['started_0',['Getting Started',['../index.html#autotoc_md0',1,'']]]
['screenshots_0',['Screenshots',['../index.html#autotoc_md0',1,'']]],
['started_1',['Getting Started',['../index.html#autotoc_md1',1,'']]]
];
2 changes: 1 addition & 1 deletion docs/search/all_8.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
var searchData=
[
['usage_0',['Usage',['../index.html#autotoc_md2',1,'']]]
['usage_0',['Usage',['../index.html#autotoc_md3',1,'']]]
];

0 comments on commit 26ea454

Please sign in to comment.