enmi-conf.org: comparison wp/wp-includes/js/autosave.js

Mercurial Mercurial > enmi-conf.org / comparison

summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help

wp/wp-includes/js/autosave.js

changeset 9	177826044cd9
parent 7	cf61fcea0001
child 16	a86126ab1dd4

equal deleted inserted replaced

-:c7c34916027a
+:177826044cd9
+/**
+* @output wp-includes/js/autosave.js
+*/
 /* global tinymce, wpCookies, autosaveL10n, switchEditors */
 // Back-compat
 window.autosave = function() {
 	return true;
 };
 /**
-* @summary Adds autosave to the window object on dom ready.
+* Adds autosave to the window object on dom ready.
 *
 * @since 3.9.0
 *
 * @param {jQuery} $ jQuery object.
 * @param {window} The window object.
 *
 */
 ( function( $, window ) {
 	/**
-	 * @summary Auto saves the post.
+	 * Auto saves the post.
 	 *
 	 * @since 3.9.0
 	 *
 	 * @returns {Object}
 	 * 	{{
 		var initialCompareString,
 			lastTriggerSave = 0,
 			$document = $(document);
 		/**
-		 * @summary Returns the data saved in both local and remote autosave.
+		 * Returns the data saved in both local and remote autosave.
 		 *
 		 * @since 3.9.0
 		 *
 		 * @param {string} type The type of autosave either local or remote.
 		 *
 			return data;
 		}
 		/**
-		 * @summary Concatenates the title, content and excerpt.
+		 * Concatenates the title, content and excerpt. This is used to track changes
-		 *
+		 * when auto-saving.
-		 * This is used to track changes when auto-saving.
 		 *
 		 * @since 3.9.0
 		 *
 		 * @param {Object} postData The object containing the post data.
 		 *
 			return ( $('#title').val() || '' ) + '::' + ( $('#content').val() || '' ) + '::' + ( $('#excerpt').val() || '' );
 		}
 		/**
-		 * @summary Disables save buttons.
+		 * Disables save buttons.
 		 *
 		 * @since 3.9.0
 		 *
 		 * @returns {void}
 		 */
 			// Re-enable 5 sec later. Just gives autosave a head start to avoid collisions.
 			setTimeout( enableButtons, 5000 );
 		}
 		/**
-		 * @summary Enables save buttons.
+		 * Enables save buttons.
 		 *
 		 * @since 3.9.0
 		 *
 		 * @returns {void}
 		 */
 		function enableButtons() {
 			$document.trigger( 'autosave-enable-buttons' );
 		}
 		/**
-		 * @summary Gets the content editor.
+		 * Gets the content editor.
 		 *
 		 * @since 4.6.0
 		 *
 		 * @returns {boolean|*} Returns either false if the editor is undefined,
 		 * 						or the instance of the content editor.
 		function getEditor() {
 			return typeof tinymce !== 'undefined' && tinymce.get('content');
 		}
 		/**
-		 * @summary Autosave in localStorage.
+		 * Autosave in localStorage.
 		 *
 		 * @since 3.9.0
 		 *
 		 * @returns {
 		 * {
 			var blog_id, post_id, hasStorage, intervalTimer,
 				lastCompareString,
 				isSuspended = false;
 			/**
-			 * @summary Checks if the browser supports sessionStorage and it's not disabled.
+			 * Checks if the browser supports sessionStorage and it's not disabled.
 			 *
 			 * @since 3.9.0
 			 *
 			 * @returns {boolean} True if the sessionStorage is supported and enabled.
 			 */
 				hasStorage = result;
 				return result;
 			}
 			/**
-			 * @summary Initializes the local storage.
+			 * Initializes the local storage.
 			 *
 			 * @since 3.9.0
 			 *
 			 * @returns {boolean|Object} False if no sessionStorage in the browser or an Object
 			 *                           containing all postData for this blog.
 				return stored_obj;
 			}
 			/**
-			 * @summary Sets the storage for this blog.
+			 * Sets the storage for this blog. Confirms that the data was saved
-			 *
+			 * successfully.
-			 * Confirms that the data was saved successfully.
 			 *
 			 * @since 3.9.0
 			 *
 			 * @returns {boolean} True if the data was saved successfully, false if it wasn't saved.
 			 */
 				return false;
 			}
 			/**
-			 * @summary Gets the saved post data for the current post.
+			 * Gets the saved post data for the current post.
 			 *
 			 * @since 3.9.0
 			 *
 			 * @returns {boolean|Object} False if no storage or no data or the postData as an Object.
 			 */
 				return stored[ 'post_' + post_id ] || false;
 			}
 			/**
-			 * @summary Sets (save or delete) post data in the storage.
+			 * Sets (save or delete) post data in the storage.
 			 *
 			 * If stored_data evaluates to 'false' the storage key for the current post will be removed.
 			 *
 			 * @since 3.9.0
 			 *
 				return setStorage( stored );
 			}
 			/**
-			 * @summary Sets isSuspended to true.
+			 * Sets isSuspended to true.
 			 *
 			 * @since 3.9.0
 			 *
 			 * @returns {void}
 			 */
 			function suspend() {
 				isSuspended = true;
 			}
 			/**
-			 * @summary Sets isSuspended to false.
+			 * Sets isSuspended to false.
 			 *
 			 * @since 3.9.0
 			 *
 			 * @returns {void}
 			 */
 			function resume() {
 				isSuspended = false;
 			}
 			/**
-			 * @summary Saves post data for the current post.
+			 * Saves post data for the current post.
 			 *
 			 * Runs on a 15 sec. interval, saves when there are differences in the post title or content.
 			 * When the optional data is provided, updates the last saved post data.
 			 *
 			 * @since 3.9.0
 				return result;
 			}
 			/**
-			 * @summary Initializes the auto save function.
+			 * Initializes the auto save function.
 			 *
 			 * Checks whether the editor is active or not to use the editor events
 			 * to autosave, or uses the values from the elements to autosave.
 			 *
 			 * Runs on DOM ready.
 					wpCookies.set( 'wp-saving-post', post_id + '-check', 24 * 60 * 60, false, false, secure );
 				});
 			}
 			/**
-			 * @summary Compares 2 strings.
+			 * Compares 2 strings. Removes whitespaces in the strings before comparing them.
-			 *
-			 * Removes whitespaces in the strings before comparing them.
 			 *
 			 * @since 3.9.0
 			 *
 			 * @param {string} str1 The first string.
 			 * @param {string} str2 The second string.
 				return ( removeSpaces( str1 || '' ) === removeSpaces( str2 || '' ) );
 			}
 			/**
-			 * @summary Checks if the saved data for the current post (if any) is different
+			 * Checks if the saved data for the current post (if any) is different than the
-			 * than the loaded post data on the screen.
+			 * loaded post data on the screen.
 			 *
 			 * Shows a standard message letting the user restore the post data if different.
 			 *
 			 * @since 3.9.0
 			 *
 					});
 				});
 			}
 			/**
-			 * @summary Restores the current title, content and excerpt from postData.
+			 * Restores the current title, content and excerpt from postData.
 			 *
 			 * @since 3.9.0
 			 *
 			 * @param {Object} postData The object containing all post data.
 			 *
 				resume: resume
 			};
 		}
 		/**
-		 * @summary Auto saves the post on the server.
+		 * Auto saves the post on the server.
 		 *
 		 * @since 3.9.0
 		 *
 		 * @returns {Object} {
 		 * 	{
 				nextRun = 0,
 				isSuspended = false;
 			/**
-			 * @summary  Blocks saving for the next 10 seconds.
+			 * Blocks saving for the next 10 seconds.
 			 *
 			 * @since 3.9.0
 			 *
 			 * @returns {void}
 			 */
 					_blockSave = false;
 				}, 10000 );
 			}
 			/**
-			 * @summary Sets isSuspended to true.
+			 * Sets isSuspended to true.
 			 *
 			 * @since 3.9.0
 			 *
 			 * @returns {void}
 			 */
 			function suspend() {
 				isSuspended = true;
 			}
 			/**
-			 * @summary Sets isSuspended to false.
+			 * Sets isSuspended to false.
 			 *
 			 * @since 3.9.0
 			 *
 			 * @returns {void}
 			 */
 			function resume() {
 				isSuspended = false;
 			}
 			/**
-			 * @summary Triggers the autosave with the post data.
+			 * Triggers the autosave with the post data.
 			 *
 			 * @since 3.9.0
 			 *
 			 * @param {Object} data The post data.
 			 *
 					$( '#auto_draft' ).val('');
 				}
 			}
 			/**
-			 * @summary Saves immediately.
+			 * Saves immediately.
 			 *
 			 * Resets the timing and tells heartbeat to connect now.
 			 *
 			 * @since 3.9.0
 			 *
 				nextRun = 0;
 				wp.heartbeat.connectNow();
 			}
 			/**
-			 * @summary Checks if the post content in the textarea has changed since page load.
+			 * Checks if the post content in the textarea has changed since page load.
 			 *
 			 * This also happens when TinyMCE is active and editor.save() is triggered by
 			 * wp.autosave.getPostData().
 			 *
 			 * @since 3.9.0
 			function postChanged() {
 				return getCompareString() !== initialCompareString;
 			}
 			/**
-			 * @summary Checks if the post can be saved or not.
+			 * Checks if the post can be saved or not.
 			 *
 			 * If the post hasn't changed or it cannot be updated,
 			 * because the autosave is blocked or suspended, the function returns false.
 			 *
 			 * @since 3.9.0
 				return postData;
 			}
 			/**
-			 * @summary Sets the next run, based on the autosave interval.
+			 * Sets the next run, based on the autosave interval.
 			 *
 			 * @private
 			 *
 			 * @since 3.9.0
 			 *
 			function _schedule() {
 				nextRun = ( new Date() ).getTime() + ( autosaveL10n.autosaveInterval * 1000 ) || 60000;
 			}
 			/**
-			 * @summary Sets the autosaveData on the autosave heartbeat.
+			 * Sets the autosaveData on the autosave heartbeat.
 			 *
 			 * @since 3.9.0
 			 *
 			 * @returns {void}
 			 */
 				if ( autosaveData ) {
 					data.wp_autosave = autosaveData;
 				}
 				/**
-				 * @summary Triggers the autosave of the post with the autosave data
+				 * Triggers the autosave of the post with the autosave data on the autosave
-				 * on the autosave heartbeat.
+				 * heartbeat.
 				 *
 				 * @since 3.9.0
 				 *
 				 * @returns {void}
 				 */
 			}).on( 'heartbeat-tick.autosave', function( event, data ) {
 				if ( data.wp_autosave ) {
 					response( data.wp_autosave );
 				}
 				/**
-				 * @summary Disables buttons and throws a notice when the connection is lost.
+				 * Disables buttons and throws a notice when the connection is lost.
 				 *
 				 * @since 3.9.0
 				 *
 				 * @returns {void}
 				 */
 					$notice.show();
 					disableButtons();
 				}
 				/**
-				 * @summary Enables buttons when the connection is restored.
+				 * Enables buttons when the connection is restored.
 				 *
 				 * @since 3.9.0
 				 *
 				 * @returns {void}
 				 */
 				resume: resume
 			};
 		}
 		/**
-		 * @summary Sets the autosave time out.
+		 * Sets the autosave time out.
 		 *
 		 * Wait for TinyMCE to initialize plus 1 second. for any external css to finish loading,
 		 * then save to the textarea before setting initialCompareString.
 		 * This avoids any insignificant differences between the initial textarea content and the content
 		 * extracted from the editor.

enmi-conf.org