From 10ff68ab6c4fe752dd3048ae2a13a27a3d43c8f5 Mon Sep 17 00:00:00 2001
From: mhartington <mikehartington@gmail.com>
Date: Wed, 16 Dec 2015 14:00:21 -0500
Subject: [PATCH] docs(): labels, keyboard

---
 ionic/components/text-input/label.ts |  3 ++
 ionic/util/keyboard.ts               | 59 ++++++++++++++++++++++++++++
 2 files changed, 62 insertions(+)

diff --git a/ionic/components/text-input/label.ts b/ionic/components/text-input/label.ts
index 24ef7c886c..7eb7170fba 100644
--- a/ionic/components/text-input/label.ts
+++ b/ionic/components/text-input/label.ts
@@ -50,6 +50,9 @@ export class Label {
     this.container = container;
   }
 
+/**
+ * @private
+ */
   ngOnInit() {
     if (!this.id) {
       this.id = 'lbl-' + this.form.nextId();
diff --git a/ionic/util/keyboard.ts b/ionic/util/keyboard.ts
index 189d78b184..97437ee039 100644
--- a/ionic/util/keyboard.ts
+++ b/ionic/util/keyboard.ts
@@ -4,6 +4,21 @@ import {Config} from '../config/config';
 import {Form} from './form';
 import {hasFocusedTextInput, raf, rafFrames} from './dom';
 
+/**
+ * @name Keyboard
+ * @description
+ * The `Keyboard` class allows you to work with the keyboard events provide by the Ionic keyboard plugin.
+ *
+ * @usage
+ * ```ts
+ * export class MyClass{
+ *  constructor(keyboard: Keyboard){
+ *    this.keyboard = keyboard;
+ *  }
+ * }
+ *
+ * ```
+ */
 
 @Injectable()
 export class Keyboard {
@@ -17,10 +32,47 @@ export class Keyboard {
     });
   }
 
+
+/**
+ * Chech to see if the keyboard is open or not.
+ *
+ * ```ts
+ * export class MyClass{
+ *  constructor(keyboard: Keyboard){
+ *    this.keyboard = keyboard;
+ *  }
+ *  keyboardCheck(){
+ *    setTimeout(()  => console.log('is the keyboard open ', this.keyboard.isOpen()));
+ *  }
+ * }
+ *
+ * ```
+ *
+ * @return {Bool} returns a true or flase value if the keyboard is open or not
+ */
   isOpen() {
     return hasFocusedTextInput();
   }
 
+/**
+ * When the keyboard is closed, call any methods you want
+ *
+ * ```ts
+ * export class MyClass{
+ *  constructor(keyboard: Keyboard){
+ *    this.keyboard = keyboard;
+ *    this.keyboard.onClose(this.closeCallback);
+ *  }
+ *  closeCallback(){
+ *     // call what ever functionality you want on keyboard close
+ *     console.log('Closing time");
+ *  }
+ * }
+ *
+ * ```
+ * @param {Function} callback method you want to call when the keyboard has been closed
+ * @return {Function} returns a callback that gets fired when the keyboard is closed
+ */
   onClose(callback, pollingInternval=KEYBOARD_CLOSE_POLLING) {
     console.debug('keyboard onClose');
     const self = this;
@@ -57,6 +109,10 @@ export class Keyboard {
     return promise;
   }
 
+/**
+ * Progamatically close they keyboard
+ *
+ */
   close() {
     console.debug('keyboard close()');
     raf(() => {
@@ -67,6 +123,9 @@ export class Keyboard {
     });
   }
 
+/**
+ * @private
+ */
   focusOutline(setting, document) {
     /* Focus Outline
      * --------------------------------------------------