瀏覽代碼

Docs: Use @returns. [skip ci]

Piotrek Koszuliński 7 年之前
父節點
當前提交
5df85cd21a

+ 1 - 1
packages/ckeditor5-image/src/image/converters.js

@@ -68,7 +68,7 @@ export function viewFigureToModel() {
 /**
  * Converter used to convert the `srcset` model image attribute to the `srcset`, `sizes` and `width` attributes in the view.
  *
- * @return {Function}
+ * @returns {Function}
  */
 export function srcsetAttributeConverter() {
 	return dispatcher => {

+ 1 - 1
packages/ckeditor5-image/src/image/imageediting.js

@@ -111,7 +111,7 @@ export default class ImageEditing extends Plugin {
 //
 // @private
 // @param {module:engine/view/writer~Writer} writer
-// @return {module:engine/view/containerelement~ContainerElement}
+// @returns {module:engine/view/containerelement~ContainerElement}
 export function createImageViewElement( writer ) {
 	const emptyElement = writer.createEmptyElement( 'img' );
 	const figure = writer.createContainerElement( 'figure', { class: 'image' } );

+ 1 - 1
packages/ckeditor5-image/src/imagecaption/imagecaptionediting.js

@@ -203,7 +203,7 @@ export default class ImageCaptionEditing extends Plugin {
 // @private
 // @param {Function} elementCreator
 // @param {Boolean} [hide=true] When set to `false` view element will not be inserted when it's empty.
-// @return {Function}
+// @returns {Function}
 function captionModelToView( elementCreator, hide = true ) {
 	return ( evt, data, conversionApi ) => {
 		const captionElement = data.item;

+ 3 - 3
packages/ckeditor5-image/src/imagecaption/utils.js

@@ -18,7 +18,7 @@ const captionSymbol = Symbol( 'imageCaption' );
  *
  * @param {module:engine/view/view~View} view
  * @param {String} placeholderText The text to be displayed when the caption is empty.
- * @return {Function}
+ * @returns {Function}
  */
 export function captionElementCreator( view, placeholderText ) {
 	return writer => {
@@ -34,7 +34,7 @@ export function captionElementCreator( view, placeholderText ) {
  * Returns `true` if a given view element is the image caption editable.
  *
  * @param {module:engine/view/element~Element} viewElement
- * @return {Boolean}
+ * @returns {Boolean}
  */
 export function isCaption( viewElement ) {
 	return !!viewElement.getCustomProperty( captionSymbol );
@@ -44,7 +44,7 @@ export function isCaption( viewElement ) {
  * Returns the caption model element from a given image element. Returns `null` if no caption is found.
  *
  * @param {module:engine/model/element~Element} imageModelElement
- * @return {module:engine/model/element~Element|null}
+ * @returns {module:engine/model/element~Element|null}
  */
 export function getCaptionFromImage( imageModelElement ) {
 	for ( const node of imageModelElement.getChildren() ) {

+ 1 - 1
packages/ckeditor5-image/src/imagestyle/converters.js

@@ -77,7 +77,7 @@ export function viewToModelStyleAttribute( styles ) {
 //
 // @param {String} name
 // @param {Array.<module:image/imagestyle/imagestyleediting~ImageStyleFormat> } styles
-// @return {module:image/imagestyle/imagestyleediting~ImageStyleFormat|undefined}
+// @returns {module:image/imagestyle/imagestyleediting~ImageStyleFormat|undefined}
 function getStyleByName( name, styles ) {
 	for ( const style of styles ) {
 		if ( style.name === name ) {

+ 1 - 1
packages/ckeditor5-image/src/imagetextalternative/ui/textalternativeformview.js

@@ -181,7 +181,7 @@ export default class TextAlternativeFormView extends View {
 	 * Creates an input with a label.
 	 *
 	 * @private
-	 * @return {module:ui/labeledinput/labeledinputview~LabeledInputView}
+	 * @returns {module:ui/labeledinput/labeledinputview~LabeledInputView}
 	 */
 	_createLabeledInputView() {
 		const t = this.locale.t;