Improve rotate docs (#371)

Author: patrick-tolosa

src/actions/rotate.ts

@@ -2,6 +2,28 @@
  * Rotates or flips an image or video by the specified number of degrees, or automatically (images only) according to its orientation or available metadata.
  * @memberOf Actions
  * @namespace Rotate
+ *
+ * @example
+ * <caption>Rotate by mode</caption>
+ * import {Cloudinary} from "@cloudinary/base";
+ * import {mode} from "@cloudinary/base/actions/rotate";
+ * import {autoLeft} from "@cloudinary/base/qualifiers/rotationMode";
+ *
+ * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
+ * const image = yourCldInstance.image('woman');
+ * image.rotate(mode(autoLeft());
+ * image.toURL();
+ *
+ * @example
+ * <caption>Rotate by angle</caption>
+ * import {Cloudinary} from "@cloudinary/base";
+ * import {byAngle} from "@cloudinary/base/actions/rotate";
+ *
+ * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
+ * const image = yourCldInstance.image('woman');
+ *
+ * image.rotate(byAngle(90));
+ * image.toURL();
  */
 
 

src/actions/rotate/RotateAction.ts

@@ -10,7 +10,9 @@ const QUALIFIER_KEY = 'a';
  *
  * <b>Learn more:</b> {@link https://cloudinary.com/documentation/image_transformations#rotating_image | Rotating images}
  * {@link https://cloudinary.com/documentation/video_manipulation_and_delivery#rotating_videos | Rotating videos}
- * @augments {Action}
+ * @extends SDK.Action
+ * @memberOf Actions.Rotate
+ * @see Visit {@link Actions.Rotate|Rotate} for an example
  */
 class RotateAction extends Action {
   constructor(angle?: number) {

src/actions/rotate/byAngle.ts

@@ -2,10 +2,10 @@ import RotateAction from "./RotateAction";
 
 /**
  * @summary action
- * @memberOf Actions.Rotate
  * @description Rotate an image by the given degrees.
  * @param {number} angle Given degrees. (Range: 0 to 360, Default: 0).
- * @return {RotateAction}
+ * @return {Actions.Rotate.RotateAction}
+ * @memberOf Actions.Rotate
  */
 function byAngle(angle: number) :RotateAction {
   return new RotateAction(angle);

src/actions/rotate/mode.ts

@@ -3,20 +3,12 @@ import {RotationModeQualifierValue} from "../../qualifiers/rotate/RotationModeQu
 
 /**
  * @summary action
- * @memberOf Actions.Rotate
  * @description Rotate an image by using a rotationMode
  * @param {string} rotationMode
  * For a list of supported rotation modes see {@link Qualifiers.rotationModeValues| types of rotation modes} for
  * possible values
- * @example
- * import {mode} from "@cloudinary/base/actions/rotate";
- * import {RotationMode} from "@cloudinary/base/qualifiers/rotationMode";
- *
- * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
- * const image = yourCldInstance.image('woman');
- *
- * image.rotate(mode(RotationMode.autoLeft());
- * @return {RotateAction}
+ * @memberOf Actions.Rotate
+ * @return {Actions.Rotate.RotateAction}
  */
 function mode(rotationMode: RotationModeQualifierValue | string) :RotateAction {
   return new RotateAction().mode(rotationMode);