From 794a40a11e9898d59d5302982265b0662444669c Mon Sep 17 00:00:00 2001 From: Max Guglielmi Date: Sun, 5 Jun 2016 18:54:14 +1000 Subject: [PATCH] Added comments to constants for auto-generated docs --- src/const.js | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 57 insertions(+), 1 deletion(-) diff --git a/src/const.js b/src/const.js index 2ff53891..eb3e24e7 100644 --- a/src/const.js +++ b/src/const.js @@ -1,28 +1,84 @@ /** * Filter types */ + +/** + * Input filter type + * @type {String} + */ export const INPUT = 'input'; +/** + * Select filter type + * @type {String} + */ export const SELECT = 'select'; +/** + * Multiple select filter type + * @type {String} + */ export const MULTIPLE = 'multiple'; +/** + * Checklist filter type + * @type {String} + */ export const CHECKLIST = 'checklist'; +/** + * None filter type + * @type {String} + */ export const NONE = 'none'; /** * Key codes */ + +/** + * Enter key code + * @type {Number} + */ export const ENTER_KEY = 13; +/** + * Tab key code + * @type {Number} + */ export const TAB_KEY = 9; +/** + * Escape key code + * @type {Number} + */ export const ESC_KEY = 27; +/** + * Up arrow key code + * @type {Number} + */ export const UP_ARROW_KEY = 38; +/** + * Down arrow key code + * @type {Number} + */ export const DOWN_ARROW_KEY = 40; /** * HTML tags */ + +/** + * Header cell tag + * @type {String} + */ export const HEADER_TAG = 'TH'; +/** + * Cell tag + * @type {String} + */ export const CELL_TAG = 'TD'; /** - * Numeric values + * Default values + */ + +/** + * Auto filter delay in milliseconds + * @type {Number} */ export const AUTO_FILTER_DELAY = 750;