Updated API Documentation Using Typedoc

Author: actions-user

docs/assets/main.js

@@ -248,35 +248,6 @@ dd {
     padding-left: 0;
 }
 
-ul.tsd-descriptions > li > :first-child,
-.tsd-panel > :first-child,
-.col-8 > :first-child,
-.col-4 > :first-child,
-ul.tsd-descriptions > li > :first-child > :first-child,
-.tsd-panel > :first-child > :first-child,
-.col-8 > :first-child > :first-child,
-.col-4 > :first-child > :first-child,
-ul.tsd-descriptions > li > :first-child > :first-child > :first-child,
-.tsd-panel > :first-child > :first-child > :first-child,
-.col-8 > :first-child > :first-child > :first-child,
-.col-4 > :first-child > :first-child > :first-child {
-    margin-top: 0;
-}
-ul.tsd-descriptions > li > :last-child,
-.tsd-panel > :last-child,
-.col-8 > :last-child,
-.col-4 > :last-child,
-ul.tsd-descriptions > li > :last-child > :last-child,
-.tsd-panel > :last-child > :last-child,
-.col-8 > :last-child > :last-child,
-.col-4 > :last-child > :last-child,
-ul.tsd-descriptions > li > :last-child > :last-child > :last-child,
-.tsd-panel > :last-child > :last-child > :last-child,
-.col-8 > :last-child > :last-child > :last-child,
-.col-4 > :last-child > :last-child > :last-child {
-    margin-bottom: 0;
-}
-
 @keyframes fade-in {
     from {
         opacity: 0;
@@ -971,7 +942,7 @@ a.tsd-index-link {
     margin: 2rem 0;
 }
 .tsd-panel-group.tsd-index-group details {
-    margin: 4rem 0;
+    margin: 2rem 0;
 }
 
 #tsd-search {
@@ -1073,9 +1044,6 @@ a.tsd-index-link {
     font-size: 14px;
     overflow-x: auto;
 }
-.tsd-panel > .tsd-signature {
-    border-width: 1px 0;
-}
 
 .tsd-signature-symbol {
     color: var(--color-text-aside);
@@ -1090,60 +1058,16 @@ a.tsd-index-link {
 .tsd-signatures {
     padding: 0;
     margin: 0 0 1em 0;
-    border: 1px solid var(--color-accent);
+    list-style-type: none;
 }
 .tsd-signatures .tsd-signature {
     margin: 0;
-    border-width: 1px 0 0 0;
-    transition: background-color 0.1s;
-}
-.tsd-signatures .tsd-signature:first-child {
-    border-top-width: 0;
-}
-.tsd-signatures .tsd-signature.current {
-    background-color: var(--color-background-secondary);
-}
-.tsd-signatures.active > .tsd-signature {
-    cursor: pointer;
-}
-.tsd-panel > .tsd-signatures {
+    border-color: var(--color-accent);
     border-width: 1px 0;
+    transition: background-color 0.1s;
 }
-.tsd-panel > a.anchor + .tsd-signatures {
-    border-top-width: 0;
-    margin-top: -20px;
-}
-
-ul.tsd-descriptions {
-    position: relative;
-    overflow: hidden;
-    padding: 0;
-    list-style: none;
-}
-ul.tsd-descriptions.active > .tsd-description {
-    display: none;
-}
-ul.tsd-descriptions.active > .tsd-description.current {
-    display: block;
-}
-ul.tsd-descriptions.active > .tsd-description.fade-in {
-    animation: fade-in-delayed 0.3s;
-}
-ul.tsd-descriptions.active > .tsd-description.fade-out {
-    animation: fade-out-delayed 0.3s;
-    position: absolute;
-    display: block;
-    top: 0;
-    left: 0;
-    right: 0;
-    opacity: 0;
-    visibility: hidden;
-}
-ul.tsd-descriptions h4,
-ul.tsd-descriptions .tsd-index-panel h3,
-.tsd-index-panel ul.tsd-descriptions h3 {
-    font-size: 16px;
-    margin: 1em 0 0.5em 0;
+.tsd-description .tsd-signatures .tsd-signature {
+    border-width: 1px;
 }
 
 ul.tsd-parameter-list,

docs/assets/search.js

@@ -9,7 +9,7 @@
 <div class="container container-main">
 <div class="col-8 col-content">
 <div class="tsd-page-title">
-<h2> homebridge-aladdinconnect</h2></div>
+<h2>homebridge-aladdinconnect</h2></div>
 <div class="tsd-panel tsd-typography"><p align="center">
  <a href="https://github.com/bloomkd46/homebridge-AladdinConnect"><img alt="Homebridge AladdinConnect" src="https://user-images.githubusercontent.com/75853497/177844958-712bcaae-8dc8-4fc9-a2e3-b4b828ff5999.png" width="600px"></a>
 </p>
@@ -20,7 +20,8 @@ <h2> homebridge-aladdinconnect</h2></div>
   <h1>homebridge-AladdinConnect</h1>
 </a>
 <p>Homebridge plugin to integrate Genie&#39;s Aladdin Connect Devices into HomeKit</p>
-<p><a href="https://npmcharts.com/compare/homebridge-aladdinconnect?log=true&amp;interval=1&amp;minimal=true"><img src="https://img.shields.io/npm/dt/homebridge-aladdinconnect" alt="downloads"></a></p>
+<p><a href="https://github.com/homebridge/homebridge/wiki/Verified-Plugins"><img src="https://badgen.net/badge/homebridge/verified/purple" alt="verified-by-homebridge"></a>
+<a href="https://npmcharts.com/compare/homebridge-aladdinconnect?log=true&amp;interval=1&amp;minimal=true"><img src="https://img.shields.io/npm/dt/homebridge-aladdinconnect" alt="downloads"></a></p>
 <p><a href="https://www.npmjs.com/package/homebridge-aladdinconnect"><img src="https://img.shields.io/npm/v/homebridge-aladdinconnect/latest?label=latest" alt="npm"></a>
 <a href="https://github.com/bloomkd46/homebridge-AladdinConnect/wiki/Beta-Version"><img src="https://img.shields.io/npm/v/homebridge-aladdinconnect/beta?label=beta" alt="npm"></a>  </p>
 <p><a href="https://github.com/bloomkd46/homebridge-AladdinConnect/actions/workflows/build.yml"><img src="https://github.com/bloomkd46/homebridge-AladdinConnect/actions/workflows/build.yml/badge.svg" alt="build workflow"></a>
@@ -29,7 +30,7 @@ <h1>homebridge-AladdinConnect</h1>
 
 
 <a href="#plugin-information" id="plugin-information" style="color: inherit; text-decoration: none;">
-  <h3>Plugin Information</h3>
+  <h2>Plugin Information</h2>
 </a>
 <ul>
 <li>This plugin allows you to view and control Genie&#39;s Aladdin Connect System within HomeKit. This plugin:<ul>
@@ -41,17 +42,18 @@ <h3>Plugin Information</h3>
 </ul>
 
 <a href="#features" id="features" style="color: inherit; text-decoration: none;">
-  <h2>Features:</h2>
+  <h2>Features</h2>
 </a>
 <ul>
 <li><input checked="" disabled="" type="checkbox"> Easy Setup</li>
 <li><input checked="" disabled="" type="checkbox"> Real-Time Device Updates</li>
 <li><input checked="" disabled="" type="checkbox"> Device-By-Device Logs In Custom UI</li>
 <li><input checked="" disabled="" type="checkbox"> Device-By-Device Info In Custom UI</li>
+<li><input checked="" disabled="" type="checkbox"> Supports Secondary Account</li>
 </ul>
 
 <a href="#todo" id="todo" style="color: inherit; text-decoration: none;">
-  <h2>TODO:</h2>
+  <h2>TODO</h2>
 </a>
 <ul>
 <li><input disabled="" type="checkbox"> Verify Plugin</li>

docs/assets/style.css

@@ -9,7 +9,7 @@
 <div class="container container-main">
 <div class="col-8 col-content">
 <div class="tsd-page-title">
-<h2> homebridge-aladdinconnect</h2></div>
+<h2>homebridge-aladdinconnect</h2></div>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <h3 class="tsd-index-heading uppercase">Index</h3>

docs/classes/accessories_Accessory.default.html

@@ -12,7 +12,11 @@
 <ul class="tsd-breadcrumb">
 <li><a href="../modules.html">homebridge-aladdinconnect</a></li>
 <li><a href="accessories_Accessory.html">accessories/Accessory</a></li></ul>
-<h1>Module accessories/Accessory</h1></div>
+<h1>Module accessories/Accessory</h1></div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-AladdinConnect/blob/97ea7da/src/accessories/Accessory.ts#L1">src/accessories/Accessory.ts:1</a></li></ul></aside>
+<section class="tsd-panel-group">
+<section class="tsd-panel tsd-typography"></section></section>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <h3 class="tsd-index-heading uppercase">Index</h3>

docs/classes/accessories_GarageDoorAccessory.default.html

@@ -12,7 +12,11 @@
 <ul class="tsd-breadcrumb">
 <li><a href="../modules.html">homebridge-aladdinconnect</a></li>
 <li><a href="accessories_GarageDoorAccessory.html">accessories/GarageDoorAccessory</a></li></ul>
-<h1>Module accessories/GarageDoorAccessory</h1></div>
+<h1>Module accessories/GarageDoorAccessory</h1></div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-AladdinConnect/blob/97ea7da/src/accessories/GarageDoorAccessory.ts#L1">src/accessories/GarageDoorAccessory.ts:1</a></li></ul></aside>
+<section class="tsd-panel-group">
+<section class="tsd-panel tsd-typography"></section></section>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <h3 class="tsd-index-heading uppercase">Index</h3>

docs/classes/platform.AladdinConnectPlatform.html

@@ -12,7 +12,11 @@
 <ul class="tsd-breadcrumb">
 <li><a href="../modules.html">homebridge-aladdinconnect</a></li>
 <li><a href="index.html">index</a></li></ul>
-<h1>Module index</h1></div>
+<h1>Module index</h1></div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-AladdinConnect/blob/97ea7da/src/index.ts#L1">src/index.ts:1</a></li></ul></aside>
+<section class="tsd-panel-group">
+<section class="tsd-panel tsd-typography"></section></section>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -32,8 +36,7 @@ <h4>Type declaration</h4>
 <ul class="tsd-parameters">
 <li class="tsd-parameter-signature">
 <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-module">
-<li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">API</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul>
-<ul class="tsd-descriptions">
+<li class="tsd-signature" id="__type.__type-1"><span class="tsd-signature-symbol">(</span>api<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">API</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
 <li class="tsd-description">
 <div class="tsd-comment tsd-typography"><p>This method registers the platform with Homebridge</p>
 </div>
@@ -44,7 +47,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5>api: <span class="tsd-signature-type">API</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/bloomkd46/homebridge-AladdinConnect/blob/67f1ca0/src/index.ts#L9">src/index.ts:9</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-AladdinConnect/blob/97ea7da/src/index.ts#L9">src/index.ts:9</a></li></ul></aside></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/index.html

@@ -12,7 +12,11 @@
 <ul class="tsd-breadcrumb">
 <li><a href="../modules.html">homebridge-aladdinconnect</a></li>
 <li><a href="platform.html">platform</a></li></ul>
-<h1>Module platform</h1></div>
+<h1>Module platform</h1></div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-AladdinConnect/blob/97ea7da/src/platform.ts#L1">src/platform.ts:1</a></li></ul></aside>
+<section class="tsd-panel-group">
+<section class="tsd-panel tsd-typography"></section></section>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <h3 class="tsd-index-heading uppercase">Index</h3>

docs/modules.html

@@ -12,7 +12,11 @@
 <ul class="tsd-breadcrumb">
 <li><a href="../modules.html">homebridge-aladdinconnect</a></li>
 <li><a href="settings.html">settings</a></li></ul>
-<h1>Module settings</h1></div>
+<h1>Module settings</h1></div><aside class="tsd-sources">
+<ul>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-AladdinConnect/blob/97ea7da/src/settings.ts#L4">src/settings.ts:4</a></li></ul></aside>
+<section class="tsd-panel-group">
+<section class="tsd-panel tsd-typography"></section></section>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <h3 class="tsd-index-heading uppercase">Index</h3>

docs/modules/accessories_Accessory.html

@@ -18,7 +18,7 @@ <h1>Variable PLATFORM_NAME<code class="tsd-tag ts-flagConst">Const</code> </h1><
 <div class="tsd-comment tsd-typography"><p>This is the name of the platform that users will use to register the plugin in the Homebridge config.json</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/bloomkd46/homebridge-AladdinConnect/blob/67f1ca0/src/settings.ts#L4">src/settings.ts:4</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-AladdinConnect/blob/97ea7da/src/settings.ts#L4">src/settings.ts:4</a></li></ul></aside></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/modules/accessories_GarageDoorAccessory.html

@@ -18,7 +18,7 @@ <h1>Variable PLUGIN_NAME<code class="tsd-tag ts-flagConst">Const</code> </h1></d
 <div class="tsd-comment tsd-typography"><p>This must match the name of your plugin as defined the package.json</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/bloomkd46/homebridge-AladdinConnect/blob/67f1ca0/src/settings.ts#L9">src/settings.ts:9</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/bloomkd46/homebridge-AladdinConnect/blob/97ea7da/src/settings.ts#L9">src/settings.ts:9</a></li></ul></aside></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

docs/modules/index.html

@@ -45,7 +45,7 @@
     "nodemon": "^2.0.19",
     "rimraf": "^3.0.2",
     "ts-node": "^10.3.0",
-    "typedoc": "^0.23.5",
+    "typedoc": "^0.23.10",
     "typescript": "^4.4.4"
   }
 }