Skip to content

Commit

Permalink
Adding typedoc support
Browse files Browse the repository at this point in the history
  • Loading branch information
Supereg committed Nov 14, 2020
1 parent d9c1d02 commit 3aa79d0
Show file tree
Hide file tree
Showing 35 changed files with 7,838 additions and 6,416 deletions.
1 change: 1 addition & 0 deletions docs/assets/css/main.css

Large diffs are not rendered by default.

Binary file added docs/assets/images/icons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/widgets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
51 changes: 51 additions & 0 deletions docs/assets/js/main.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/assets/js/search.js

Large diffs are not rendered by default.

585 changes: 585 additions & 0 deletions docs/classes/logger.html

Large diffs are not rendered by default.

343 changes: 343 additions & 0 deletions docs/classes/user.html

Large diffs are not rendered by default.

258 changes: 258 additions & 0 deletions docs/enums/apievent.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,258 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>APIEvent | homebridge</title>
<meta name="description" content="Documentation for homebridge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">homebridge</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">homebridge</a>
</li>
<li>
<a href="apievent.html">APIEvent</a>
</li>
</ul>
<h1>Enumeration APIEvent</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Enumeration members</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="apievent.html#did_finish_launching" class="tsd-kind-icon">DID_<wbr>FINISH_<wbr>LAUNCHING</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="apievent.html#shutdown" class="tsd-kind-icon">SHUTDOWN</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Enumeration members</h2>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="did_finish_launching" class="tsd-anchor"></a>
<h3>DID_<wbr>FINISH_<wbr>LAUNCHING</h3>
<div class="tsd-signature tsd-kind-icon">DID_<wbr>FINISH_<wbr>LAUNCHING<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;didFinishLaunching&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/homebridge/homebridge/blob/d9c1d02/src/api.ts#L144">api.ts:144</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Event is fired once homebridge has finished with booting up and initializing all components and plugins.
When this event is fired it is possible that the Bridge accessory isn&#39;t published yet, if homebridge still needs
to wait for some {@see StaticPlatformPlugin | StaticPlatformPlugins} to finish accessory creation.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="shutdown" class="tsd-anchor"></a>
<h3>SHUTDOWN</h3>
<div class="tsd-signature tsd-kind-icon">SHUTDOWN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;shutdown&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/homebridge/homebridge/blob/d9c1d02/src/api.ts#L149">api.ts:149</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>This event is fired when homebridge got shutdown. This could be a regular shutdown or a unexpected crash.
At this stage all Accessories are already unpublished and all PlatformAccessories are already saved to disk!</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-enum">
<a href="apievent.html" class="tsd-kind-icon">APIEvent</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="apievent.html#did_finish_launching" class="tsd-kind-icon">DID_<wbr>FINISH_<wbr>LAUNCHING</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="apievent.html#shutdown" class="tsd-kind-icon">SHUTDOWN</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-enum">
<a href="loglevel.html" class="tsd-kind-icon">Log<wbr>Level</a>
</li>
<li class=" tsd-kind-enum">
<a href="platformaccessoryevent.html" class="tsd-kind-icon">Platform<wbr>Accessory<wbr>Event</a>
</li>
<li class=" tsd-kind-enum">
<a href="plugintype.html" class="tsd-kind-icon">Plugin<wbr>Type</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/logger.html" class="tsd-kind-icon">Logger</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/user.html" class="tsd-kind-icon">User</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/api.html" class="tsd-kind-icon">API</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/accessoryconfig.html" class="tsd-kind-icon">Accessory<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/accessoryplugin.html" class="tsd-kind-icon">Accessory<wbr>Plugin</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/accessorypluginconstructor.html" class="tsd-kind-icon">Accessory<wbr>Plugin<wbr>Constructor</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/bridgeconfiguration.html" class="tsd-kind-icon">Bridge<wbr>Configuration</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/dynamicplatformplugin.html" class="tsd-kind-icon">Dynamic<wbr>Platform<wbr>Plugin</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/externalportsconfiguration.html" class="tsd-kind-icon">External<wbr>Ports<wbr>Configuration</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/homebridgeconfig.html" class="tsd-kind-icon">Homebridge<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/homebridgeoptions.html" class="tsd-kind-icon">Homebridge<wbr>Options</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/independentplatformplugin.html" class="tsd-kind-icon">Independent<wbr>Platform<wbr>Plugin</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/logging.html" class="tsd-kind-icon">Logging</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/platformaccessory.html" class="tsd-kind-icon">Platform<wbr>Accessory</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/platformconfig.html" class="tsd-kind-icon">Platform<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/platformpluginconstructor.html" class="tsd-kind-icon">Platform<wbr>Plugin<wbr>Constructor</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/plugininitializer.html" class="tsd-kind-icon">Plugin<wbr>Initializer</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/staticplatformplugin.html" class="tsd-kind-icon">Static<wbr>Platform<wbr>Plugin</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../modules.html#accessoryidentifier" class="tsd-kind-icon">Accessory<wbr>Identifier</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../modules.html#accessoryname" class="tsd-kind-icon">Accessory<wbr>Name</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../modules.html#hap" class="tsd-kind-icon">HAP</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../modules.html#platformidentifier" class="tsd-kind-icon">Platform<wbr>Identifier</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../modules.html#platformname" class="tsd-kind-icon">Platform<wbr>Name</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../modules.html#pluginidentifier" class="tsd-kind-icon">Plugin<wbr>Identifier</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../modules.html#pluginname" class="tsd-kind-icon">Plugin<wbr>Name</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../modules.html#scopedpluginname" class="tsd-kind-icon">Scoped<wbr>Plugin<wbr>Name</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Loading

0 comments on commit 3aa79d0

Please sign in to comment.