sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Minor documentation fixes for the `wp.a11y.speak()` and `addContainer()` DocBlocks. 

See [33000]. See #32891.


git-svn-id: https://develop.svn.wordpress.org/trunk@33201 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-07-13 17:57:01 +00:00
parent 5b766e2082
commit b1a3776a86
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/wp-includes/js/wp-a11y.js
View File

@ -15,7 +15,7 @@ window.wp = window.wp || {};
* *
* @param {String} message The message to be announced by Assistive Technologies. * @param {String} message The message to be announced by Assistive Technologies.
* @param {String} ariaLive Optional. The politeness level for aria-live. Possible values: * @param {String} ariaLive Optional. The politeness level for aria-live. Possible values:
* polite or assertive. Default polite. * polite or assertive. Default polite.
*/ */
function speak( message, ariaLive ) { function speak( message, ariaLive ) {
// Clear previous messages to allow repeated strings being read out. // Clear previous messages to allow repeated strings being read out.
@ -33,8 +33,7 @@ window.wp = window.wp || {};
* *
* @since 4.3.0 * @since 4.3.0
* *
* @param {String} id The id attribute for the live region. * @param {String} ariaLive Optional. Value for the 'aria-live' attribute, default 'polite'.
* @param {String} ariaLive Optional Value for the 'aria-live' attribute, default 'polite'.
* *
* @return {Object} $container The ARIA live region jQuery object. * @return {Object} $container The ARIA live region jQuery object.
*/ */