UNPKG

@compodoc/compodoc

Version:

The missing documentation tool for your Angular application

318 lines (267 loc) 13.2 kB
<!doctype html> <html class="no-js" lang=""> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <title>sample-files 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" media="(prefers-color-scheme: dark)"> </head> <body> <div class="navbar navbar-default navbar-fixed-top visible-xs"> <a href="../" class="navbar-brand">sample-files documentation</a> <button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button> </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="hidden-xs menu"> <compodoc-menu mode="normal"></compodoc-menu> </div> <!-- START CONTENT --> <div class="content module"> <div class="content-data"> <ol class="breadcrumb"> <li>Modules</li> <li >HomeModule</li> </ol> <div class="text-center module-graph-container"> <div id="module-graph-svg"> <?xml version="1.0" encoding="UTF-8" standalone="no"?> <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"> <!-- Generated by graphviz version 2.47.3 (20210619.1520) --> <!-- Title: dependencies Pages: 1 --> <svg width="510pt" height="247pt" viewBox="0.00 0.00 510.00 246.80" 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 242.8)"> <title>dependencies</title> <polygon fill="white" stroke="transparent" points="-4,4 -4,-242.8 506,-242.8 506,4 -4,4"/> <text text-anchor="middle" x="251" y="-8.2" font-family="sans-serif" font-size="14.00">dependencies</text> <g id="clust1" class="cluster"> <title>cluster_HomeModule</title> <polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-32.8 8,-230.8 494,-230.8 494,-32.8 8,-32.8"/> </g> <g id="clust5" class="cluster"> <title>cluster_HomeModule_exports</title> <polygon fill="none" stroke="black" points="164,-170.8 164,-222.8 300,-222.8 300,-170.8 164,-170.8"/> </g> <g id="clust2" class="cluster"> <title>cluster_HomeModule_declarations</title> <polygon fill="none" stroke="black" points="354,-40.8 354,-92.8 486,-92.8 486,-40.8 354,-40.8"/> </g> <g id="clust4" class="cluster"> <title>cluster_HomeModule_imports</title> <polygon fill="none" stroke="black" points="16,-40.8 16,-92.8 346,-92.8 346,-40.8 16,-40.8"/> </g> <!-- HomeComponent --> <g id="node1" class="node"> <title>HomeComponent</title> <polygon fill="#ffffb3" stroke="black" points="477.55,-84.8 362.45,-84.8 362.45,-48.8 477.55,-48.8 477.55,-84.8"/> <text text-anchor="middle" x="420" y="-62.6" font-family="Times,serif" font-size="14.00">HomeComponent</text> </g> <!-- HomeModule --> <g id="node2" class="node"> <title>HomeModule</title> <polygon fill="#8dd3c7" stroke="black" points="278.76,-149.8 275.76,-153.8 254.76,-153.8 251.76,-149.8 185.24,-149.8 185.24,-113.8 278.76,-113.8 278.76,-149.8"/> <text text-anchor="middle" x="232" y="-127.6" font-family="Times,serif" font-size="14.00">HomeModule</text> </g> <!-- HomeComponent&#45;&gt;HomeModule --> <g id="edge1" class="edge"> <title>HomeComponent&#45;&gt;HomeModule</title> <path fill="none" stroke="black" d="M420,-84.91C420,-104.14 420,-131.8 420,-131.8 420,-131.8 288.96,-131.8 288.96,-131.8"/> <polygon fill="black" stroke="black" points="288.96,-128.3 278.96,-131.8 288.96,-135.3 288.96,-128.3"/> </g> <!-- HomeComponent --> <g id="node6" class="node"> <title>HomeComponent </title> <polygon fill="#fb8072" stroke="black" points="291.54,-214.8 172.46,-214.8 172.46,-178.8 291.54,-178.8 291.54,-214.8"/> <text text-anchor="middle" x="232" y="-192.6" font-family="Times,serif" font-size="14.00">HomeComponent </text> </g> <!-- HomeModule&#45;&gt;HomeComponent --> <g id="edge5" class="edge"> <title>HomeModule&#45;&gt;HomeComponent </title> <path fill="none" stroke="black" stroke-dasharray="5,2" d="M232,-149.91C232,-149.91 232,-168.79 232,-168.79"/> <polygon fill="black" stroke="black" points="228.5,-168.79 232,-178.79 235.5,-168.79 228.5,-168.79"/> </g> <!-- FooterModule --> <g id="node3" class="node"> <title>FooterModule</title> <polygon fill="#8dd3c7" stroke="black" points="338.1,-84.8 335.1,-88.8 314.1,-88.8 311.1,-84.8 241.9,-84.8 241.9,-48.8 338.1,-48.8 338.1,-84.8"/> <text text-anchor="middle" x="290" y="-62.6" font-family="Times,serif" font-size="14.00">FooterModule</text> </g> <!-- FooterModule&#45;&gt;HomeModule --> <g id="edge2" class="edge"> <title>FooterModule&#45;&gt;HomeModule</title> <path fill="none" stroke="black" d="M260.42,-84.91C260.42,-84.91 260.42,-103.79 260.42,-103.79"/> <polygon fill="black" stroke="black" points="256.92,-103.79 260.42,-113.79 263.92,-103.79 256.92,-103.79"/> </g> <!-- HeaderModule --> <g id="node4" class="node"> <title>HeaderModule</title> <polygon fill="#8dd3c7" stroke="black" points="223.96,-84.8 220.96,-88.8 199.96,-88.8 196.96,-84.8 124.04,-84.8 124.04,-48.8 223.96,-48.8 223.96,-84.8"/> <text text-anchor="middle" x="174" y="-62.6" font-family="Times,serif" font-size="14.00">HeaderModule</text> </g> <!-- HeaderModule&#45;&gt;HomeModule --> <g id="edge3" class="edge"> <title>HeaderModule&#45;&gt;HomeModule</title> <path fill="none" stroke="black" d="M204.55,-84.91C204.55,-84.91 204.55,-103.79 204.55,-103.79"/> <polygon fill="black" stroke="black" points="201.05,-103.79 204.55,-113.79 208.05,-103.79 201.05,-103.79"/> </g> <!-- ListModule --> <g id="node5" class="node"> <title>ListModule</title> <polygon fill="#8dd3c7" stroke="black" points="105.83,-84.8 102.83,-88.8 81.83,-88.8 78.83,-84.8 24.17,-84.8 24.17,-48.8 105.83,-48.8 105.83,-84.8"/> <text text-anchor="middle" x="65" y="-62.6" font-family="Times,serif" font-size="14.00">ListModule</text> </g> <!-- ListModule&#45;&gt;HomeModule --> <g id="edge4" class="edge"> <title>ListModule&#45;&gt;HomeModule</title> <path fill="none" stroke="black" d="M65,-84.91C65,-104.14 65,-131.8 65,-131.8 65,-131.8 175.04,-131.8 175.04,-131.8"/> <polygon fill="black" stroke="black" points="175.04,-135.3 185.04,-131.8 175.04,-128.3 175.04,-135.3"/> </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="active" > <a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a> </li> <li > <a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a> </li> </ul> <div class="tab-content"> <div class="tab-pane fade active in" id="c-info"> <p class="comment"> <h3>File</h3> </p> <p class="comment"> <code>src/app/home/home.module.ts</code> </p> <p class="comment"> <h3>Description</h3> </p> <p class="comment"> <p>The header module</p> <p>Just embedding <home> component and it&#39;s routing definition in <a href="../miscellaneous/variables.html#HomeRoutingModule">HomeRoutingModule</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" 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/HomeComponent.html">HomeComponent</a> </li> </ul> </div> <div class="col-sm-3"> <h3>Imports<a href="https://angular.io/api/core/NgModule#imports" target="_blank" title="Official documentation about module imports"><span class="icon ion-ios-information-circle-outline"></a></h3> <ul class="list-group"> <li class="list-group-item"> <a href="../modules/FooterModule.html">FooterModule</a> </li> <li class="list-group-item"> <a href="../modules/HeaderModule.html">HeaderModule</a> </li> <li class="list-group-item"> <a href="../modules/ListModule.html">ListModule</a> </li> </ul> </div> <div class="col-sm-3"> <h3>Exports<a href="https://angular.io/api/core/NgModule#exports" target="_blank" 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/HomeComponent.html">HomeComponent</a> </li> </ul> </div> </div> </div> </div> <div class="tab-pane fade tab-source-code" id="c-source"> <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { BrowserModule } from &#x27;@angular/platform-browser&#x27;; import { NgModule } from &#x27;@angular/core&#x27;; import { FormsModule } from &#x27;@angular/forms&#x27;; import { HttpModule } from &#x27;@angular/http&#x27;; import { HomeComponent } from &#x27;./home.component&#x27;; import { HomeRoutingModule } from &#x27;./home-routing.module&#x27;; import { HeaderModule } from &#x27;../header/&#x27;; import { ListModule } from &#x27;../list/&#x27;; import { FooterModule } from &#x27;../footer/&#x27;; const INTERNAL_MODULES &#x3D; [HeaderModule, ListModule, FooterModule, HomeRoutingModule]; /** * The header module * * Just embedding &lt;home&gt; component and it&#x27;s routing definition in {@link HomeRoutingModule} */ @NgModule({ declarations: [HomeComponent], imports: [BrowserModule, FormsModule, HttpModule, ...INTERNAL_MODULES], exports: [HomeComponent] }) export class HomeModule {} </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> <script> var COMPODOC_CURRENT_PAGE_DEPTH = 1; var COMPODOC_CURRENT_PAGE_CONTEXT = 'module'; var COMPODOC_CURRENT_PAGE_URL = 'HomeModule.html'; var MAX_SEARCH_RESULTS = 15; </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/libs/zepto.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>