]> git.ipfire.org Git - thirdparty/foundation/foundation-sites.git/commitdiff
Quick fix for js docs 10310/head
authorKevin Ball <kmball11@gmail.com>
Fri, 30 Jun 2017 19:08:25 +0000 (12:08 -0700)
committerKevin Ball <kmball11@gmail.com>
Fri, 30 Jun 2017 19:08:25 +0000 (12:08 -0700)
21 files changed:
js/foundation.abide.js
js/foundation.accordion.js
js/foundation.accordionMenu.js
js/foundation.drilldown.js
js/foundation.dropdown.js
js/foundation.dropdownMenu.js
js/foundation.equalizer.js
js/foundation.interchange.js
js/foundation.magellan.js
js/foundation.offcanvas.js
js/foundation.orbit.js
js/foundation.responsiveAccordionTabs.js
js/foundation.responsiveMenu.js
js/foundation.responsiveToggle.js
js/foundation.reveal.js
js/foundation.slider.js
js/foundation.smoothScroll.js
js/foundation.sticky.js
js/foundation.tabs.js
js/foundation.toggler.js
js/foundation.tooltip.js

index 0d3d1f1a1a0603a0a3070f175ebf6fcaed199225..b1cea1e78957aeba0a208522b835d9c0ec3d2fc3 100644 (file)
@@ -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.
index 48c42f5fa211cf21ad889812e58ade06222b314e..0d601aac3f53b9dbc5bf7db34684c4a0eab07525 100644 (file)
@@ -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.
index 340bae4beb01bfc4b56b9aa131a0804dd49733ea..17ec7ebe9d8600e8404e5fd1c3cf53c99f06d242 100644 (file)
@@ -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.
index 57f4234e2c8e3192b489922364656c96ec466813..48e86b0ef37674944ff23ce8753f25e92e12bf5c 100644 (file)
@@ -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.
    */
index e5d88f08e65634d651bab1c0106d90dcfd8fac6c..ed32aa836115628b530f6e77dc149ac9822cceb1 100644 (file)
@@ -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.
index de04c2aa5b41ab7a7e01febfd318cb5e63f05a5e..5e2c6974cc1dda227de6d2697e1cebde14db7465 100644 (file)
@@ -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.
index 82e1f0e829b37823d4ca05b9fafd1679f030a2fd..bf4e8e5487ead9197836ee137d66cd080cf64605 100644 (file)
@@ -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.
index fb82e1e7c55a4b956ab737c04416d6a7a711ae5c..6591171bf109eb570afbd9e18fafc0d25b761a71 100755 (executable)
@@ -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.
index 44c8255f469f0e9b5928de0c6bd716dfd3ae8668..c6c9c94210fda00ed25e02d3dda44819db474781 100644 (file)
@@ -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.
index 2454b3fc91ea01c8a303bffb622b068fb8780e09..fde1404497587bbdc8f5c35af2235e21d17354fb 100644 (file)
@@ -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.
index 4771dd38d357564c6003d94652486b01ef45e640..b26d0bd7566c1626cdfc10cf3c33c85462acb896 100644 (file)
@@ -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.
   */
index 03c435c8663033e0b452b35dbd1e67fa33360fc5..4ae87d81e4460f1c32bdddbe55828a6f74058eec 100644 (file)
@@ -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.
index 181044a3be7180c58cf306dce33fc207904eb26f..3bc3e757e58bb2202cbd5f9970119c5636ad17d5 100644 (file)
@@ -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.
index 8ecd4735e3fc65411be62e9ccabb25b77343fec5..7e7f67fcb6ea624964d95f9a4b8345522ddf52fb 100644 (file)
@@ -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.
index 52042d24940f5192a4f8c72b6970cd377b07e889..e02ace43e1ca30afb038002d02be1c60fd5b41c6 100644 (file)
@@ -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.
    */
index 85d09f7c52320dcb4e84b0e8078646eec9bfa243..9d6cd9d76b3b5bc9605444a107324660bcb12b99 100644 (file)
@@ -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.
    */
index 9f1a81fd767b5193409d040b3eed952db8bb3462..bec7cebc104a18144cfbc318976463e5e2adc4ef 100644 (file)
@@ -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);
index 0722ceb0bb9b85f1adb1886d147a613256dbd285..e50f071ab4e2eb158b01bd22a789251171bdea9e 100644 (file)
@@ -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.
    */
index 9f4d8f734612d25df8e8cc15fc6d0da4847c4f38..c6380d2b7d62be34aa08c6c7904bf55c807daf09 100644 (file)
@@ -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.
index 53b25ff6cb683698e896ec857b5a8f1922b754ec..d8c5744ecab3a6875935723347039c4c498525e8 100644 (file)
@@ -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.
index 74c3ac4a27cb7862b0321e3aaa9aa679c59dffb4..7b2e26330e337597cd958a4a7e52b356b01e929a 100644 (file)
@@ -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.