UNPKG

@compodoc/compodoc

Version:

The missing documentation tool for your Angular application

351 lines (298 loc) 14.4 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 >AboutModule</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="464pt" height="247pt" viewBox="0.00 0.00 464.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 460,-242.8 460,4 -4,4"/> <text text-anchor="middle" x="228" y="-8.2" font-family="sans-serif" font-size="14.00">dependencies</text> <g id="clust1" class="cluster"> <title>cluster_AboutModule</title> <polygon fill="none" stroke="black" stroke-dasharray="1,5" points="8,-32.8 8,-230.8 448,-230.8 448,-32.8 8,-32.8"/> </g> <g id="clust4" class="cluster"> <title>cluster_AboutModule_imports</title> <polygon fill="none" stroke="black" points="284,-40.8 284,-92.8 440,-92.8 440,-40.8 284,-40.8"/> </g> <g id="clust7" class="cluster"> <title>cluster_AboutModule_providers</title> <polygon fill="none" stroke="black" points="156,-40.8 156,-92.8 276,-92.8 276,-40.8 156,-40.8"/> </g> <g id="clust6" class="cluster"> <title>cluster_AboutModule_bootstrap</title> <polygon fill="none" stroke="black" points="148,-170.8 148,-222.8 284,-222.8 284,-170.8 148,-170.8"/> </g> <g id="clust2" class="cluster"> <title>cluster_AboutModule_declarations</title> <polygon fill="none" stroke="black" points="16,-40.8 16,-92.8 148,-92.8 148,-40.8 16,-40.8"/> </g> <!-- AboutComponent --> <g id="node1" class="node"> <title>AboutComponent</title> <polygon fill="#ffffb3" stroke="black" points="140.33,-84.8 23.67,-84.8 23.67,-48.8 140.33,-48.8 140.33,-84.8"/> <text text-anchor="middle" x="82" y="-62.6" font-family="Times,serif" font-size="14.00">AboutComponent</text> </g> <!-- AboutModule --> <g id="node2" class="node"> <title>AboutModule</title> <polygon fill="#8dd3c7" stroke="black" points="263.05,-149.8 260.05,-153.8 239.05,-153.8 236.05,-149.8 168.95,-149.8 168.95,-113.8 263.05,-113.8 263.05,-149.8"/> <text text-anchor="middle" x="216" y="-127.6" font-family="Times,serif" font-size="14.00">AboutModule</text> </g> <!-- AboutComponent&#45;&gt;AboutModule --> <g id="edge1" class="edge"> <title>AboutComponent&#45;&gt;AboutModule</title> <path fill="none" stroke="black" d="M82,-84.91C82,-104.14 82,-131.8 82,-131.8 82,-131.8 158.76,-131.8 158.76,-131.8"/> <polygon fill="black" stroke="black" points="158.76,-135.3 168.76,-131.8 158.76,-128.3 158.76,-135.3"/> </g> <!-- AboutComponent --> <g id="node4" class="node"> <title>AboutComponent </title> <polygon fill="#80b1d3" stroke="black" points="275.83,-214.8 156.17,-214.8 156.17,-178.8 275.83,-178.8 275.83,-214.8"/> <text text-anchor="middle" x="216" y="-192.6" font-family="Times,serif" font-size="14.00">AboutComponent </text> </g> <!-- AboutModule&#45;&gt;AboutComponent --> <g id="edge3" class="edge"> <title>AboutModule&#45;&gt;AboutComponent </title> <path fill="none" stroke="black" stroke-dasharray="1,5" d="M216,-149.91C216,-149.91 216,-168.79 216,-168.79"/> <polygon fill="black" stroke="black" points="212.5,-168.79 216,-178.79 219.5,-168.79 212.5,-168.79"/> </g> <!-- AboutRoutingModule --> <g id="node3" class="node"> <title>AboutRoutingModule</title> <polygon fill="#8dd3c7" stroke="black" points="431.67,-84.8 428.67,-88.8 407.67,-88.8 404.67,-84.8 292.33,-84.8 292.33,-48.8 431.67,-48.8 431.67,-84.8"/> <text text-anchor="middle" x="362" y="-62.6" font-family="Times,serif" font-size="14.00">AboutRoutingModule</text> </g> <!-- AboutRoutingModule&#45;&gt;AboutModule --> <g id="edge2" class="edge"> <title>AboutRoutingModule&#45;&gt;AboutModule</title> <path fill="none" stroke="black" d="M362,-84.91C362,-104.14 362,-131.8 362,-131.8 362,-131.8 273.4,-131.8 273.4,-131.8"/> <polygon fill="black" stroke="black" points="273.4,-128.3 263.4,-131.8 273.4,-135.3 273.4,-128.3"/> </g> <!-- TodoStore --> <g id="node5" class="node"> <title>TodoStore</title> <ellipse fill="#fdb462" stroke="black" cx="216" cy="-66.8" rx="51.61" ry="18"/> <text text-anchor="middle" x="216" y="-62.6" font-family="Times,serif" font-size="14.00">TodoStore</text> </g> <!-- TodoStore&#45;&gt;AboutModule --> <g id="edge4" class="edge"> <title>TodoStore&#45;&gt;AboutModule</title> <path fill="none" stroke="black" d="M216,-84.91C216,-84.91 216,-103.79 216,-103.79"/> <polygon fill="black" stroke="black" points="212.5,-103.79 216,-113.79 219.5,-103.79 212.5,-103.79"/> </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="#readme" role="tab" id="readme-tab" data-toggle="tab" data-link="readme">README</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/about/about.module.ts</code> </p> <p class="comment"> <h3>Identifier</h3> </p> <p class="comment"> toto </p> <p class="comment"> <h3>Description</h3> </p> <p class="comment"> <p>The about module</p> <p>Just embedding <about> component and it&#39;s routing definition in <a href="../modules/AboutRoutingModule.html">AboutRoutingModule</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/AboutComponent.html">AboutComponent</a> </li> </ul> </div> <div class="col-sm-3"> <h3>EntryComponents<a href="https://angular.io/api/core/NgModule#entryComponents" target="_blank" title="Official documentation about module entryComponents"><span class="icon ion-ios-information-circle-outline"></span></a></h3> <ul class="list-group"> <li class="list-group-item"> <a href="../components/AboutComponent.html">AboutComponent</a> </li> </ul> </div> <div class="col-sm-3"> <h3>Providers<a href="https://angular.io/api/core/NgModule#providers" target="_blank" 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/TodoStore.html">TodoStore</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/AboutRoutingModule.html">AboutRoutingModule</a> </li> </ul> </div> <div class="col-sm-3"> <h3>Bootstrap<a href="https://angular.io/api/core/NgModule#bootstrap" target="_blank" title="Official documentation about module bootstrap"><span class="icon ion-ios-information-circle-outline"></a></h3> <ul class="list-group"> <li class="list-group-item"> <a href="../components/AboutComponent.html">AboutComponent</a> </li> </ul> </div> <div class="col-sm-3"> <h3>Schemas<a href="https://angular.io/api/core/NgModule#schemas" target="_blank" title="Official documentation about module schemas"><span class="icon ion-ios-information-circle-outline"></a></h3> <ul class="list-group"> <li class="list-group-item"> <a href="https://angular.io/api/core/NO_ERRORS_SCHEMA" target="_blank">NO_ERRORS_SCHEMA</a> </li> </ul> </div> </div> </div> </div> <div class="tab-pane fade " id="c-readme"> <p><h1 id="about-module">About module</h1> </p> </div> <div class="tab-pane fade tab-source-code" id="c-source"> <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { NgModule, NO_ERRORS_SCHEMA } from &#x27;@angular/core&#x27;; import { AboutComponent } from &#x27;./about.component&#x27;; import { AboutRoutingModule } from &#x27;./about-routing.module&#x27;; import { TodoStore } from &#x27;../shared/services/todo.store&#x27;; const declarations &#x3D; [AboutComponent]; const imports &#x3D; [AboutRoutingModule]; const entryComponents &#x3D; [AboutComponent]; const bootstrap &#x3D; [AboutComponent]; const id &#x3D; &#x27;toto&#x27;; const providers &#x3D; [TodoStore]; const schemas &#x3D; [NO_ERRORS_SCHEMA]; /** * The about module * * Just embedding &lt;about&gt; component and it&#x27;s routing definition in {@link AboutRoutingModule} */ @NgModule({ declarations, imports, entryComponents, bootstrap, providers, id, schemas }) export class AboutModule {} </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 = 'AboutModule.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>