@compodoc/compodoc
Version:
The missing documentation tool for your Angular application
433 lines (370 loc) • 18.6 kB
HTML
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>@compodoc/compodoc documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css">
</head>
<body>
<script>
// Blocking script to avoid flickering dark mode
// Dark mode toggle button
var useDark = window.matchMedia('(prefers-color-scheme: dark)');
var darkModeState = useDark.matches;
var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
var $darkModeToggles = document.querySelectorAll('.dark-mode-switch');
var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state');
function checkToggle(check) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].checked = check;
}
}
function toggleDarkMode(state) {
if (window.localStorage) {
localStorage.setItem('compodoc_darkmode-state', state);
}
checkToggle(state);
const hasClass = document.body.classList.contains('dark');
if (state) {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.add('dark');
}
if (!hasClass) {
document.body.classList.add('dark');
}
} else {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.remove('dark');
}
if (hasClass) {
document.body.classList.remove('dark');
}
}
}
useDark.addEventListener('change', function (evt) {
toggleDarkMode(evt.matches);
});
if (darkModeStateLocal) {
darkModeState = darkModeStateLocal === 'true';
}
toggleDarkMode(darkModeState);
</script>
<script>
// --- Iframe navigation tracking for Template Playground ---
function sendCurrentUrlToParent() {
if (window.parent && window.parent !== window) {
window.parent.postMessage({
type: 'compodoc-iframe-navigate',
url: window.location.pathname + window.location.hash
}, '*');
}
}
window.addEventListener('hashchange', sendCurrentUrlToParent, false);
window.addEventListener('popstate', sendCurrentUrlToParent, false);
window.addEventListener('DOMContentLoaded', sendCurrentUrlToParent, false);
</script>
<div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
<div class="d-flex">
<a href="../" class="navbar-brand">@compodoc/compodoc documentation</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="d-none d-md-block menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content module">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Modules</li>
<li class="breadcrumb-item" >BarModule</li>
</ol>
<div class="text-center module-graph-container">
<div id="module-graph-svg">
<!-- Generated by graphviz version 2.47.0 (20210316.0004)
-->
<!-- Title: dependencies Pages: 1 -->
<svg width="504pt" height="349pt"
viewBox="0.00 0.00 504.00 349.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 345)">
<title>dependencies</title>
<polygon fill="white" stroke="transparent" points="-4,4 -4,-345 500,-345 500,4 -4,4"/>
<text text-anchor="start" x="227.01" y="-42.4" font-family="Times-12" font-weight="bold" font-size="14.00">Legend</text>
<polygon fill="#ffffb3" stroke="transparent" points="14,-10 14,-30 34,-30 34,-10 14,-10"/>
<text text-anchor="start" x="37.63" y="-15.4" font-family="Times-12" font-size="14.00">  Declarations</text>
<polygon fill="#8dd3c7" stroke="transparent" points="127,-10 127,-30 147,-30 147,-10 127,-10"/>
<text text-anchor="start" x="150.73" y="-15.4" font-family="Times-12" font-size="14.00">  Module</text>
<polygon fill="#80b1d3" stroke="transparent" points="213,-10 213,-30 233,-30 233,-10 213,-10"/>
<text text-anchor="start" x="236.78" y="-15.4" font-family="Times-12" font-size="14.00">  Bootstrap</text>
<polygon fill="#fdb462" stroke="transparent" points="310,-10 310,-30 330,-30 330,-10 310,-10"/>
<text text-anchor="start" x="333.67" y="-15.4" font-family="Times-12" font-size="14.00">  Providers</text>
<polygon fill="#fb8072" stroke="transparent" points="406,-10 406,-30 426,-30 426,-10 406,-10"/>
<text text-anchor="start" x="429.73" y="-15.4" font-family="Times-12" font-size="14.00">  Exports</text>
<g id="clust1" class="cluster">
<title>cluster_BarModule</title>
<polygon fill="none" stroke="black" stroke-dasharray="1,5" points="122,-70 122,-333 374,-333 374,-70 122,-70"/>
</g>
<g id="clust2" class="cluster">
<title>cluster_BarModule_declarations</title>
<polygon fill="none" stroke="black" points="130,-143 130,-195 354,-195 354,-143 130,-143"/>
</g>
<g id="clust3" class="cluster">
<title>cluster_BarModule_BarComponent_providers</title>
<polygon fill="none" stroke="black" points="237,-78 237,-130 361,-130 361,-78 237,-78"/>
</g>
<g id="clust6" class="cluster">
<title>cluster_BarModule_exports</title>
<polygon fill="none" stroke="black" points="133,-273 133,-325 364,-325 364,-273 133,-273"/>
</g>
<!-- BarComponent -->
<g id="node1" class="node">
<title>BarComponent</title>
<polygon fill="#ffffb3" stroke="black" points="345.55,-187 244.45,-187 244.45,-151 345.55,-151 345.55,-187"/>
<text text-anchor="middle" x="295" y="-164.8" font-family="Times,serif" font-size="14.00">BarComponent</text>
</g>
<!-- BarModule -->
<g id="node3" class="node">
<title>BarModule</title>
<polygon fill="#8dd3c7" stroke="black" points="334.76,-252 331.76,-256 310.76,-256 307.76,-252 255.24,-252 255.24,-216 334.76,-216 334.76,-252"/>
<text text-anchor="middle" x="295" y="-229.8" font-family="Times,serif" font-size="14.00">BarModule</text>
</g>
<!-- BarComponent->BarModule -->
<g id="edge1" class="edge">
<title>BarComponent->BarModule</title>
<path fill="none" stroke="black" d="M295,-187.11C295,-187.11 295,-205.99 295,-205.99"/>
<polygon fill="black" stroke="black" points="291.5,-205.99 295,-215.99 298.5,-205.99 291.5,-205.99"/>
</g>
<!-- BarDirective -->
<g id="node2" class="node">
<title>BarDirective</title>
<polygon fill="#ffffb3" stroke="black" points="226.3,-187 137.7,-187 137.7,-151 226.3,-151 226.3,-187"/>
<text text-anchor="middle" x="182" y="-164.8" font-family="Times,serif" font-size="14.00">BarDirective</text>
</g>
<!-- BarDirective->BarModule -->
<g id="edge3" class="edge">
<title>BarDirective->BarModule</title>
<path fill="none" stroke="black" d="M169.45,-187.02C169.45,-204.37 169.45,-228 169.45,-228 169.45,-228 244.93,-228 244.93,-228"/>
<polygon fill="black" stroke="black" points="244.93,-231.5 254.93,-228 244.93,-224.5 244.93,-231.5"/>
</g>
<!-- BarComponent -->
<g id="node5" class="node">
<title>BarComponent </title>
<polygon fill="#fb8072" stroke="black" points="355.54,-317 250.46,-317 250.46,-281 355.54,-281 355.54,-317"/>
<text text-anchor="middle" x="303" y="-294.8" font-family="Times,serif" font-size="14.00">BarComponent </text>
</g>
<!-- BarModule->BarComponent -->
<g id="edge4" class="edge">
<title>BarModule->BarComponent </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M295,-252.11C295,-252.11 295,-270.99 295,-270.99"/>
<polygon fill="black" stroke="black" points="291.5,-270.99 295,-280.99 298.5,-270.99 291.5,-270.99"/>
</g>
<!-- BarDirective -->
<g id="node6" class="node">
<title>BarDirective </title>
<polygon fill="#fb8072" stroke="black" points="232.79,-317 141.21,-317 141.21,-281 232.79,-281 232.79,-317"/>
<text text-anchor="middle" x="187" y="-294.8" font-family="Times,serif" font-size="14.00">BarDirective </text>
</g>
<!-- BarModule->BarDirective -->
<g id="edge5" class="edge">
<title>BarModule->BarDirective </title>
<path fill="none" stroke="black" stroke-dasharray="5,2" d="M255.18,-240C228.34,-240 197.8,-240 197.8,-240 197.8,-240 197.8,-270.98 197.8,-270.98"/>
<polygon fill="black" stroke="black" points="194.3,-270.98 197.8,-280.98 201.3,-270.98 194.3,-270.98"/>
</g>
<!-- BarService -->
<g id="node4" class="node">
<title>BarService</title>
<ellipse fill="#fdb462" stroke="black" cx="299" cy="-104" rx="53.87" ry="18"/>
<text text-anchor="middle" x="299" y="-99.8" font-family="Times,serif" font-size="14.00">BarService</text>
</g>
<!-- BarService->BarComponent -->
<g id="edge2" class="edge">
<title>BarService->BarComponent</title>
<path fill="none" stroke="black" d="M295.42,-122.11C295.42,-122.11 295.42,-140.99 295.42,-140.99"/>
<polygon fill="black" stroke="black" points="291.92,-140.99 295.42,-150.99 298.92,-140.99 291.92,-140.99"/>
</g>
<!-- BarService->BarModule -->
<g id="edge6" class="edge">
<title>BarService->BarModule</title>
<path fill="none" stroke="black" d="M349.35,-110.63C349.35,-137.12 349.35,-234 349.35,-234 349.35,-234 344.79,-234 344.79,-234"/>
<polygon fill="black" stroke="black" points="344.79,-230.5 334.79,-234 344.79,-237.5 344.79,-230.5"/>
</g>
</g>
</svg>
</div>
<i id="fullscreen" class="icon ion-ios-resize module-graph-fullscreen-btn" aria-hidden="true"></i>
<div class="btn-group size-buttons">
<button id="zoom-in" class="btn btn-default btn-sm">Zoom in</button>
<button id="reset" class="btn btn-default btn-sm">Reset</button>
<button id="zoom-out" class="btn btn-default btn-sm">Zoom out</button>
</div>
</div>
<script src="../js/libs/svg-pan-zoom.min.js"></script>
<script src="../js/svg-pan-zoom.controls.js"></script>
<ul class="nav nav-tabs" role="tablist">
<li class="nav-item">
<a href="#info"
class="nav-link"
class="nav-link active"
role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a>
</li>
<li class="nav-item">
<a href="#source"
class="nav-link"
role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane fade active in" id="info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>test/fixtures/sample-files/bar.module.ts</code>
</p>
<p class="comment">
<h3>Description</h3>
</p>
<p class="comment">
<p>BarModule description</p>
<p>see <a href="http://www.google.fr">http://www.google.fr</a>
see <a href="http://www.google.fr">Second link</a>
see <a href="http://www.google.uk">Third link</a>
see <a href="http://www.google.jp">Last link</a></p>
<p>Watch <a href="../components/BarComponent.html">The BarComponent</a></p>
</p>
<div class="container-fluid module">
<div class="row">
<div class="col-sm-3">
<h3>Declarations<a href="https://angular.io/api/core/NgModule#declarations" target="_blank" rel="noopener noreferrer"
title="Official documentation about module declarations"><span class="icon ion-ios-information-circle-outline"></span></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../components/BarComponent.html">BarComponent</a>
</li>
<li class="list-group-item">
<a href="../directives/BarDirective.html">BarDirective</a>
</li>
</ul>
</div>
<div class="col-sm-3">
<h3>Providers<a href="https://angular.io/api/core/NgModule#providers" target="_blank" rel="noopener noreferrer"
title="Official documentation about module providers"><span class="icon ion-ios-information-circle-outline"></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../injectables/BarService.html">BarService</a>
</li>
</ul>
</div>
<div class="col-sm-3">
<h3>Exports<a href="https://angular.io/api/core/NgModule#exports" target="_blank" rel="noopener noreferrer"
title="Official documentation about module exports"><span
class="icon ion-ios-information-circle-outline"></a></h3>
<ul class="list-group">
<li class="list-group-item">
<a href="../components/BarComponent.html">BarComponent</a>
</li>
<li class="list-group-item">
<a href="../directives/BarDirective.html">BarDirective</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { NgModule } from '@angular/core';
import { BarDirective } from './bar.directive';
import { BarComponent } from './bar.component';
import { BarService } from './bar.service';
/**
* BarModule description
*
* see {@link http://www.google.fr}
* see {@link http://www.google.fr|Second link}
* see {@link http://www.google.uk Third link}
* see [Last link]{@link http://www.google.jp}
*
* Watch [The BarComponent]{@link BarComponent}
*/
@NgModule({
declarations: [BarDirective, BarComponent],
exports: [BarDirective, BarComponent],
providers: [BarService]
})
export class BarModule {}
</code></pre>
</div>
</div>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<label class="dark-mode-switch">
<input type="checkbox">
<span class="slider">
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
</svg>
</span>
</label>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'module';
var COMPODOC_CURRENT_PAGE_URL = 'BarModule.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script>
$darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
checkToggle(darkModeState);
if ($darkModeToggleSwitchers.length > 0) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].addEventListener('change', function (event) {
darkModeState = !darkModeState;
toggleDarkMode(darkModeState);
});
}
}
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<script src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>
<script src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
</body>
</html>