Improve docs for round corners and rotate (#373)

* Improve docs for round corners and rotate

Author: patrick-tolosa

src/actions/rotate.ts

@@ -6,23 +6,18 @@
  * @example
  * <caption>Rotate by mode</caption>
  * import {Cloudinary} from "@cloudinary/base";
- * import {mode} from "@cloudinary/base/actions/rotate";
+ * import {mode, byAngle} 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');
+ * // Rotate by mode
+ * image.rotate(mode(autoLeft());
  *
+ * // Rotate by angle
  * image.rotate(byAngle(90));
+ *
  * image.toURL();
  */
 

src/actions/roundCorners.ts

@@ -6,6 +6,18 @@
  * {@link https://cloudinary.com/documentation/video_manipulation_and_delivery#rounding_corners_and_creating_circular_videos | Rounded videos}
  * @memberOf Actions
  * @namespace RoundCorners
+ * @example
+ * <caption>Round corners by a radius</caption>
+ * import {Cloudinary} from "@cloudinary/base";
+ * import {byRadius, max} from "@cloudinary/base/actions/roundCorners";
+ *
+ * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
+ * const image = yourCldInstance.image('woman');
+ * // By a radius
+ * image.roundCorners(byRadius(10));
+ * // Or just the maximum possible
+ * image.roundCorners(max());
+ * image.toURL();
  */
 
 import byRadius from './roundCorners/byRadius';

src/actions/roundCorners/RoundCornersAction.ts

@@ -5,6 +5,8 @@ import {QualifierValue} from "../../internal/qualifier/QualifierValue";
 /**
  * @description A class to round one or more corners of an image or video.
  * @extends SDK.Action
+ * @memberOf Actions.RoundCorners
+ * @see Visit {@link Actions.RoundCorners|RoundCorners} for an example
  */
 class RoundCornersAction extends Action {
   constructor() {

src/actions/roundCorners/byRadius.ts

@@ -1,6 +1,7 @@
 import RoundCornersAction from "./RoundCornersAction";
 
 /**
+ * @summary action
  * @description Rounds the specified corners of an image or a video by specifying 1-4 pixel values as follows:
  *
  * * 1 value: All four corners are rounded equally according to the specified value.
@@ -13,7 +14,7 @@ import RoundCornersAction from "./RoundCornersAction";
  * @param {number} c
  * @param {number} d
  * @memberOf Actions.RoundCorners
- * @return {RoundCornersAction}
+ * @return {Actions.RoundCorners.RoundCornersAction}
  */
 function byRadius(a:number, b?:number, c?:number, d?:number):RoundCornersAction {
   return new RoundCornersAction().radius(a, b, c, d);

src/actions/roundCorners/max.ts

@@ -2,9 +2,10 @@ import RoundCornersAction from "./RoundCornersAction";
 
 
 /**
+ * @summary action
  * @description Generates an asset with a circular crop using the 'max' radius value.
  * @memberOf Actions.RoundCorners
- * @return {RoundCornersAction}
+ * @return {Actions.RoundCorners.RoundCornersAction}
  */
 function max():RoundCornersAction {
   return new RoundCornersAction().max();