Skip to content
This repository has been archived by the owner on Jun 3, 2024. It is now read-only.

Commit

Permalink
Updated documentation to reflect latest changes c0a97f1
Browse files Browse the repository at this point in the history
  • Loading branch information
AptiviCEO committed Feb 1, 2024
1 parent e2b0c59 commit 5c5b202
Show file tree
Hide file tree
Showing 8 changed files with 290 additions and 24 deletions.
207 changes: 207 additions & 0 deletions api/GRILO.Bootloader.Common.BootloaderState.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,207 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class BootloaderState
| GRILO API - Aptivi </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class BootloaderState
| GRILO API - Aptivi ">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.min.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">

<meta property="docfx:rel" content="../">

</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>

<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>

<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>

<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">

<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">

<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="GRILO.Bootloader.Common.BootloaderState">



<h1 id="GRILO_Bootloader_Common_BootloaderState" data-uid="GRILO.Bootloader.Common.BootloaderState" class="text-break">Class BootloaderState
</h1>
<div class="markdown level0 summary"><p>Stores the bootloader state</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div class="level1"><span class="xref">BootloaderState</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="GRILO.html">GRILO</a>.<a class="xref" href="GRILO.Bootloader.html">Bootloader</a>.<a class="xref" href="GRILO.Bootloader.Common.html">Common</a></h6>
<h6><strong>Assembly</strong>: GRILO.Bootloader.dll</h6>
<h5 id="GRILO_Bootloader_Common_BootloaderState_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class BootloaderState</code></pre>
</div>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/Aptivi/GRILO/new/main/apiSpec/new?filename=GRILO_Bootloader_Common_BootloaderState_WaitingForBootKey.md&amp;value=---%0Auid%3A%20GRILO.Bootloader.Common.BootloaderState.WaitingForBootKey%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Aptivi/GRILO/blob/main/GRILO.Bootloader/Common/BootloaderState.cs/#L33">View Source</a>
</span>
<a id="GRILO_Bootloader_Common_BootloaderState_WaitingForBootKey_" data-uid="GRILO.Bootloader.Common.BootloaderState.WaitingForBootKey*"></a>
<h4 id="GRILO_Bootloader_Common_BootloaderState_WaitingForBootKey" data-uid="GRILO.Bootloader.Common.BootloaderState.WaitingForBootKey">WaitingForBootKey</h4>
<div class="markdown level1 summary"><p>Specifies whether the bootloader is waiting for any key to be pressed</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool WaitingForBootKey { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/Aptivi/GRILO/new/main/apiSpec/new?filename=GRILO_Bootloader_Common_BootloaderState_WaitingForFirstBootKey.md&amp;value=---%0Auid%3A%20GRILO.Bootloader.Common.BootloaderState.WaitingForFirstBootKey%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Aptivi/GRILO/blob/main/GRILO.Bootloader/Common/BootloaderState.cs/#L39">View Source</a>
</span>
<a id="GRILO_Bootloader_Common_BootloaderState_WaitingForFirstBootKey_" data-uid="GRILO.Bootloader.Common.BootloaderState.WaitingForFirstBootKey*"></a>
<h4 id="GRILO_Bootloader_Common_BootloaderState_WaitingForFirstBootKey" data-uid="GRILO.Bootloader.Common.BootloaderState.WaitingForFirstBootKey">WaitingForFirstBootKey</h4>
<div class="markdown level1 summary"><p>Specifies whether the bootloader is waiting for any key to be pressed for the first time</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool WaitingForFirstBootKey { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
<td></td>
</tr>
</tbody>
</table>

</article>
</div>

<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/Aptivi/GRILO/new/main/apiSpec/new?filename=GRILO_Bootloader_Common_BootloaderState.md&amp;value=---%0Auid%3A%20GRILO.Bootloader.Common.BootloaderState%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Edit this page</a>
</li>
<li>
<a href="https://github.com/Aptivi/GRILO/blob/main/GRILO.Bootloader/Common/BootloaderState.cs/#L25" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In this article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>

<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>

<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>

<script type="text/javascript" src="../styles/docfx.vendor.min.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
3 changes: 3 additions & 0 deletions api/GRILO.Bootloader.Common.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,9 @@ <h3 id="classes">
<h4><a class="xref" href="GRILO.Bootloader.Common.BootloaderException.html">BootloaderException</a></h4>
<section><p>Internal bootloader error</p>
</section>
<h4><a class="xref" href="GRILO.Bootloader.Common.BootloaderState.html">BootloaderState</a></h4>
<section><p>Stores the bootloader state</p>
</section>


</article>
Expand Down
3 changes: 3 additions & 0 deletions api/toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,9 @@
<li>
<a href="GRILO.Bootloader.Common.BootloaderException.html" name="" title="BootloaderException">BootloaderException</a>
</li>
<li>
<a href="GRILO.Bootloader.Common.BootloaderState.html" name="" title="BootloaderState">BootloaderState</a>
</li>
</ul>
</li>
<li>
Expand Down
2 changes: 1 addition & 1 deletion api/toc.json
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@

{"items":[{"name":"GRILO.Boot","href":"GRILO.Boot.html","topicHref":"GRILO.Boot.html","topicUid":"GRILO.Boot","items":[{"name":"IBootable","href":"GRILO.Boot.IBootable.html","topicHref":"GRILO.Boot.IBootable.html","topicUid":"GRILO.Boot.IBootable"}]},{"name":"GRILO.BootableAppDemo","href":"GRILO.BootableAppDemo.html","topicHref":"GRILO.BootableAppDemo.html","topicUid":"GRILO.BootableAppDemo","items":[{"name":"BootClass","href":"GRILO.BootableAppDemo.BootClass.html","topicHref":"GRILO.BootableAppDemo.BootClass.html","topicUid":"GRILO.BootableAppDemo.BootClass"}]},{"name":"GRILO.Bootloader.Boot.Apps","href":"GRILO.Bootloader.Boot.Apps.html","topicHref":"GRILO.Bootloader.Boot.Apps.html","topicUid":"GRILO.Bootloader.Boot.Apps","items":[{"name":"BootAppInfo","href":"GRILO.Bootloader.Boot.Apps.BootAppInfo.html","topicHref":"GRILO.Bootloader.Boot.Apps.BootAppInfo.html","topicUid":"GRILO.Bootloader.Boot.Apps.BootAppInfo"},{"name":"BootManager","href":"GRILO.Bootloader.Boot.Apps.BootManager.html","topicHref":"GRILO.Bootloader.Boot.Apps.BootManager.html","topicUid":"GRILO.Bootloader.Boot.Apps.BootManager"}]},{"name":"GRILO.Bootloader.Boot.Diagnostics","href":"GRILO.Bootloader.Boot.Diagnostics.html","topicHref":"GRILO.Bootloader.Boot.Diagnostics.html","topicUid":"GRILO.Bootloader.Boot.Diagnostics","items":[{"name":"DiagnosticsLevel","href":"GRILO.Bootloader.Boot.Diagnostics.DiagnosticsLevel.html","topicHref":"GRILO.Bootloader.Boot.Diagnostics.DiagnosticsLevel.html","topicUid":"GRILO.Bootloader.Boot.Diagnostics.DiagnosticsLevel"},{"name":"DiagnosticsWriter","href":"GRILO.Bootloader.Boot.Diagnostics.DiagnosticsWriter.html","topicHref":"GRILO.Bootloader.Boot.Diagnostics.DiagnosticsWriter.html","topicUid":"GRILO.Bootloader.Boot.Diagnostics.DiagnosticsWriter"}]},{"name":"GRILO.Bootloader.Boot.Style","href":"GRILO.Bootloader.Boot.Style.html","topicHref":"GRILO.Bootloader.Boot.Style.html","topicUid":"GRILO.Bootloader.Boot.Style","items":[{"name":"BaseBootStyle","href":"GRILO.Bootloader.Boot.Style.BaseBootStyle.html","topicHref":"GRILO.Bootloader.Boot.Style.BaseBootStyle.html","topicUid":"GRILO.Bootloader.Boot.Style.BaseBootStyle"},{"name":"BootStyleManager","href":"GRILO.Bootloader.Boot.Style.BootStyleManager.html","topicHref":"GRILO.Bootloader.Boot.Style.BootStyleManager.html","topicUid":"GRILO.Bootloader.Boot.Style.BootStyleManager"},{"name":"IBootStyle","href":"GRILO.Bootloader.Boot.Style.IBootStyle.html","topicHref":"GRILO.Bootloader.Boot.Style.IBootStyle.html","topicUid":"GRILO.Bootloader.Boot.Style.IBootStyle"}]},{"name":"GRILO.Bootloader.Common","href":"GRILO.Bootloader.Common.html","topicHref":"GRILO.Bootloader.Common.html","topicUid":"GRILO.Bootloader.Common","items":[{"name":"BootloaderException","href":"GRILO.Bootloader.Common.BootloaderException.html","topicHref":"GRILO.Bootloader.Common.BootloaderException.html","topicUid":"GRILO.Bootloader.Common.BootloaderException"}]},{"name":"GRILO.Bootloader.Common.Configuration","href":"GRILO.Bootloader.Common.Configuration.html","topicHref":"GRILO.Bootloader.Common.Configuration.html","topicUid":"GRILO.Bootloader.Common.Configuration","items":[{"name":"Config","href":"GRILO.Bootloader.Common.Configuration.Config.html","topicHref":"GRILO.Bootloader.Common.Configuration.Config.html","topicUid":"GRILO.Bootloader.Common.Configuration.Config"},{"name":"ConfigPaths","href":"GRILO.Bootloader.Common.Configuration.ConfigPaths.html","topicHref":"GRILO.Bootloader.Common.Configuration.ConfigPaths.html","topicUid":"GRILO.Bootloader.Common.Configuration.ConfigPaths"}]},{"name":"GRILO.Bootloader.Common.Configuration.Instance","href":"GRILO.Bootloader.Common.Configuration.Instance.html","topicHref":"GRILO.Bootloader.Common.Configuration.Instance.html","topicUid":"GRILO.Bootloader.Common.Configuration.Instance","items":[{"name":"ConfigInstance","href":"GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.html","topicHref":"GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.html","topicUid":"GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance"}]}],"memberLayout":"SamePage"}
{"items":[{"name":"GRILO.Boot","href":"GRILO.Boot.html","topicHref":"GRILO.Boot.html","topicUid":"GRILO.Boot","items":[{"name":"IBootable","href":"GRILO.Boot.IBootable.html","topicHref":"GRILO.Boot.IBootable.html","topicUid":"GRILO.Boot.IBootable"}]},{"name":"GRILO.BootableAppDemo","href":"GRILO.BootableAppDemo.html","topicHref":"GRILO.BootableAppDemo.html","topicUid":"GRILO.BootableAppDemo","items":[{"name":"BootClass","href":"GRILO.BootableAppDemo.BootClass.html","topicHref":"GRILO.BootableAppDemo.BootClass.html","topicUid":"GRILO.BootableAppDemo.BootClass"}]},{"name":"GRILO.Bootloader.Boot.Apps","href":"GRILO.Bootloader.Boot.Apps.html","topicHref":"GRILO.Bootloader.Boot.Apps.html","topicUid":"GRILO.Bootloader.Boot.Apps","items":[{"name":"BootAppInfo","href":"GRILO.Bootloader.Boot.Apps.BootAppInfo.html","topicHref":"GRILO.Bootloader.Boot.Apps.BootAppInfo.html","topicUid":"GRILO.Bootloader.Boot.Apps.BootAppInfo"},{"name":"BootManager","href":"GRILO.Bootloader.Boot.Apps.BootManager.html","topicHref":"GRILO.Bootloader.Boot.Apps.BootManager.html","topicUid":"GRILO.Bootloader.Boot.Apps.BootManager"}]},{"name":"GRILO.Bootloader.Boot.Diagnostics","href":"GRILO.Bootloader.Boot.Diagnostics.html","topicHref":"GRILO.Bootloader.Boot.Diagnostics.html","topicUid":"GRILO.Bootloader.Boot.Diagnostics","items":[{"name":"DiagnosticsLevel","href":"GRILO.Bootloader.Boot.Diagnostics.DiagnosticsLevel.html","topicHref":"GRILO.Bootloader.Boot.Diagnostics.DiagnosticsLevel.html","topicUid":"GRILO.Bootloader.Boot.Diagnostics.DiagnosticsLevel"},{"name":"DiagnosticsWriter","href":"GRILO.Bootloader.Boot.Diagnostics.DiagnosticsWriter.html","topicHref":"GRILO.Bootloader.Boot.Diagnostics.DiagnosticsWriter.html","topicUid":"GRILO.Bootloader.Boot.Diagnostics.DiagnosticsWriter"}]},{"name":"GRILO.Bootloader.Boot.Style","href":"GRILO.Bootloader.Boot.Style.html","topicHref":"GRILO.Bootloader.Boot.Style.html","topicUid":"GRILO.Bootloader.Boot.Style","items":[{"name":"BaseBootStyle","href":"GRILO.Bootloader.Boot.Style.BaseBootStyle.html","topicHref":"GRILO.Bootloader.Boot.Style.BaseBootStyle.html","topicUid":"GRILO.Bootloader.Boot.Style.BaseBootStyle"},{"name":"BootStyleManager","href":"GRILO.Bootloader.Boot.Style.BootStyleManager.html","topicHref":"GRILO.Bootloader.Boot.Style.BootStyleManager.html","topicUid":"GRILO.Bootloader.Boot.Style.BootStyleManager"},{"name":"IBootStyle","href":"GRILO.Bootloader.Boot.Style.IBootStyle.html","topicHref":"GRILO.Bootloader.Boot.Style.IBootStyle.html","topicUid":"GRILO.Bootloader.Boot.Style.IBootStyle"}]},{"name":"GRILO.Bootloader.Common","href":"GRILO.Bootloader.Common.html","topicHref":"GRILO.Bootloader.Common.html","topicUid":"GRILO.Bootloader.Common","items":[{"name":"BootloaderException","href":"GRILO.Bootloader.Common.BootloaderException.html","topicHref":"GRILO.Bootloader.Common.BootloaderException.html","topicUid":"GRILO.Bootloader.Common.BootloaderException"},{"name":"BootloaderState","href":"GRILO.Bootloader.Common.BootloaderState.html","topicHref":"GRILO.Bootloader.Common.BootloaderState.html","topicUid":"GRILO.Bootloader.Common.BootloaderState"}]},{"name":"GRILO.Bootloader.Common.Configuration","href":"GRILO.Bootloader.Common.Configuration.html","topicHref":"GRILO.Bootloader.Common.Configuration.html","topicUid":"GRILO.Bootloader.Common.Configuration","items":[{"name":"Config","href":"GRILO.Bootloader.Common.Configuration.Config.html","topicHref":"GRILO.Bootloader.Common.Configuration.Config.html","topicUid":"GRILO.Bootloader.Common.Configuration.Config"},{"name":"ConfigPaths","href":"GRILO.Bootloader.Common.Configuration.ConfigPaths.html","topicHref":"GRILO.Bootloader.Common.Configuration.ConfigPaths.html","topicUid":"GRILO.Bootloader.Common.Configuration.ConfigPaths"}]},{"name":"GRILO.Bootloader.Common.Configuration.Instance","href":"GRILO.Bootloader.Common.Configuration.Instance.html","topicHref":"GRILO.Bootloader.Common.Configuration.Instance.html","topicUid":"GRILO.Bootloader.Common.Configuration.Instance","items":[{"name":"ConfigInstance","href":"GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.html","topicHref":"GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.html","topicUid":"GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance"}]}],"memberLayout":"SamePage"}
Loading

0 comments on commit 5c5b202

Please sign in to comment.