<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[43143] trunk/src/wp-includes/js/wp-emoji-loader.js: Docs: Improve JSDoc for `js/wp-emoji-loader.js`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/43143">43143</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/43143","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>atimmer</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-05-03 15:08:39 +0000 (Thu, 03 May 2018)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Improve JSDoc for `js/wp-emoji-loader.js`.
Props nicollle, dfangstrom, Igorsch.
Fixes <a href="https://core.trac.wordpress.org/ticket/43870">#43870</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesjswpemojiloaderjs">trunk/src/wp-includes/js/wp-emoji-loader.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesjswpemojiloaderjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/js/wp-emoji-loader.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/js/wp-emoji-loader.js 2018-05-03 14:47:16 UTC (rev 43142)
+++ trunk/src/wp-includes/js/wp-emoji-loader.js 2018-05-03 15:08:39 UTC (rev 43143)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,19 +1,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ( function( window, document, settings ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var src, ready, ii, tests;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * Create a canvas element for testing native browser support
- * of emoji.
- */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Create a canvas element for testing native browser support of emoji.
</ins><span class="cx" style="display: block; padding: 0 10px"> var canvas = document.createElement( 'canvas' );
</span><span class="cx" style="display: block; padding: 0 10px"> var context = canvas.getContext && canvas.getContext( '2d' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check if two sets of Emoji characters render the same.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks if two sets of Emoji characters render the same visually.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param set1 array Set of Emoji characters.
- * @param set2 array Set of Emoji characters.
- * @returns {boolean} True if the two sets render the same.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.9.0
+ *
+ * @private
+ *
+ * @param {number[]} set1 Set of Emoji character codes.
+ * @param {number[]} set2 Set of Emoji character codes.
+ *
+ * @return {boolean} True if the two sets render the same.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function emojiSetsRenderIdentically( set1, set2 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var stringFromCharCode = String.fromCharCode;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -32,13 +34,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Detect if the browser supports rendering emoji or flag emoji. Flag emoji are a single glyph
- * made of two characters, so some browsers (notably, Firefox OS X) don't support them.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Detects if the browser supports rendering emoji or flag emoji.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Flag emoji are a single glyph made of two characters, so some browsers
+ * (notably, Firefox OS X) don't support them.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 4.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param type {String} Whether to test for support of "flag" or "emoji".
- * @return {Boolean} True if the browser can render emoji, false if it cannot.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @private
+ *
+ * @param {string} type Whether to test for support of "flag" or "emoji".
+ *
+ * @return {boolean} True if the browser can render emoji, false if it cannot.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function browserSupportsEmoji( type ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var isIdentical;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -104,6 +111,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Adds a script to the head of the document.
+ *
+ * @ignore
+ *
+ * @since 4.2.0
+ *
+ * @param {Object} src The url where the script is located.
+ * @return {void}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> function addScript( src ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var script = document.createElement( 'script' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -119,6 +136,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> everythingExceptFlag: true
</span><span class="cx" style="display: block; padding: 0 10px"> };
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Tests the browser support for flag emojis and other emojis, and adjusts the
+ * support settings accordingly.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> for( ii = 0; ii < tests.length; ii++ ) {
</span><span class="cx" style="display: block; padding: 0 10px"> settings.supports[ tests[ ii ] ] = browserSupportsEmoji( tests[ ii ] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -131,16 +152,21 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> settings.supports.everythingExceptFlag = settings.supports.everythingExceptFlag && ! settings.supports.flag;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Sets DOMReady to false and assigns a ready function to settings.
</ins><span class="cx" style="display: block; padding: 0 10px"> settings.DOMReady = false;
</span><span class="cx" style="display: block; padding: 0 10px"> settings.readyCallback = function() {
</span><span class="cx" style="display: block; padding: 0 10px"> settings.DOMReady = true;
</span><span class="cx" style="display: block; padding: 0 10px"> };
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // When the browser can not render everything we need to load a polyfill.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! settings.supports.everything ) {
</span><span class="cx" style="display: block; padding: 0 10px"> ready = function() {
</span><span class="cx" style="display: block; padding: 0 10px"> settings.readyCallback();
</span><span class="cx" style="display: block; padding: 0 10px"> };
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Cross-browser version of adding a dom ready event.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( document.addEventListener ) {
</span><span class="cx" style="display: block; padding: 0 10px"> document.addEventListener( 'DOMContentLoaded', ready, false );
</span><span class="cx" style="display: block; padding: 0 10px"> window.addEventListener( 'load', ready, false );
</span></span></pre>
</div>
</div>
</body>
</html>