ソースを参照

Docs: Improved docs in media embed utils.

Aleksander Nowodzinski 7 年 前
コミット
b7e60fdca9
1 ファイル変更6 行追加4 行削除
  1. 6 4
      packages/ckeditor5-media-embed/src/utils.js

+ 6 - 4
packages/ckeditor5-media-embed/src/utils.js

@@ -89,14 +89,16 @@ export function getSelectedMediaElement( selection ) {
 }
 
 /**
- * Creates media element and inserts it into the model.
+ * Creates a media element and inserts it into the model.
  *
- * **Note**: This method will use `{@link module:engine/model/model~Model#insertContent model.insertContent()}` logic of inserting content
+ * **Note**: This method will use {@link module:engine/model/model~Model#insertContent `model.insertContent()`} logic of inserting content
  * if no `insertPosition` is passed.
  *
- * @param {module:engine/model/model~Model} model.
+ * @param {module:engine/model/model~Model} model
  * @param {String} url An URL of an embeddable media.
- * @param {module:engine/model/position~Position} [insertPosition] Position to insert media.
+ * @param {module:engine/model/position~Position} [insertPosition] Position to insert media. If not specified,
+ * the default behavior of {@link module:engine/model/model~Model#insertContent `model.insertContent()`} will
+ * be applied.
  */
 export function insertMedia( model, url, insertPosition ) {
 	model.change( writer => {