From 0c4408883205aa8163c0990c2d06fb2e718d132a Mon Sep 17 00:00:00 2001 From: Kevin Ball Date: Fri, 30 Jun 2017 12:08:25 -0700 Subject: [PATCH] Quick fix for js docs --- js/foundation.abide.js | 1 + js/foundation.accordion.js | 1 + js/foundation.accordionMenu.js | 1 + js/foundation.drilldown.js | 1 + js/foundation.dropdown.js | 1 + js/foundation.dropdownMenu.js | 1 + js/foundation.equalizer.js | 1 + js/foundation.interchange.js | 1 + js/foundation.magellan.js | 1 + js/foundation.offcanvas.js | 1 + js/foundation.orbit.js | 1 + js/foundation.responsiveAccordionTabs.js | 1 + js/foundation.responsiveMenu.js | 1 + js/foundation.responsiveToggle.js | 1 + js/foundation.reveal.js | 1 + js/foundation.slider.js | 1 + js/foundation.smoothScroll.js | 8 ++++++++ js/foundation.sticky.js | 1 + js/foundation.tabs.js | 1 + js/foundation.toggler.js | 1 + js/foundation.tooltip.js | 1 + 21 files changed, 28 insertions(+) diff --git a/js/foundation.abide.js b/js/foundation.abide.js index 0d3d1f1a1..b1cea1e78 100644 --- a/js/foundation.abide.js +++ b/js/foundation.abide.js @@ -12,6 +12,7 @@ class Abide extends Plugin { /** * Creates a new instance of Abide. * @class + * @name Abide * @fires Abide#init * @param {Object} element - jQuery object to add the trigger to. * @param {Object} options - Overrides to the default plugin settings. diff --git a/js/foundation.accordion.js b/js/foundation.accordion.js index 48c42f5fa..0d601aac3 100644 --- a/js/foundation.accordion.js +++ b/js/foundation.accordion.js @@ -15,6 +15,7 @@ class Accordion extends Plugin { /** * Creates a new instance of an accordion. * @class + * @name Accordion * @fires Accordion#init * @param {jQuery} element - jQuery object to make into an accordion. * @param {Object} options - a plain object with settings to override the default options. diff --git a/js/foundation.accordionMenu.js b/js/foundation.accordionMenu.js index 340bae4be..17ec7ebe9 100644 --- a/js/foundation.accordionMenu.js +++ b/js/foundation.accordionMenu.js @@ -18,6 +18,7 @@ class AccordionMenu extends Plugin { /** * Creates a new instance of an accordion menu. * @class + * @name AccordionMenu * @fires AccordionMenu#init * @param {jQuery} element - jQuery object to make into an accordion menu. * @param {Object} options - Overrides to the default plugin settings. diff --git a/js/foundation.drilldown.js b/js/foundation.drilldown.js index 57f4234e2..48e86b0ef 100644 --- a/js/foundation.drilldown.js +++ b/js/foundation.drilldown.js @@ -19,6 +19,7 @@ class Drilldown extends Plugin { /** * Creates a new instance of a drilldown menu. * @class + * @name Drilldown * @param {jQuery} element - jQuery object to make into an accordion menu. * @param {Object} options - Overrides to the default plugin settings. */ diff --git a/js/foundation.dropdown.js b/js/foundation.dropdown.js index e5d88f08e..ed32aa836 100644 --- a/js/foundation.dropdown.js +++ b/js/foundation.dropdown.js @@ -19,6 +19,7 @@ class Dropdown extends Positionable { /** * Creates a new instance of a dropdown. * @class + * @name Dropdown * @param {jQuery} element - jQuery object to make into a dropdown. * Object should be of the dropdown panel, rather than its anchor. * @param {Object} options - Overrides to the default plugin settings. diff --git a/js/foundation.dropdownMenu.js b/js/foundation.dropdownMenu.js index de04c2aa5..5e2c6974c 100644 --- a/js/foundation.dropdownMenu.js +++ b/js/foundation.dropdownMenu.js @@ -20,6 +20,7 @@ class DropdownMenu extends Plugin { /** * Creates a new instance of DropdownMenu. * @class + * @name DropdownMenu * @fires DropdownMenu#init * @param {jQuery} element - jQuery object to make into a dropdown menu. * @param {Object} options - Overrides to the default plugin settings. diff --git a/js/foundation.equalizer.js b/js/foundation.equalizer.js index 82e1f0e82..bf4e8e548 100644 --- a/js/foundation.equalizer.js +++ b/js/foundation.equalizer.js @@ -17,6 +17,7 @@ class Equalizer extends Plugin { /** * Creates a new instance of Equalizer. * @class + * @name Equalizer * @fires Equalizer#init * @param {Object} element - jQuery object to add the trigger to. * @param {Object} options - Overrides to the default plugin settings. diff --git a/js/foundation.interchange.js b/js/foundation.interchange.js index fb82e1e7c..6591171bf 100755 --- a/js/foundation.interchange.js +++ b/js/foundation.interchange.js @@ -16,6 +16,7 @@ class Interchange extends Plugin { /** * Creates a new instance of Interchange. * @class + * @name Interchange * @fires Interchange#init * @param {Object} element - jQuery object to add the trigger to. * @param {Object} options - Overrides to the default plugin settings. diff --git a/js/foundation.magellan.js b/js/foundation.magellan.js index 44c8255f4..c6c9c9421 100644 --- a/js/foundation.magellan.js +++ b/js/foundation.magellan.js @@ -16,6 +16,7 @@ class Magellan extends Plugin { /** * Creates a new instance of Magellan. * @class + * @name Magellan * @fires Magellan#init * @param {Object} element - jQuery object to add the trigger to. * @param {Object} options - Overrides to the default plugin settings. diff --git a/js/foundation.offcanvas.js b/js/foundation.offcanvas.js index 2454b3fc9..fde140449 100644 --- a/js/foundation.offcanvas.js +++ b/js/foundation.offcanvas.js @@ -20,6 +20,7 @@ class OffCanvas extends Plugin { /** * Creates a new instance of an off-canvas wrapper. * @class + * @name OffCanvas * @fires OffCanvas#init * @param {Object} element - jQuery object to initialize. * @param {Object} options - Overrides to the default plugin settings. diff --git a/js/foundation.orbit.js b/js/foundation.orbit.js index 4771dd38d..b26d0bd75 100644 --- a/js/foundation.orbit.js +++ b/js/foundation.orbit.js @@ -24,6 +24,7 @@ class Orbit extends Plugin { /** * Creates a new instance of an orbit carousel. * @class + * @name Orbit * @param {jQuery} element - jQuery object to make into an Orbit Carousel. * @param {Object} options - Overrides to the default plugin settings. */ diff --git a/js/foundation.responsiveAccordionTabs.js b/js/foundation.responsiveAccordionTabs.js index 03c435c86..4ae87d81e 100644 --- a/js/foundation.responsiveAccordionTabs.js +++ b/js/foundation.responsiveAccordionTabs.js @@ -33,6 +33,7 @@ class ResponsiveAccordionTabs extends Plugin{ /** * Creates a new instance of a responsive accordion tabs. * @class + * @name ResponsiveAccordionTabs * @fires ResponsiveAccordionTabs#init * @param {jQuery} element - jQuery object to make into Responsive Accordion Tabs. * @param {Object} options - Overrides to the default plugin settings. diff --git a/js/foundation.responsiveMenu.js b/js/foundation.responsiveMenu.js index 181044a3b..3bc3e757e 100644 --- a/js/foundation.responsiveMenu.js +++ b/js/foundation.responsiveMenu.js @@ -39,6 +39,7 @@ class ResponsiveMenu extends Plugin { /** * Creates a new instance of a responsive menu. * @class + * @name ResponsiveMenu * @fires ResponsiveMenu#init * @param {jQuery} element - jQuery object to make into a dropdown menu. * @param {Object} options - Overrides to the default plugin settings. diff --git a/js/foundation.responsiveToggle.js b/js/foundation.responsiveToggle.js index 8ecd4735e..7e7f67fcb 100644 --- a/js/foundation.responsiveToggle.js +++ b/js/foundation.responsiveToggle.js @@ -17,6 +17,7 @@ class ResponsiveToggle extends Plugin { /** * Creates a new instance of Tab Bar. * @class + * @name ResponsiveToggle * @fires ResponsiveToggle#init * @param {jQuery} element - jQuery object to attach tab bar functionality to. * @param {Object} options - Overrides to the default plugin settings. diff --git a/js/foundation.reveal.js b/js/foundation.reveal.js index 52042d249..e02ace43e 100644 --- a/js/foundation.reveal.js +++ b/js/foundation.reveal.js @@ -20,6 +20,7 @@ class Reveal extends Plugin { /** * Creates a new instance of Reveal. * @class + * @name Reveal * @param {jQuery} element - jQuery object to use for the modal. * @param {Object} options - optional parameters. */ diff --git a/js/foundation.slider.js b/js/foundation.slider.js index 85d09f7c5..9d6cd9d76 100644 --- a/js/foundation.slider.js +++ b/js/foundation.slider.js @@ -23,6 +23,7 @@ class Slider extends Plugin { /** * Creates a new instance of a slider control. * @class + * @name Slider * @param {jQuery} element - jQuery object to make into a slider control. * @param {Object} options - Overrides to the default plugin settings. */ diff --git a/js/foundation.smoothScroll.js b/js/foundation.smoothScroll.js index 9f1a81fd7..bec7cebc1 100644 --- a/js/foundation.smoothScroll.js +++ b/js/foundation.smoothScroll.js @@ -9,6 +9,14 @@ import { Plugin } from './foundation.plugin'; * @module foundation.smooth-scroll */ class SmoothScroll extends Plugin { + /** + * Creates a new instance of SmoothScroll. + * @class + * @name SmoothScroll + * @fires SmoothScroll#init + * @param {Object} element - jQuery object to add the trigger to. + * @param {Object} options - Overrides to the default plugin settings. + */ _setup(element, options) { this.$element = element; this.options = $.extend({}, SmoothScroll.defaults, this.$element.data(), options); diff --git a/js/foundation.sticky.js b/js/foundation.sticky.js index 0722ceb0b..e50f071ab 100644 --- a/js/foundation.sticky.js +++ b/js/foundation.sticky.js @@ -17,6 +17,7 @@ class Sticky extends Plugin { /** * Creates a new instance of a sticky thing. * @class + * @name Sticky * @param {jQuery} element - jQuery object to make sticky. * @param {Object} options - options object passed when creating the element programmatically. */ diff --git a/js/foundation.tabs.js b/js/foundation.tabs.js index 9f4d8f734..c6380d2b7 100644 --- a/js/foundation.tabs.js +++ b/js/foundation.tabs.js @@ -15,6 +15,7 @@ class Tabs extends Plugin { /** * Creates a new instance of tabs. * @class + * @name Tabs * @fires Tabs#init * @param {jQuery} element - jQuery object to make into tabs. * @param {Object} options - Overrides to the default plugin settings. diff --git a/js/foundation.toggler.js b/js/foundation.toggler.js index 53b25ff6c..d8c5744ec 100644 --- a/js/foundation.toggler.js +++ b/js/foundation.toggler.js @@ -16,6 +16,7 @@ class Toggler extends Plugin { /** * Creates a new instance of Toggler. * @class + * @name Toggler * @fires Toggler#init * @param {Object} element - jQuery object to add the trigger to. * @param {Object} options - Overrides to the default plugin settings. diff --git a/js/foundation.tooltip.js b/js/foundation.tooltip.js index 74c3ac4a2..7b2e26330 100644 --- a/js/foundation.tooltip.js +++ b/js/foundation.tooltip.js @@ -19,6 +19,7 @@ class Tooltip extends Positionable { /** * Creates a new instance of a Tooltip. * @class + * @name Tooltip * @fires Tooltip#init * @param {jQuery} element - jQuery object to attach a tooltip to. * @param {Object} options - object to extend the default configuration. -- 2.47.2