Skip to content

Commit fdfc9d8

Browse files
Fix PDoc in dom.js. (Victor Homyakov, Andrew Dupont)
1 parent fca9334 commit fdfc9d8

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

src/prototype/dom/dom.js

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -188,12 +188,12 @@
188188
*
189189
* ##### Examples
190190
*
191-
* Hide the element
191+
* Hide the element:
192192
*
193193
* $(element).hide();
194194
*
195195
* Return an [[Enumerable]] of all descendant nodes of the element with the id
196-
* "article"
196+
* "articles":
197197
*
198198
* $('articles').descendants();
199199
**/
@@ -246,7 +246,7 @@
246246

247247
methods.inspect = inspect;
248248

249-
// VISIBLITY
249+
// VISIBILITY
250250

251251
/**
252252
* Element.visible(@element) -> Boolean
@@ -307,16 +307,16 @@
307307
*
308308
* ##### Examples
309309
*
310-
* <div id="welcome-message"></div>
311-
* <div id="error-message" style="display:none;"></div>
310+
* <div id="welcome-message">Welcome</div>
311+
* <div id="error-message" style="display:none;">Error</div>
312312
*
313313
* $('welcome-message').toggle();
314314
* // -> Element (and hides div#welcome-message)
315315
*
316316
* $('error-message').toggle();
317317
* // -> Element (and displays div#error-message)
318318
*
319-
* $('error-message).toggle(true);
319+
* $('error-message').toggle(true);
320320
* // -> Element (and displays div#error-message, no matter what its
321321
* // previous state)
322322
*
@@ -2472,7 +2472,7 @@
24722472
* $('mutsu').removeClassName('food');
24732473
* // -> Element
24742474
*
2475-
* $('mutsu').classNames;
2475+
* $('mutsu').className;
24762476
* // -> 'apple fruit'
24772477
**/
24782478
function removeClassName(element, className) {
@@ -2829,7 +2829,7 @@
28292829
* 1. Reading and writing the CSS `opacity` property works exactly like
28302830
* calling [[Element.getOpacity]] and [[Element.setOpacity]]
28312831
* respectively. This lets us pretend that IE didn't have a
2832-
* properietary way to set opacity in versions 6-7.
2832+
* proprietary way to set opacity in versions 6-7.
28332833
* 2. Browsers disagree on how to report certain properties of hidden
28342834
* elements (i.e., `display: none`). Opera, for instance, says that a
28352835
* hidden element has a `width` of `0px`. It's an arguable point, but
@@ -3046,8 +3046,11 @@
30463046

30473047
/**
30483048
* Element.store(@element, key, value) -> Element
3049+
* Element.store(@element, object) -> Element
30493050
*
3050-
* Stores a key/value pair of custom metadata on the element.
3051+
* Stores a key/value pair of custom metadata on the element. If it is
3052+
* given one argument instead of two, it treats that argument as an object
3053+
* of key/value pairs, and stores _each_ pair as element metadata.
30513054
*
30523055
* The metadata can later be retrieved with [[Element.retrieve]].
30533056
**/

0 commit comments

Comments
 (0)