Add complete docs rule

js/app.ts

@@ -73,6 +73,9 @@ export interface LoginPromptResult {
 
 declare const host: string;
 
+/**
+ * Main class that initializes app.
+ */
 export class App {
     public currentPopup: string = null;
     public homePage: HomePage;

js/appInit.ts

@@ -26,6 +26,10 @@ function isRunningStandalone() {
         || ("standalone" in window.navigator && window.navigator["standalone"] === true));
 }
 
+/**
+ * Applies app configuration
+ * @param localConfiguration local saved configurations
+ */
 export function bootstrap(localConfiguration?: Partial<AppConfig>) {
     overrideConfiguration(localConfiguration || {});
 

js/appconfig.ts

@@ -17,6 +17,7 @@ class GameActionBlock {
     public hasSecondaryPanel = true;
 }
 
+/** Local app configurations */
 export class AppConfig {
     public auth = {
         automaticLogin: true,
@@ -103,6 +104,10 @@ export type PartialConfiguration<T> = {
     [P in keyof T]?: Partial<T[P]>;
 };
 
+/**
+ * This function overrides local configuration
+ * @param localConfiguration
+ */
 export function overrideConfiguration(localConfiguration: PartialConfiguration<AppConfig>) {
     appConfig = mergeDeep(appConfig, localConfiguration);
 }

js/authmanager.ts

@@ -59,6 +59,7 @@ export interface IAuthenticationManager {
     loginAsGuest(): Promise<string>;
 }
 
+/** Manager that handles authentication */
 export class AuthManager implements IAuthenticationInformation, IAuthenticationManager {
     /**
      * Returns authentication status of the application user.

js/bindings.ts

@@ -14,6 +14,7 @@ import * as timeService from "./timeservice";
 
 declare var app: App;
 
+/** Registers knokcoutjs bindings */
 export function registerBindings() {
     // Binding set loading variable for short amount of time.
     ko.bindingHandlers["loading"] = {

js/commandmanager.ts

@@ -19,6 +19,7 @@ export interface ICommandManager extends ICommandExecutor {
     registerCommand(commandName: string, handler: CommandHandler): void;
 }
 
+/** Register and executes commands */
 export class CommandManager implements ICommandManager {
     public commands: any[] = [];
 

js/components/registration.ts

@@ -28,6 +28,7 @@ function getTemplateDefinition(name: string) {
     return window["PokerComponents"][name];
 }
 
+/** Register knockoutjs components */
 export function registerComponents() {
     /**
      * Tournament lobby sub-components

js/components/table/actionBlock/actionBlock.ts

@@ -1,5 +1,6 @@
 import { ActionBlock } from "../../../table/actionBlock";
 
+/** Action Block Component */
 export class ActionBlockComponent {
     private actionBlock: ActionBlock;
 

js/components/table/menu/menu.ts

@@ -1,5 +1,6 @@
 import { TablesPage } from "../../../pages/tablespage";
 
+/** Table Menu Component */
 export class TableMenuComponent {
     private page: TablesPage;
 

js/components/table/raiseBlock/raiseBlock.ts

@@ -6,6 +6,7 @@ export interface IRaiseBlockComponentParameters {
     updateTranslator: () => void;
 }
 
+/** Raise Block Component */
 export class RaiseBlockComponent {
     private tableSlider: TableSlider;
 

js/extenders.ts

@@ -3,6 +3,7 @@
 import * as ko from "knockout";
 import { SelectorItem } from "./selector";
 
+/** Register knockoutjs extenders */
 export function registerExtenders() {
     ko.extenders["options"] = (target: KnockoutObservable<any>, option: { caption: string; items: SelectorItem[]}) => {
         target.options = option.items;

js/languagemanager.ts

@@ -1,5 +1,6 @@
 declare var messages: any;
 
+/** This manager is responsible for all text operations */
 export class LanguageManager {
     public currentLang: string;
     constructor() {
@@ -63,6 +64,12 @@ export class LanguageManager {
 }
 
 export const l = new LanguageManager();
+
+/**
+ * Returns message value for current language
+ * @param message name of needed message
+ * @param parameters (optional) dynamic values that shoud be written in message
+ */
 export function _(message: string, parameters: any = null) {
     return l.getMessage(message, parameters);
 }

js/pageblock.ts

@@ -2,6 +2,7 @@
 import * as ko from "knockout";
 import { Signal } from "signals";
 
+/** Forms app pages */
 export class PageBlock {
     public static useDoubleView: boolean = false;
     public shown: Signal;

js/pages/SeatPage.ts

@@ -22,6 +22,7 @@ import { version } from "../version";
 
 declare var app: App;
 
+/** Seat page of the player */
 export class SeatPage extends PageBase {
     public currentTable: KnockoutComputed<TableView>;
     public selectedTables: KnockoutComputed<TableView[]>;

js/pages/accountpage.ts

@@ -28,6 +28,7 @@ interface AccountPagePlayerModel {
     stars: number;
 }
 
+/** Account Page */
 export class AccountPage extends PageBase {
     public cashierCaption: KnockoutObservable<string>;
     public loading: KnockoutObservable<boolean>;

js/pages/cashierpageblock.ts

@@ -7,6 +7,7 @@ import { OperationsHistoryPage } from "./operationshistorypage";
 import { RatingPage } from "./ratingpage";
 import { WithdrawalPage } from "./withdrawalpage";
 
+/** Cashier Page Block */
 export class CashierPageBlock extends PageBlock {
     public accountPage: AccountPage;
     public ratingPage: RatingPage;

js/pages/changepasswordpage.ts

@@ -1,6 +1,7 @@
 import * as ko from "knockout";
 import { PageBase } from "../ui/pagebase";
 
+/** Change Password Page */
 export class ChangePasswordPage extends PageBase implements KnockoutValidationGroup {
     public oldpassword: KnockoutObservable<string>;
     public password: KnockoutObservable<string>;

js/pages/chatpage.ts

@@ -10,6 +10,7 @@ import * as timeService from "../timeservice";
 declare var host: string;
 declare var app: App;
 
+/** Chat Page */
 export class ChatPage implements Page {
     public currentMessage: KnockoutObservable<string>;
     public messages: KnockoutObservableArray<PlayerMessage>;

js/pages/homepage.ts

@@ -15,6 +15,7 @@ import { PageBase } from "../ui/pagebase";
 
 declare var app: App;
 
+/** Home Page */
 export class HomePage extends PageBase {
     public online: KnockoutObservable<string>;
     public registered: KnockoutObservable<string>;

js/pages/infopage.ts

@@ -5,6 +5,7 @@ import { PageBase } from "../ui/pagebase";
 
 declare var app: App;
 
+/** Info Page */
 export class InfoPage extends PageBase {
     constructor() {
         super();

js/pages/infopageblock.ts

@@ -2,6 +2,7 @@
 import { InfoPage } from "./infopage";
 import { SupportPage } from "./supportpage";
 
+/** Info Page Block */
 export class InfoPageBlock extends PageBlock {
     constructor() {
         super("info", "pagesList", new InfoPage());

js/pages/lobbypage.ts

@@ -21,6 +21,7 @@ import { PageBase } from "../ui/pagebase";
 
 declare var app: App;
 
+/** Filter options for cash table */
 export class CashOptions {
     public currency: KnockoutObservable<number>;
     public limits: KnockoutObservable<number>;
@@ -74,6 +75,7 @@ export class CashOptions {
     }
 }
 
+/** Filter options for tournaments */
 export class TournamentOptions {
     public currency: KnockoutObservable<number>;
     public buyin: KnockoutObservable<number>;
@@ -132,6 +134,7 @@ interface LobbyTournamentItemEx extends LobbyTournamentItem {
     duration: string;
 }
 
+/** Page for players lobby */
 export class LobbyPage extends PageBase {
     public online: KnockoutObservable<string>;
     public registered: KnockoutObservable<string>;

js/pages/lobbypageblock.ts

@@ -9,6 +9,7 @@ import { TournamentsListPage } from "./tournamentslistpage";
 
 declare var app: App;
 
+/** Lobby Page Block */
 export class LobbyPageBlock extends PageBlock {
     public sngListPage: TournamentsListPage;
     public tournamentsListPage: TournamentsListPage;

js/pages/operationshistorypage.ts

@@ -7,6 +7,7 @@ import { PageBase } from "../ui/pagebase";
 
 declare var app: App;
 
+/** Operations History Page */
 export class OperationsHistoryPage extends PageBase implements KnockoutValidationGroup {
     public from: KnockoutObservable<string>;
     public to: KnockoutObservable<string>;

js/pages/otherpageblock.ts

@@ -7,6 +7,7 @@ import { ChatPage } from "./chatpage";
 import { RatingPage } from "./ratingpage";
 import { SettingsPage } from "./settingspage";
 
+/** Page block for changePassword, more, rating, chat and accout pages  */
 export class OtherPageBlock extends PageBlock {
     public changePasswordPage: ChangePasswordPage;
     public morePage: SettingsPage;

js/pages/ratingpage.ts

@@ -3,6 +3,7 @@ import { AccountManager } from "../services/accountManager";
 
 declare var app: App;
 
+/** RatingPage  */
 export class RatingPage implements Page {
     public ratings = ko.observableArray<UserRatingModel>();
     public loading = ko.observable(false);

js/pages/settingspage.ts

@@ -1,6 +1,7 @@
 import { _ } from "../languagemanager";
 import * as metadataManager from "../metadatamanager";
 
+/** Settings page */
 export class SettingsPage implements Page {
     public online: KnockoutObservable<string>;
     public registered: KnockoutObservable<string>;

js/pages/supportpage.ts

@@ -9,6 +9,7 @@ import { PageBase } from "../ui/pagebase";
 declare var host: string;
 declare var app: App;
 
+/** Support page */
 export class SupportPage extends PageBase implements KnockoutValidationGroup {
     public displayFullName = false;
     public displaySubject = false;

js/pages/tableslistpage.ts

@@ -12,6 +12,7 @@ import { PageBase } from "../ui/pagebase";
 declare var host: string;
 declare var app: App;
 
+/** Page that displyes tables list */
 export class TablesListPage extends PageBase {
     public tablesCaption: KnockoutComputed<string>;
     public tables: KnockoutObservableArray<any>;

js/pages/tablespage.ts

@@ -22,6 +22,7 @@ import { PageBase } from "../ui/pagebase";
 
 declare var app: App;
 
+/** Tables Page */
 export class TablesPage extends PageBase implements ICurrentTableProvider {
     public currentTable: KnockoutComputed<TableView>;
     public selectedTables: KnockoutComputed<TableView[]>;

js/pages/tournamentlobbypage.ts

@@ -43,6 +43,7 @@ interface TournamentTableListView {
     players: TournamentTablePlayerView[];
 }
 
+/** Lobby page for tournaments */
 export class TournamentLobbyPage extends PageBase {
     public loading: KnockoutObservable<boolean>;
     public tournamentId = 0;

js/pages/tournamentslistpage.ts

@@ -16,6 +16,7 @@ import { TournamentOptions } from "./lobbypage";
 
 declare var app: App;
 
+/** Page with tournaments list */
 export class TournamentsListPage extends PageBase {
     public tournamentsCaption: KnockoutComputed<string>;
     public tournaments: KnockoutObservableArray<LobbyTournamentItem>;

js/pages/withdrawalpage.ts

@@ -6,6 +6,7 @@ import { PageBase } from "../ui/pagebase";
 
 declare var app: App;
 
+/** Withdrawal Page */
 export class WithdrawalPage extends PageBase {
     public player: KnockoutObservable<any>;
     public withdrawalMethods: KnockoutObservableArray<any>;

js/popups/accountstatuspopup.ts

@@ -9,6 +9,7 @@ import { PopupBase } from "../ui/popupbase";
 
 declare var app: App;
 
+/** Account Status Popup */
 export class AccountStatusPopup extends PopupBase {
     public loading: KnockoutObservable<boolean>;
     public information: KnockoutObservable<AccountServiceInformation>;

js/popups/addmoneypopup.ts

@@ -11,6 +11,7 @@ import { PopupBase } from "../ui/popupbase";
 
 declare var app: App;
 
+/** Popup for adding money */
 export class AddMoneyPopup {
     public buyin: KnockoutObservable<number>;
     public minBuyin: KnockoutObservable<number>;

js/popups/authpopup.ts

@@ -9,6 +9,7 @@ import { PopupBase } from "../ui/popupbase";
 
 declare var app: App;
 
+/** Authentication popup */
 export class AuthPopup extends PopupBase {
     public login: KnockoutObservable<string>;
     public password: KnockoutObservable<string>;

js/popups/changepasswordpopup.ts

@@ -9,6 +9,7 @@ import { PopupBase } from "../ui/popupbase";
 
 declare var app: App;
 
+/** Popup for password change */
 export class ChangePasswordPopup extends PopupBase {
     public oldPassword = ko.observable<string>().extend({ required: true });
     public password: KnockoutObservable<string>;

js/popups/chatpopup.ts

@@ -11,6 +11,7 @@ import { ChatControl } from "../ui/chatcontrol";
 
 declare var app: App;
 
+/** Chat popup */
 export class ChatPopup {
     public control: ChatControl;
     public caption: KnockoutObservable<string>;

js/popups/continueforgetpasswordpopup.ts

@@ -7,6 +7,7 @@ import { PopupBase } from "../ui/popupbase";
 
 declare var app: App;
 
+/** Continue Forget Password Popup */
 export class ContinueForgetPasswordPopup extends PopupBase {
     public token: KnockoutObservable<string>;
     public password: KnockoutObservable<string>;

js/popups/custompopup.ts

@@ -5,6 +5,7 @@ import { PopupBase } from "../ui/popupbase";
 
 type PromiseOrVoid = void | Promise<void>;
 
+/** Custom Popup */
 export class CustomPopup extends PopupBase {
     public title: KnockoutObservable<string>;
     public messages: KnockoutObservableArray<string>;

js/popups/forgetpasswordpopup.ts

@@ -4,6 +4,7 @@ import { SimplePopup } from "../popups/simplepopup";
 import { AccountManager } from "../services/accountManager";
 import { PopupBase } from "../ui/popupbase";
 
+/** Forget Password Popup */
 export class ForgetPasswordPopup extends PopupBase {
     public login: KnockoutObservable<string>;
     public email: KnockoutObservable<string>;

js/popups/handhistorypopup.ts

@@ -13,6 +13,7 @@ enum HandHistoryDisplayMode {
     Detailed,
 }
 
+/** Popup for showing of previous game history */
 export class HandHistoryPopup extends PopupBase {
     public detailedOperations: KnockoutObservableArray<string>;
     public shortOperations: KnockoutObservableArray<string>;

js/popups/jointablepopup.ts

@@ -10,6 +10,7 @@ import { SimplePopup } from "./simplepopup";
 
 declare var app: App;
 
+/** Join Table Popup */
 export class JoinTablePopup {
     public buyin: KnockoutObservable<number>;
     public ticketCode: KnockoutObservable<string>;

js/popups/morepopup.ts

@@ -11,6 +11,7 @@ import { settings } from "../settings";
 declare var host: string;
 declare var app: App;
 
+/** More Popup */
 export class MorePopup {
     public authenticated: KnockoutObservable<boolean>;
     public login: KnockoutComputed<string>;