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 0ff922f
Browse files Browse the repository at this point in the history
  • Loading branch information
AptiviCEO committed Feb 4, 2024
1 parent c31441c commit cc35e44
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 72 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ <h3 id="properties">Properties
<a href="https://github.com/Aptivi/GRILO/new/main/apiSpec/new?filename=GRILO_Bootloader_Common_Configuration_Instance_ConfigInstance_AdditionalScanFolders.md&amp;value=---%0Auid%3A%20GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.AdditionalScanFolders%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/Configuration/Instance/ConfigInstance.cs/#L51">View Source</a>
<a href="https://github.com/Aptivi/GRILO/blob/main/GRILO.Bootloader/Common/Configuration/Instance/ConfigInstance.cs/#L45">View Source</a>
</span>
<a id="GRILO_Bootloader_Common_Configuration_Instance_ConfigInstance_AdditionalScanFolders_" data-uid="GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.AdditionalScanFolders*"></a>
<h4 id="GRILO_Bootloader_Common_Configuration_Instance_ConfigInstance_AdditionalScanFolders" data-uid="GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.AdditionalScanFolders">AdditionalScanFolders</h4>
Expand Down Expand Up @@ -136,7 +136,7 @@ <h5 class="propertyValue">Property Value</h5>
<a href="https://github.com/Aptivi/GRILO/new/main/apiSpec/new?filename=GRILO_Bootloader_Common_Configuration_Instance_ConfigInstance_BootSelect.md&amp;value=---%0Auid%3A%20GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.BootSelect%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/Configuration/Instance/ConfigInstance.cs/#L63">View Source</a>
<a href="https://github.com/Aptivi/GRILO/blob/main/GRILO.Bootloader/Common/Configuration/Instance/ConfigInstance.cs/#L57">View Source</a>
</span>
<a id="GRILO_Bootloader_Common_Configuration_Instance_ConfigInstance_BootSelect_" data-uid="GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.BootSelect*"></a>
<h4 id="GRILO_Bootloader_Common_Configuration_Instance_ConfigInstance_BootSelect" data-uid="GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.BootSelect">BootSelect</h4>
Expand Down Expand Up @@ -168,7 +168,7 @@ <h5 class="propertyValue">Property Value</h5>
<a href="https://github.com/Aptivi/GRILO/new/main/apiSpec/new?filename=GRILO_Bootloader_Common_Configuration_Instance_ConfigInstance_BootSelectTimeoutSeconds.md&amp;value=---%0Auid%3A%20GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.BootSelectTimeoutSeconds%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/Configuration/Instance/ConfigInstance.cs/#L57">View Source</a>
<a href="https://github.com/Aptivi/GRILO/blob/main/GRILO.Bootloader/Common/Configuration/Instance/ConfigInstance.cs/#L51">View Source</a>
</span>
<a id="GRILO_Bootloader_Common_Configuration_Instance_ConfigInstance_BootSelectTimeoutSeconds_" data-uid="GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.BootSelectTimeoutSeconds*"></a>
<h4 id="GRILO_Bootloader_Common_Configuration_Instance_ConfigInstance_BootSelectTimeoutSeconds" data-uid="GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.BootSelectTimeoutSeconds">BootSelectTimeoutSeconds</h4>
Expand Down Expand Up @@ -259,38 +259,6 @@ <h5 class="propertyValue">Property Value</h5>
</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_Configuration_Instance_ConfigInstance_PrintDiagnosticMessages.md&amp;value=---%0Auid%3A%20GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.PrintDiagnosticMessages%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/Configuration/Instance/ConfigInstance.cs/#L45">View Source</a>
</span>
<a id="GRILO_Bootloader_Common_Configuration_Instance_ConfigInstance_PrintDiagnosticMessages_" data-uid="GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.PrintDiagnosticMessages*"></a>
<h4 id="GRILO_Bootloader_Common_Configuration_Instance_ConfigInstance_PrintDiagnosticMessages" data-uid="GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.PrintDiagnosticMessages">PrintDiagnosticMessages</h4>
<div class="markdown level1 summary"><p>Whether to also print diagnostic messages to the console</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsonProperty(&quot;Print diagnostic messages to console&quot;, Required = Required.Always)]
public bool PrintDiagnosticMessages { get; set; }</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>
Expand Down
2 changes: 1 addition & 1 deletion index.json
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@
"api/GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.html": {
"href": "api/GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.html",
"title": "Class ConfigInstance | GRILO API - Aptivi",
"keywords": "Class ConfigInstance Configuration instance Inheritance object ConfigInstance Namespace: GRILO.Bootloader.Common.Configuration.Instance Assembly: GRILO.Bootloader.dll Syntax public class ConfigInstance Properties | Edit this page View Source AdditionalScanFolders Additional bootable folders to scan for bootable applications Declaration [JsonProperty(\"Additional bootable folders\", Required = Required.Always)] public string[] AdditionalScanFolders { get; set; } Property Value Type Description string[] | Edit this page View Source BootSelect The default boot entry selection. This number is zero-based, so the first element is index 0, and so on. Declaration [JsonProperty(\"Default boot entry selection\", Required = Required.Always)] public int BootSelect { get; set; } Property Value Type Description int | Edit this page View Source BootSelectTimeoutSeconds Timeout to boot to the default selection Declaration [JsonProperty(\"Timeout to boot to selection\", Required = Required.Always)] public int BootSelectTimeoutSeconds { get; set; } Property Value Type Description int | Edit this page View Source BootStyleName The boot style name Declaration [JsonProperty(\"Boot style\", Required = Required.Always)] public string BootStyleName { get; set; } Property Value Type Description string | Edit this page View Source DiagnosticMessages Whether to create a file containing diagnostic messages Declaration [JsonProperty(\"Diagnostic messages\", Required = Required.Always)] public bool DiagnosticMessages { get; set; } Property Value Type Description bool | Edit this page View Source PrintDiagnosticMessages Whether to also print diagnostic messages to the console Declaration [JsonProperty(\"Print diagnostic messages to console\", Required = Required.Always)] public bool PrintDiagnosticMessages { get; set; } Property Value Type Description bool"
"keywords": "Class ConfigInstance Configuration instance Inheritance object ConfigInstance Namespace: GRILO.Bootloader.Common.Configuration.Instance Assembly: GRILO.Bootloader.dll Syntax public class ConfigInstance Properties | Edit this page View Source AdditionalScanFolders Additional bootable folders to scan for bootable applications Declaration [JsonProperty(\"Additional bootable folders\", Required = Required.Always)] public string[] AdditionalScanFolders { get; set; } Property Value Type Description string[] | Edit this page View Source BootSelect The default boot entry selection. This number is zero-based, so the first element is index 0, and so on. Declaration [JsonProperty(\"Default boot entry selection\", Required = Required.Always)] public int BootSelect { get; set; } Property Value Type Description int | Edit this page View Source BootSelectTimeoutSeconds Timeout to boot to the default selection Declaration [JsonProperty(\"Timeout to boot to selection\", Required = Required.Always)] public int BootSelectTimeoutSeconds { get; set; } Property Value Type Description int | Edit this page View Source BootStyleName The boot style name Declaration [JsonProperty(\"Boot style\", Required = Required.Always)] public string BootStyleName { get; set; } Property Value Type Description string | Edit this page View Source DiagnosticMessages Whether to create a file containing diagnostic messages Declaration [JsonProperty(\"Diagnostic messages\", Required = Required.Always)] public bool DiagnosticMessages { get; set; } Property Value Type Description bool"
},
"api/GRILO.Bootloader.Common.Configuration.Instance.html": {
"href": "api/GRILO.Bootloader.Common.Configuration.Instance.html",
Expand Down
46 changes: 23 additions & 23 deletions sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,139 +2,139 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Boot.IBootable.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Boot.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.BootableAppDemo.BootClass.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.BootableAppDemo.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Bootloader.Boot.Apps.BootAppInfo.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Bootloader.Boot.Apps.BootManager.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Bootloader.Boot.Apps.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Bootloader.Boot.Diagnostics.DiagnosticsLevel.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Bootloader.Boot.Diagnostics.DiagnosticsWriter.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Bootloader.Boot.Diagnostics.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Bootloader.Boot.Style.BaseBootStyle.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Bootloader.Boot.Style.BootStyleManager.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Bootloader.Boot.Style.IBootStyle.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Bootloader.Boot.Style.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Bootloader.Common.BootloaderException.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Bootloader.Common.BootloaderState.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Bootloader.Common.Configuration.Config.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Bootloader.Common.Configuration.ConfigPaths.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Bootloader.Common.Configuration.Instance.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Bootloader.Common.Configuration.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/api/GRILO.Bootloader.Common.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
<url>
<loc>https://aptivi.github.io/GRILO/index.html</loc>
<lastmod>2024-02-04T06:37:52+00:00</lastmod>
<lastmod>2024-02-04T06:39:52+00:00</lastmod>
<changefreq>daily</changefreq>
<priority>0.5</priority>
</url>
Expand Down
13 changes: 0 additions & 13 deletions xrefmap.yml
Original file line number Diff line number Diff line change
Expand Up @@ -953,16 +953,3 @@ references:
isSpec: "True"
fullName: GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.DiagnosticMessages
nameWithType: ConfigInstance.DiagnosticMessages
- uid: GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.PrintDiagnosticMessages
name: PrintDiagnosticMessages
href: api/GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.html#GRILO_Bootloader_Common_Configuration_Instance_ConfigInstance_PrintDiagnosticMessages
commentId: P:GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.PrintDiagnosticMessages
fullName: GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.PrintDiagnosticMessages
nameWithType: ConfigInstance.PrintDiagnosticMessages
- uid: GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.PrintDiagnosticMessages*
name: PrintDiagnosticMessages
href: api/GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.html#GRILO_Bootloader_Common_Configuration_Instance_ConfigInstance_PrintDiagnosticMessages_
commentId: Overload:GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.PrintDiagnosticMessages
isSpec: "True"
fullName: GRILO.Bootloader.Common.Configuration.Instance.ConfigInstance.PrintDiagnosticMessages
nameWithType: ConfigInstance.PrintDiagnosticMessages

0 comments on commit cc35e44

Please sign in to comment.