Changeset 32703

Timestamp:

06/07/2015 07:59:11 PM (8 years ago)

Author:

iseulde

Message:

TinyMCE: wptextpattern: add docs

Props DrewAPicture and iseulde.
See #31441.

File:

• trunk/src/wp-includes/js/tinymce/plugins/wptextpattern/plugin.js (modified) (2 diffs)

trunk/src/wp-includes/js/tinymce/plugins/wptextpattern/plugin.js

@@ +1 @@
+/**
+ * Text pattern plugin for TinyMCE
+ *
+ * @since 4.3.0
+ *
+ * This plugin can automatically format text patterns as you type. It includes two patterns:
+ *  - Unordered list (`* ` and `- `).
+ *  - Ordered list (`1. ` and `1) `).
+ *
+ * If the transformation in unwanted, the user can undo the change by pressing backspace,
+ * using the undo shortcut, or the undo button in the toolbar.
+ */
 ( function( tinymce, setTimeout ) {
     tinymce.PluginManager.add( 'wptextpattern', function( editor ) {
@@ -5 +17 @@
             canUndo = false;
 
+        /**
+         * Add a pattern to format with a callback.
+         *
+         * @since 4.3.0
+         *
+         * @param {RegExp}   regExp
+         * @param {Function} callback
+         */
         function add( regExp, callback ) {
             patterns.push( {