docs(App): Adds documentation for the App class

Author: flore2003

src/app.ts

@@ -8,19 +8,33 @@ import moment = require('moment');
 import chrono = require('chrono-node');
 import { displayNumber, displayText } from './display.helper';
 
-
+/**
+ * The main app class
+ */
 export class App {
 
+    /**
+     * The api object used to communicate with Jira
+     */
     api: JiraApi;
 
+    /**
+     * The app's configuration
+     */
     config: Conf;
 
+    /**
+     * The JiraService that abstracts the actual logic to load data from and interact with Jira
+     */
     service: JiraService;
 
     constructor() {
 
     }
 
+    /**
+     * Initialize the application
+     */
     initialize(): Promise<App> {
         return this._loadConfig().then(() => {
             this._initializeApi();
@@ -29,6 +43,10 @@ export class App {
         });
     }
 
+    /**
+     * Load the backlog of the given project and display it
+     * @param project
+     */
     backlog(project: string) {
         this.service.getSprintsForProject(project).then(sprints => {
                 return sprints.filter(sprint => sprint.state !== 'closed')
@@ -44,6 +62,11 @@ export class App {
             });
     }
 
+    /**
+     * Load the board of the active sprint of the given project and display it
+     * @param project
+     * @param onlyMine
+     */
     board(project: string, onlyMine?: boolean) {
         this.service.getDisplayBoardForProject(project, onlyMine).then(board => {
             const maxWidth = (process.stdout.columns || 80) - board.length;
@@ -70,6 +93,11 @@ export class App {
         });
     }
 
+    /**
+     * Load the work log of the given user for the given date ad display it
+     * @param user
+     * @param date
+     */
     worklog(user = 'me', date?: string) {
         const parsedDate = (date) ? moment(chrono.parseDate(date)) : moment();
         this.service.getWorklogsForUser(user, parsedDate).then(worklogs => {
@@ -105,12 +133,22 @@ export class App {
         });
     }
 
+    /**
+     * Log a new work entry to the given issue
+     * @param issue
+     * @param duration
+     * @param start
+     * @param message
+     */
     log(issue: string, duration: number, start = new Date(), message?: string) {
         this.service.addWorkLogToIssue(issue, duration, start, message).then(response => {
             // do nothing
         });
     }
 
+    /**
+     * Guide the user through the initial setup
+     */
     init(): Promise<string> {
         return inquirer.prompt([
             {
@@ -135,6 +173,10 @@ export class App {
         });
     }
 
+    /**
+     * Load the config from the config dir and return it in a Promise
+     * @private
+     */
     private _loadConfig(): Promise<Conf> {
         this.config = new Conf({
             encryptionKey: 'sdfyu7y3irfsov869wuvut7sdiyfuk'
@@ -147,10 +189,18 @@ export class App {
         }
     }
 
+    /**
+     * Inititalize the JiraApi interface
+     * @private
+     */
     private _initializeApi() {
         this.api = new JiraApi(this.config.get('api'));
     }
 
+    /**
+     * Initialize the JiraService
+     * @private
+     */
     private _initializeService() {
         this.service = new JiraService(this.api);
     }