upjs-rails 0.13.0 → 0.14.0

data/lib/assets/javascripts/up/syntax.js.coffee

@@ -192,6 +192,7 @@ up.syntax = (($) ->
     clear global state such as time-outs and event handlers bound to the document.
     The destructor is *not* expected to remove the element from the DOM, which
     is already handled by [`up.destroy`](/up.destroy).
+  @stable
   ###
   compilers = []
   defaultCompilers = null
@@ -235,16 +236,13 @@ up.syntax = (($) ->
 
   Returns an empty object if the element has no `up-data` attribute.
 
-  The API of this method is likely to change in the future, so
-  we can support getting or setting individual keys.
-
-  @protected
   @function up.syntax.data
   @param {String|Element|jQuery} elementOrSelector
   @return
     The JSON-decoded value of the `up-data` attribute.
 
     Returns an empty object (`{}`) if the element has no (or an empty) `up-data` attribute.
+  @experimental
   ###
 
   ###
@@ -259,6 +257,7 @@ up.syntax = (($) ->
   @selector [up-data]
   @param {JSON} up-data
     A serialized JSON string
+  @stable
   ###
   data = (elementOrSelector) ->
     $element = $(elementOrSelector)
@@ -272,7 +271,7 @@ up.syntax = (($) ->
   Makes a snapshot of the currently registered event listeners,
   to later be restored through `reset`.
   
-  @private
+  @internal
   ###
   snapshot = ->
     defaultCompilers = u.copy(compilers)
@@ -281,7 +280,7 @@ up.syntax = (($) ->
   Resets the list of registered compiler directives to the
   moment when the framework was booted.
   
-  @private
+  @internal
   ###
   reset = ->
     compilers = u.copy(defaultCompilers)
@@ -305,6 +304,7 @@ up.syntax = (($) ->
 
   @function up.hello
   @param {String|Element|jQuery} selectorOrElement
+  @stable
   ###
   hello = (selectorOrElement) ->
     $element = $(selectorOrElement)
@@ -324,6 +324,7 @@ up.syntax = (($) ->
   @event up:fragment:inserted
   @param {jQuery} event.$element
     The fragment that has been inserted or updated.
+  @stable
   ###
 
   up.on 'ready', (-> hello(document.body))

data/lib/assets/javascripts/up/tooltip.js.coffee

@@ -92,6 +92,9 @@ up.tooltip = (($) ->
     The position of the tooltip. Known values are `top` and `bottom`.
   @param {String} [options.animation]
     The animation to use when opening the tooltip.
+  @return {Promise}
+    A promise that will be resolved when the tooltip's opening animation has finished.
+  @stable
   ###
   attach = (linkOrSelector, options = {}) ->
     $link = $(linkOrSelector)
@@ -112,6 +115,7 @@ up.tooltip = (($) ->
   @function up.tooltip.close
   @param {Object} options
     See options for [`up.animate`](/up.animate).
+  @stable
   ###
   close = (options) ->
     $tooltip = $('.up-tooltip')
@@ -138,6 +142,7 @@ up.tooltip = (($) ->
     The default position of tooltips relative to the element.
     Can be either `"top"` or `"bottom"`.
     Defaults to [`up.tooltip.config.position`](/up.tooltip.config).
+  @stable
   ###
 
   ###*
@@ -146,6 +151,7 @@ up.tooltip = (($) ->
       <a href="/decks" up-tooltip="Show &lt;b&gt;all&lt;/b&gt; decks">Decks</a>
 
   @selector [up-tooltip-html]
+  @stable
   ###
   up.compiler('[up-tooltip], [up-tooltip-html]', ($link) ->
     # Don't register these events on document since *every*