Improve video edit docs and align various names in the docs (#376)

* Improve video edit docs and align various names in the docs

Author: patrick-tolosa

jsdoc.config.json

@@ -4,7 +4,7 @@
     "dictionaries": ["jsdoc","closure"]
   },
   "source": {
-    "include": ["src", "__TESTS__"],
+    "include": ["src"],
     "includePattern": ".+\\.ts(doc|x)?$"
   },
   "plugins": [

src/actions/adjust/By3dLutAction.ts

@@ -3,7 +3,7 @@ import {Action} from "../../internal/Action";
 /**
  * @description Creates the 3D_lut layer transformation
  * @memberOf Actions.Adjust
- * @augments {SDK.Action}
+ * @extends SDK.Action
  */
 class By3dLutAction extends Action {
   readonly publicId: string;

src/actions/adjust/FillLightAction.ts

@@ -5,7 +5,7 @@ import {Qualifier} from "../../internal/qualifier/Qualifier";
 /**
  * @description Adjusts the fill light and blends the result with the original image.
  * @memberOf Actions.Adjust
- * @augments {SDK.Action}
+ * @extends SDK.Action
  */
 class FillLightAction extends Action {
   private lvl:number;

src/actions/adjust/OpacityAdjustAction.ts

@@ -4,7 +4,7 @@ import {Qualifier} from "../../internal/qualifier/Qualifier";
 /**
  * @description OpacityAction class, used to define the opacity of an asset
  * @memberOf Actions.Adjust
- * @augments {SDK.Action}
+ * @extends SDK.Action
  */
 class OpacityAdjustAction extends Action {
   constructor(level: number) {

src/actions/adjust/RecolorAction.ts

@@ -3,7 +3,7 @@ import {QualifierValue} from "../../internal/qualifier/QualifierValue";
 import {Qualifier} from "../../internal/qualifier/Qualifier";
 
 /**
- * @extend {SDK.Action}
+ * @extends SDK.Action
  * @description Converts the colors of every pixel in an image based on the supplied color matrix, in which the value of each color channel is calculated based on the values from all other channels (e.g. a 3x3 matrix for RGB, a 4x4 matrix for RGBA or CMYK, etc).<br/>
  * For every pixel in the image, take each color channel and adjust its value by the specified values of the matrix to get a new value.
  * @memberOf Actions.Adjust

src/actions/background/actions/BackgroundColor.ts

@@ -4,7 +4,7 @@ import {Qualifier} from "../../../internal/qualifier/Qualifier";
 import {SystemColors} from "../../../qualifiers/color";
 
 /**
- * @extend {SDK.Action}
+ * @extends SDK.Action
  * @description A class for background transformations.
  */
 class BackgroundColor extends Action {

src/actions/border.ts

@@ -14,7 +14,7 @@ import RoundCornersAction from "./roundCorners/RoundCornersAction";
  * @memberOf Actions
  * @namespace Border
  * @example
- * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary";
+ * import {Cloudinary} from "@cloudinary/base";
  * import {solid} from "@cloudinary/base/actions/border";
  *
  * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
@@ -34,7 +34,7 @@ import RoundCornersAction from "./roundCorners/RoundCornersAction";
  * @see Actions.Border
  * @example
  * // Used through a builder function Border.solid(), and not by creating a new instance
- * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary";
+ * import {Cloudinary} from "@cloudinary/base";
  *
  * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
  * const image = yourCldInstance.image('woman');

src/actions/conditional.ts

@@ -7,7 +7,7 @@ import {Transformation} from "../transformation/Transformation";
  * @memberOf Actions
  * @namespace Conditional
  * @example
- * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary";
+ * import {Cloudinary} from "@cloudinary/base";
  *
  * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
  * const image = yourCldInstance.image('woman');
@@ -24,7 +24,7 @@ import {Transformation} from "../transformation/Transformation";
  * @see Actions.Conditional
  * @example
  * // To be used through a builder and not to be created as an instance!
- * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary";
+ * import {Cloudinary} from "@cloudinary/base";
  *
  * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
  * const image = yourCldInstance.image('woman');

src/actions/customFunction.ts

@@ -4,7 +4,7 @@
  * @memberOf Actions
  * @namespace CustomFunction
  * @example
- * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary";
+ * import {Cloudinary} from "@cloudinary/base";
  * import {remote, wasm} from "@cloudinary/base/actions/customFunction";
  *
  * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});

src/actions/delivery.ts

@@ -29,7 +29,7 @@ export type IDeliveryAction = DeliveryAction | DeliveryColorSpaceFromICC;
  * possible values
  * @return {Actions.Delivery.DeliveryFormat}
  * @example
- * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary";
+ * import {Cloudinary} from "@cloudinary/base";
  * import {format} from "@cloudinary/base/actions/delivery";
  *
  * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
@@ -52,7 +52,7 @@ function format(format:FormatQualifier | string) :DeliveryFormat {
  * @param {string} dpr The DPR (Device Pixel Ratio). Any positive float value.
  * @return {Actions.Delivery.DeliveryAction}
  * @example
- * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary";
+ * import {Cloudinary} from "@cloudinary/base";
  * import {dpr} from "@cloudinary/base/actions/delivery";
  *
  * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
@@ -78,7 +78,7 @@ function dpr(dpr: string|number):DeliveryAction {
  * possible values.
  * @return {Actions.Delivery.DeliveryQualityAction}
  * @example
- * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary";
+ * import {Cloudinary} from "@cloudinary/base";
  * import {quality} from "@cloudinary/base/actions/delivery";
  * import {quality} from "@cloudinary/base/qualifiers/quantity";
  *
@@ -100,7 +100,7 @@ function quality(qualityType:string | number) :DeliveryQualityAction {
  * @param {number | string} value The density in dpi.
  * @return {Actions.Delivery.DeliveryAction}
  * @example
- * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary";
+ * import {Cloudinary} from "@cloudinary/base";
  * import {density} from "@cloudinary/base/actions/delivery";
  *
  * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
@@ -122,7 +122,7 @@ function density(value:number) :DeliveryAction {
  * @param {string} publicIdWithExtension Default image public ID
  * @return {Actions.Delivery.DeliveryAction}
  * @example
- * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary";
+ * import {Cloudinary} from "@cloudinary/base";
  * import {defaultImage} from "@cloudinary/base/actions/delivery";
  *
  * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
@@ -143,7 +143,7 @@ function defaultImage(publicIdWithExtension:string) :DeliveryAction {
  * @param {string | Qualifiers.ColorSpace} mode The color space.
  * @return {Actions.Delivery.DeliveryAction}
  * @example
- * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary";
+ * import {Cloudinary} from "@cloudinary/base";
  * import {colorSpace} from "@cloudinary/base/actions/delivery";
  * import {trueColor} from "@cloudinary/base/qualifiers/colorSpace";
  *
@@ -167,7 +167,7 @@ function colorSpace(mode:string): DeliveryAction {
  * color space.
  * @return {Actions.Delivery.DeliveryColorSpaceFromICC}
  * @example
- * import {Cloudinary} from "@cloudinary/base/instance/Cloudinary";
+ * import {Cloudinary} from "@cloudinary/base";
  * import {colorSpaceFromICC} from "@cloudinary/base/actions/delivery";
  * import {trueColor} from "@cloudinary/base/qualifiers/colorSpace";
  *