浏览代码

Update code comments,

as suggested at https://github.com/ckeditor/ckeditor5/pull/7346#pullrequestreview-423414484.
Tomek Wytrębowicz 5 年之前
父节点
当前提交
72c9030065

+ 4 - 2
packages/ckeditor5-autoformat/src/blockautoformatediting.js

@@ -11,14 +11,16 @@ import LiveRange from '@ckeditor/ckeditor5-engine/src/model/liverange';
  * The autoformatting operation is integrated with the undo manager,
  * so the autoformatting step can be undone if the user's intention was not to format the text.
  *
- * See the functions documentation to learn how to create custom inline autoformatters. You can also use
+ * See the {@link module:autoformat/blockautoformatediting~blockAutoformatEditing `blockAutoformatEditing`} documentation
+ * to learn how to create custom block autoformatters. You can also use
  * the {@link module:autoformat/autoformat~Autoformat} feature which enables a set of default autoformatters
  * (lists, headings, bold and italic).
+ *
  * @module autoformat/blockautoformatediting
  */
 
 /**
- * Creates a listener triggered on `change` event in the document.
+ * Creates a listener triggered on {@link module:engine/model/document~Document#event:change:data `change:data`} event in the document.
  * Calls the callback when inserted text matches the regular expression or the command name
  * if provided instead of the callback.
  *

+ 5 - 2
packages/ckeditor5-autoformat/src/inlineautoformatediting.js

@@ -10,9 +10,11 @@
  * The autoformatting operation is integrated with the undo manager,
  * so the autoformatting step can be undone if the user's intention was not to format the text.
  *
- * See the functions documentation to learn how to create custom inline autoformatters. You can also use
+ * See the {@link module:autoformat/inlineautoformatediting~inlineAutoformatEditing `inlineAutoformatEditing`} documentation
+ * to learn how to create custom inline autoformatters. You can also use
  * the {@link module:autoformat/autoformat~Autoformat} feature which enables a set of default autoformatters
  * (lists, headings, bold and italic).
+ *
  * @module autoformat/inlineautoformatediting
  */
 
@@ -20,7 +22,8 @@
  * Enables autoformatting mechanism for a given {@link module:core/editor/editor~Editor}.
  *
  * It formats the matched text by applying the given model attribute or by running the provided formatting callback.
- * On every change applied to the model the autoformatting engine checks the text on the left of the selection
+ * On every {@link module:engine/model/document~Document#event:change:data data change} in the model document
+ * the autoformatting engine checks the text on the left of the selection
  * and executes the provided action if the text matches given criteria (regular expression or callback).
  *
  * @param {module:core/editor/editor~Editor} editor The editor instance.