Skip to content

Commit fa25552

Browse files
committed
Entries: Make deprecations more useful
Ref 09d05eb Fixes gh-261
1 parent 2af9f44 commit fa25552

File tree

3 files changed

+14
-5
lines changed

3 files changed

+14
-5
lines changed

entries/dialog.xml

+4-1
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,10 @@
142142
<type name="String" />
143143
</option>
144144
<option name="dialogClass" default='""' example-value='"alert"' deprecated="1.12">
145-
<desc>The specified class name(s) will be added to the dialog, for additional theming.</desc>
145+
<desc>
146+
<p>The specified class name(s) will be added to the dialog, for additional theming.</p>
147+
<p>The <code>dialogClass</code> option has been deprecated in favor of the <a href="#option-classes"><code>classes</code> option</a>, using the <code>ui-dialog</code> property.</p>
148+
</desc>
146149
<type name="String" />
147150
</option>
148151
<option name="draggable" default="true" example-value="false">

entries/droppable.xml

+8-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@
3030
</type>
3131
</option>
3232
<option name="activeClass" type="String" default="false" example-value='"ui-state-highlight"' deprecated="1.12">
33-
<desc>If specified, the class will be added to the droppable while an acceptable draggable is being dragged.</desc>
33+
<desc>
34+
<p>If specified, the class will be added to the droppable while an acceptable draggable is being dragged.</p>
35+
<p>The <code>activeClass</code> option has been deprecated in favor of the <a href="#option-classes"><code>classes</code> option</a>, using the <code>ui-droppable-active</code>.</p>
36+
</desc>
3437
</option>
3538
<option name="addClasses" type="Boolean" default="true" example-value="false">
3639
<desc>If set to <code>false</code>, will prevent the <code>ui-droppable</code> class from being added. This may be desired as a performance optimization when calling <code>.droppable()</code> init on hundreds of elements.</desc>
@@ -44,7 +47,10 @@
4447
<desc>By default, when an element is dropped on nested droppables, each droppable will receive the element. However, by setting this option to <code>true</code>, any parent droppables will not receive the element. The <code>drop</code> event will still bubble normally, but the <code>event.target</code> can be checked to see which droppable received the draggable element.</desc>
4548
</option>
4649
<option name="hoverClass" type="String" default="false" example-value='"drop-hover"' deprecated="1.12">
47-
<desc>If specified, the class will be added to the droppable while an acceptable draggable is being hovered over the droppable.</desc>
50+
<desc>
51+
<p>If specified, the class will be added to the droppable while an acceptable draggable is being hovered over the droppable.</p>
52+
<p>The <code>hoverClass</code> option has been deprecated in favor of the <a href="#option-classes"><code>classes</code> option</a>, using the <code>ui-droppable-hover</code>.</p>
53+
</desc>
4854
</option>
4955
<option name="scope" type="String" default='"default"' example-value='"tasks"'>
5056
<desc>Used to group sets of draggable and droppable items, in addition to the <a href="#option-accept"><code>accept</code></a> option. A draggable with the same scope value as a droppable will be accepted.</desc>

entries/tooltip.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@
8585
<xi:include href="../includes/widget-option-show.xml" xmlns:xi="http://www.w3.org/2003/XInclude"/>
8686
<option name="tooltipClass" default="null" example-value='"custom-tooltip-styling"' deprecated="1.12">
8787
<desc>
88-
A class to add to the widget, can be used to display various tooltip types, like warnings or errors.
89-
<p>This may get replaced by the <a href="http://bugs.jqueryui.com/ticket/7053">classes option</a>.</p>
88+
<p>A class to add to the widget, can be used to display various tooltip types, like warnings or errors.</p>
89+
<p>The <code>tooltipClass</code> option has been deprecated in favor of the <a href="#option-classes"><code>classes</code> option</a>, using the <code>ui-tooltip</code>.</p>
9090
</desc>
9191
<type name="String" />
9292
</option>

0 commit comments

Comments
 (0)