Skip to content

Commit 580380f

Browse files
committed
All: Document deep option getter/setter
Fixes jquerygh-227 Closes jquerygh-235
1 parent 166f107 commit 580380f

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

includes/widget-method-option.xml

+8-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@
44
Sets one or more options for the <placeholder name="name"/>.
55
</desc>
66
<signature return="Object" example-return-var="isDisabled" example-params='"disabled"'>
7-
<desc>Gets the value currently associated with the specified <code>optionName</code>.</desc>
7+
<desc>
8+
<p>Gets the value currently associated with the specified <code>optionName</code>.</p>
9+
<p><strong>Note:</strong> For options that have objects as their value, you can get the value of a specific key by using dot notation. For example, <code>"foo.bar"</code> would get the value of the <code>bar</code> property on the <code>foo</code> option.</p>
10+
</desc>
811
<argument name="optionName" type="String">
912
<desc>The name of the option to get.</desc>
1013
</argument>
@@ -13,7 +16,10 @@
1316
<desc>Gets an object containing key/value pairs representing the current <placeholder name="name"/> options hash.</desc>
1417
</signature>
1518
<signature example-params='"disabled", true'>
16-
<desc>Sets the value of the <placeholder name="name"/> option associated with the specified <code>optionName</code>.</desc>
19+
<desc>
20+
<p>Sets the value of the <placeholder name="name"/> option associated with the specified <code>optionName</code>.</p>
21+
<p><strong>Note:</strong> For options that have objects as their value, you can set the value of just one property by using dot notation for <code>optionName</code>. For example, <code>"foo.bar"</code> would update only the <code>bar</code> property of the <code>foo</code> option.</p>
22+
</desc>
1723
<argument name="optionName" type="String">
1824
<desc>The name of the option to set.</desc>
1925
</argument>

0 commit comments

Comments
 (0)