javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-22 21:48:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(): fix bad types for docs

Browse Source
This commit is contained in:
mhartington
2016-02-12 16:36:27 -05:00
parent 5941042a98
commit 019009a3e2
9 changed files with 57 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
ionic/components/menu/menu-controller.ts
View File

@ -135,7 +135,7 @@ export class MenuController {
/**
* Progamatically open the Menu.
* @return {promise} returns a promise when the menu is fully opened
* @return {Promise} returns a promise when the menu is fully opened
*/
open(menuId?: string) {
let menu = this.get(menuId);
@ -147,7 +147,7 @@ export class MenuController {
/**
* Progamatically close the Menu.
* @param {string} [menuId] Optionally get the menu by its id, or side.
* @return {promise} returns a promise when the menu is fully closed
* @return {Promise} returns a promise when the menu is fully closed
*/
close(menuId?: string) {
let menu = this.get(menuId);
@ -160,7 +160,7 @@ export class MenuController {
* Toggle the menu. If it's closed, it will open, and if opened, it will
* close.
* @param {string} [menuId] Optionally get the menu by its id, or side.
* @return {promise} returns a promise when the menu has been toggled
* @return {Promise} returns a promise when the menu has been toggled
*/
toggle(menuId?: string) {
let menu = this.get(menuId);
@ -174,7 +174,7 @@ export class MenuController {
* left menus, but only one of them should be able to be dragged open.
* @param {boolean} shouldEnable True if it should be enabled, false if not.
* @param {string} [menuId] Optionally get the menu by its id, or side.
* @return {menu} Returns the instance of the menu, which is useful for chaining.
* @return {Menu} Returns the instance of the menu, which is useful for chaining.
*/
enable(shouldEnable: boolean, menuId?: string) {
let menu = this.get(menuId);
@ -187,7 +187,7 @@ export class MenuController {
* Used to enable or disable the ability to swipe open the menu.
* @param {boolean} shouldEnable True if it should be swipe-able, false if not.
* @param {string} [menuId] Optionally get the menu by its id, or side.
* @return {menu} Returns the instance of the menu, which is useful for chaining.
* @return {Menu} Returns the instance of the menu, which is useful for chaining.
*/
swipeEnable(shouldEnable: boolean, menuId?: string) {
let menu = this.get(menuId);
@ -199,7 +199,7 @@ export class MenuController {
/**
* Used to get a menu instance.
* @param {string} [menuId] Optionally get the menu by its id, or side.
* @return {menu} Returns the instance of the menu if found, otherwise `null`.
* @return {Menu} Returns the instance of the menu if found, otherwise `null`.
*/
get(menuId?: string): Menu {
if (menuId) {