@compodoc/compodoc/.tmp-compodoc-test-unit-test/src/app/about/about.component.ts

The missing documentation tool for your Angular application

import { Component, HostListener, Input } from '@angular/core';

import template from './about.component.html';

import { Subscription } from 'rxjs/Subscription';

/**
 * The about component
 *
 * {@link PIT}
 *
 * {@link Direction}
 *
 * {@link ChartChange}
 *
 * {@link foo}
 *
 * Display some text with links for details about TodoMVC & Compodoc.
 */
@testDecorator
@UntilDestroy()
@Component({
    selector: 'about',
    template,
    providers: [EmitterService],
    entryComponents: [TodoComponent, ListComponent],
    preserveWhitespaces: false,
    hostDirectives: [DoNothingDirective],
    styles: `
        a {
            color: #03a9f4;
        }
    `
})
export class AboutComponent {
    public subscriptions: Subscription[];

    /**
     * HostListener mouseup description
     */
    @HostListener('mouseup', ['$event.clientX', '$event.clientY'])
    onMouseup(mouseX: number, mouseY: number): void {}

    /**
     * Inherited type of Angular Version
     */
    @Input() public angularVersion = 'Angular 2';

    /**
     * Dummy input property with a custom decorator
     */
    @MyCustomInputDecorator()
    @Input()
    public myInput: string;

    chartOptions: Highcharts.Options = {
        colors: [
            '#7cb5ec',
            '#434348',
            '#90ed7d',
            '#f7a35c',
            '#8085e9',
            '#f15c80',
            '#e4d354',
            '#2b908f',
            '#f45b5b',
            '#91e8e1'
        ]
    };

    private _fullName: string;

    /**
     * Getter of _fullName
     * @return {string} _fullName value
     */
    get fullName(): string {
        return this._fullName;
    }

    /**
     * Setter of _fullName
     * @param  {string} newName The new name
     */
    set fullName(newName: string) {
        this._fullName = newName;
    }

    static readonly staticReadonlyVariable: string;

    public static publicStaticVariable: string;

    protected static protectedStaticMethod(): string {
        return '';
    }

    private static privateStaticMethod(): string {
        return '';
    }

    public static publicStaticMethod(): string {
        return '';
    }

    static staticMethod(): string {
        return '';
    }

    /**
     * This is for testing
     * @returns '', if this {@link AboutComponent.fullName} does not crash
     */
    public publicMethod(): string {
        return '';
    }

    /**
     * This is for testing
     * @returns a promise, if this {@link undefined} does not crash
     */
    public async foo(): Promise<any> {}
}