@compodoc/compodoc
Version:
The missing documentation tool for your Angular application
265 lines (193 loc) • 6.77 kB
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 class">
<div class="content-data">
<ol class="breadcrumb">
<li>Classes</li>
<li >Tada</li>
</ol>
<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/shared/models/todo.model.ts</code>
</p>
</div>
<div class="tab-pane fade " id="c-readme">
<p><h1 id="todo-class">Todo class</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 { ElementRef } from '@angular/core';
import { Direction } from '../miscellaneous/miscellaneous';
export class Tada {}
/**
* The todo class
* See {@link TodoStore} for service using it
*/
export class Todo extends Tada {
/**
* Completed status
*/
completed: boolean;
/**
* Editing status
*/
editing: boolean;
pos?: PopupPosition;
/**
* Another private property
*/
#newprivateproperty: boolean = false;
private optionalProperty?: boolean;
[index: number]: string;
testCommentFunction(dig: number, str: string, bool: boolean): object {
return {};
}
dir: Direction = Direction.Left;
/**
* Title
*/
private _title: string;
/**
* @return {string} _title value
*/
get title() {
return this._title;
}
/**
* Setter of _title
* @param {string} value The new title
*/
set title(value: string) {
this._title = value.trim();
}
static classMethod() {
return 'hello';
}
/**
* Returns the runtime path
* @returns {string}
*/
get runtimePath() {
return this._options.runtimePath;
}
/**
* The todo constructor
* Watch {@link TodoStore} for service using it
*/
constructor(title: string) {
this.completed = false;
this.editing = false;
this.title = title.trim();
}
/**
* fakeMethod !!
* @example <caption>Usage of fakeMethod</caption>
* returns true;
* fakeMethod()
*/
fakeMethod(): boolean {
return true;
}
azert() {
return 5;
}
abstract abstractMethod(input: string): string;
async asyncMethod() {}
url2state = async <T>(defaults: Partial<T>) =>
await this.route.queryParamMap
.pipe(
/** use first to make sure this only runs at component init time */
first(),
map(r => {}),
catchError(e => {})
)
/** cast observable to promise */
.toPromise();
#clicked() {
this.editing = true;
}
}
export type PopupPosition = ElementRef | HTMLElement;
</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 = 'class';
var COMPODOC_CURRENT_PAGE_URL = 'Tada.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>