Skip to content

Fix broken links. #489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 29, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/actions/adjust.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export type IAdjustAction = FillLightAction
* @memberOf Actions.Adjust
* @description Blends an image with one or more tint colors at a specified intensity. </br>
* You can optionally equalize colors before tinting and specify gradient blend positioning per color.</br>
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/image_transformations#tint_effects | Deliver selected layers of a PSD image}
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/image_transformations#tint_effects|Deliver selected layers of a PSD image}
* @param {string} value The full tint effect value, provided as a string.
* @return {Actions.Effect.SimpleEffectAction}
*/
Expand All @@ -63,7 +63,7 @@ function brightness(level?:number): EffectActionWithLevel {
* @memberOf Actions.Adjust
* @description
* Enhances an image to its best visual quality with the Viesus Automatic Image Enhancement add-on.</br>
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/viesus_automatic_image_enhancement_addon | Viesus Automatic Image Enhancement.}
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/viesus_automatic_image_enhancement_addon|Viesus Automatic Image Enhancement.}
* @return {Actions.Adjust.ViesusCorrectAdjustAction}
*/
function viesusCorrect(): ViesusCorrectAdjustAction {
Expand Down Expand Up @@ -286,7 +286,7 @@ function improve(): ImproveAction {
* @description
* Maps an input color and those similar to the input color to corresponding shades of a specified output color, taking luminosity and chroma into account, in order to recolor an object in a natural way.</br>
* More highly saturated input colors usually give the best results. It is recommended to avoid input colors approaching white, black, or gray.
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/image_transformations#replace_color_effect | Replace colors example}
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/image_transformations#replace_color_effect|Replace colors example}
* @param {string} toColor
* @return {Actions.Adjust.ReplaceColorAction}
*/
Expand Down
2 changes: 1 addition & 1 deletion src/actions/adjust/ImproveAction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {IActionModel} from "../../internal/models/IActionModel.js";

/**
* @description Defines how to improve an image by automatically adjusting image colors, contrast and brightness.</br>
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/image_transformations#image_improvement_effects | Image improvement effects}
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/image_transformations#image_improvement_effects|Image improvement effects}
* @memberOf Actions.Adjust
*/
class ImproveAction extends Action {
Expand Down
2 changes: 1 addition & 1 deletion src/actions/adjust/ReplaceColorAction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {Qualifier} from "../../internal/qualifier/Qualifier.js";
* Maps an input color and those similar to the input color to corresponding shades of a specified output color, taking luminosity and chroma into account, in order to recolor objects in your image in a natural way.</br>
* More highly saturated input colors usually give the best results. It is recommended to avoid input colors approaching white, black, or gray.</br>
*
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/image_transformations#replace_color_effect | Replace colors example}
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/image_transformations#replace_color_effect|Replace colors example}
* @memberOf Actions.Adjust
*/
class ReplaceColorAction extends Action {
Expand Down
2 changes: 1 addition & 1 deletion src/actions/adjust/simple/ViesusCorrectAdjustAction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import {Qualifier} from "../../../internal/qualifier/Qualifier.js";

/**
* Enhances an image to its best visual quality with the Viesus Automatic Image Enhancement add-on.</br>
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/viesus_automatic_image_enhancement_addon | Viesus Automatic Image Enhancement.}
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/viesus_automatic_image_enhancement_addon|Viesus Automatic Image Enhancement.}
* @memberOf Actions.Adjust
*/
class ViesusCorrectAdjustAction extends Action {
Expand Down
2 changes: 1 addition & 1 deletion src/actions/border.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import RoundCornersAction from "./roundCorners/RoundCornersAction.js";
* @description Adds a solid border around an image or video.
*
* <b>Learn more:</b>
* {@link https://cloudinary.com/documentation/image_transformations#adding_image_borders | Adding image borders}
* {@link https://cloudinary.com/documentation/image_transformations#adding_image_borders|Adding image borders}
* @memberOf Actions
* @namespace Border
* @example
Expand Down
2 changes: 1 addition & 1 deletion src/actions/conditional.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ class ConditionalAction extends Action{
* @summary action
* @memberOf Actions.Conditional
* @description Sets up a conditional transformation with expression.
* Learn more: {@link https://cloudinary.com/documentation/conditional_transformations | Conditional transformations}
* Learn more: {@link https://cloudinary.com/documentation/conditional_transformations|Conditional transformations}
*
* @param {string} expression The condition to meet in order to apply the transformation.
* @param {SDK.Transformation} tx The transformation to conditionally apply
Expand Down
6 changes: 3 additions & 3 deletions src/actions/customFunction.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Calls a custom function. </br>
* Learn more: {@link https://cloudinary.com/documentation/custom_functions | Custom functions}
* Learn more: {@link https://cloudinary.com/documentation/custom_functions|Custom functions}
* @memberOf Actions
* @namespace CustomFunction
* @example
Expand All @@ -25,7 +25,7 @@ import RemoteAction from "./customFunction/RemoteAction.js";
/**
* @summary action
* @description - Calls a custom function. </br>
* For more information about remote custom functions see {@link https://cloudinary.com/documentation/custom_functions#remote_functions | the documentation}
* For more information about remote custom functions see {@link https://cloudinary.com/documentation/custom_functions#remote_functions|the documentation}
* @param {string} path - Specifies the URL of the remote custom function.
* @memberOf Actions.CustomFunction
* @return {Actions.CustomFunctionAction}
Expand All @@ -38,7 +38,7 @@ function remote(path:string): RemoteAction {
/**
* @summary action
* @description - Calls a custom function. </br>
* For more information about wasm custom functions see {@link https://cloudinary.com/documentation/custom_functions#webassembly_functions | the documentation}
* For more information about wasm custom functions see {@link https://cloudinary.com/documentation/custom_functions#webassembly_functions|the documentation}
* @param {string} publicID - Specifies the publicID of the custom function stored in Cloudinary
* @memberOf Actions.CustomFunction
* @return {Actions.CustomFunctionAction}
Expand Down
8 changes: 4 additions & 4 deletions src/actions/delivery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ export type IDeliveryAction = DeliveryAction | DeliveryColorSpaceAction | Delive
* @description Defines the format of the delivered asset.
*
* <b>Learn more:</b>
* {@link https://cloudinary.com/documentation/image_transformations#image_format_support | Image formats}
* {@link https://cloudinary.com/documentation/video_manipulation_and_delivery#transcoding_video_to_other_formats | Video formats}
* {@link https://cloudinary.com/documentation/image_transformations#image_format_support|Image formats}
* {@link https://cloudinary.com/documentation/video_manipulation_and_delivery#transcoding_video_to_other_formats|Video formats}
*
* @memberOf Actions.Delivery
* @param {string} format The file format. For a list of supported format types see {@link Qualifiers.Format| format types} for
Expand Down Expand Up @@ -71,8 +71,8 @@ function dpr(dpr: string|number):DeliveryAction {
* @summary action
* @description Controls the quality of the delivered image or video.
*
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/image_optimization#how_to_optimize_image_quality | Image quality}
* {@link https://cloudinary.com/documentation/video_manipulation_and_delivery#quality_control | Video quality}
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/image_optimization#how_to_optimize_image_quality|Image quality}
* {@link https://cloudinary.com/documentation/video_manipulation_and_delivery#quality_control|Video quality}
* @memberOf Actions.Delivery
* @param {QualityTypes | string | number | Qualifiers.Quality} qualityType For a list of supported quality types see
* {@link Qualifiers.Quality| quality types} for
Expand Down
2 changes: 1 addition & 1 deletion src/actions/delivery/DeliveryQualityAction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class DeliveryQualityAction extends DeliveryAction {

/**
* Selet the Chroma sub sampling</br>
* <b>Learn more</b>: {@link https://cloudinary.com/documentation/image_transformations#toggling_chroma_subsampling | Toggling chroma subsampling}
* <b>Learn more</b>: {@link https://cloudinary.com/documentation/image_transformations#toggling_chroma_subsampling|Toggling chroma subsampling}
* @param {420 | 444 | number} type The chroma sub sampling type
*/
chromaSubSampling(type: 420 | 444 | number): this {
Expand Down
4 changes: 2 additions & 2 deletions src/actions/effect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ function outline(): EffectOutline {
/**
* @summary action
* @description Applies a complex deep learning neural network algorithm that extracts artistic styles from a source image and applies them to the content of a target photograph.<br/>
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/neural_artwork_style_transfer_addon | Neural Artwork Style Transfer}
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/neural_artwork_style_transfer_addon|Neural Artwork Style Transfer}
* @memberOf Actions.Effect
* @param {ImageSource} imageSource `import {image} from '@cloudinary/url-gen/qualifiers/sources`
* @return {Actions.Effect.StyleTransfer}
Expand Down Expand Up @@ -429,7 +429,7 @@ function pixelate(squareSize?: number): Pixelate {
* @summary action
* @description Makes the background of an image transparent (or solid white for JPGs).</br>
* Use when the background is a uniform color.
* {@link https://cloudinary.com/documentation/transformation_reference#e_bgremoval | Background Removal}
* {@link https://cloudinary.com/documentation/transformation_reference#e_bgremoval|Background Removal}
*
* @memberOf Actions.Effect
* @return {Actions.Effect.RemoveBackgroundAction}
Expand Down
2 changes: 1 addition & 1 deletion src/actions/extract.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ class ExtractAction extends Action {
/**
* @summary action
* @description Extracts an image containing only specified layers of a Photoshop image.
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#deliver_selected_layers_of_a_psd_image | Deliver selected layers of a PSD image}
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#deliver_selected_layers_of_a_psd_image|Deliver selected layers of a PSD image}
* @memberOf Actions.Extract
* @return {Actions.Extract.ExtractAction}
*/
Expand Down
4 changes: 2 additions & 2 deletions src/actions/psdTools.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import {SmartObjectAction} from "./psdTools/SmartObjectAction.js";
/**
* @namespace PSDTools
* @description Represents a layer in a Photoshop document.
* </br><b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#deliver_selected_layers_of_a_psd_image | Deliver selected layers of a PSD image}
* </br><b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#deliver_selected_layers_of_a_psd_image|Deliver selected layers of a PSD image}
* @memberOf Actions
* @example
* // See examples under each method
Expand Down Expand Up @@ -39,7 +39,7 @@ function clip(): ClipAction {
* @summary action
* @description Delivers an image containing only specified layers of a Photoshop image.
*
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#deliver_selected_layers_of_a_psd_image | Deliver selected layers of a PSD image}
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#deliver_selected_layers_of_a_psd_image|Deliver selected layers of a PSD image}
* @memberOf Actions.PSDTools
* @return {Actions.PSDTools.GetLayerAction}
* @example
Expand Down
2 changes: 1 addition & 1 deletion src/actions/psdTools/GetLayerAction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {QualifierValue} from "../../internal/qualifier/QualifierValue.js";

/**
* @description Represents a layer in a Photoshop document.
* </br><b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#deliver_selected_layers_of_a_psd_image | Deliver selected layers of a PSD image}
* </br><b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#deliver_selected_layers_of_a_psd_image|Deliver selected layers of a PSD image}
* @extends SDK.Action
* @memberOf Actions.PSDTools
* @see Visit {@link Actions.PSDTools| PSDTools} for an example
Expand Down
2 changes: 1 addition & 1 deletion src/actions/psdTools/SmartObjectAction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {QualifierValue} from "../../internal/qualifier/QualifierValue.js";

/**
* @description Represents an embedded smart object in a Photoshop document.
* </br><b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#extract_the_original_content_of_an_embedded_object | Extract the original content of an embedded Photoshop object}
* </br><b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#extract_the_original_content_of_an_embedded_object|Extract the original content of an embedded Photoshop object}
* @extends SDK.Action
* @memberOf Actions.PSDTools
* @see Visit {@link Actions.PSDTools| PSDTools} for an example
Expand Down
6 changes: 3 additions & 3 deletions src/actions/reshape.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ function cutByImage(imageSource: ImageSource | TextSource | FetchSource): CutByI
* @summary action
* @description Distorts the image to an arc shape.
*
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/transformation_reference#e_distort | Distorting images}</br>
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/image_transformations#image_shape_changes_and_distortion_effects | Distortion effects}
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/transformation_reference#e_distort|Distorting images}</br>
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/image_transformations#image_shape_changes_and_distortion_effects|Distortion effects}
*
* @param {number} degrees The degrees to arc the image
* @memberOf Actions.Reshape
Expand Down Expand Up @@ -83,7 +83,7 @@ function distortArc(degrees: number | string): DistortArcAction {
* Specify four corner coordinates, representing the new coordinates for each of the image's four corners,
* in clockwise order from the top-left corner.
*
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/transformation_reference#e_distort | Distorting images}
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/transformation_reference#e_distort|Distorting images}
*
* @param {number[]} coordinates - Four x/y pairs representing the new image corners
* @memberOf Actions.Reshape
Expand Down
2 changes: 1 addition & 1 deletion src/actions/reshape/Distort.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export type IDistortCoordinates = [number, number, number, number, number, numbe
* Specify four corner coordinates, representing the new coordinates for each of the image's four corners,
* in clockwise order from the top-left corner.
*
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/transformation_reference#e_distort | Distorting images}
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/transformation_reference#e_distort|Distorting images}
* @param {number[]} coordinates - Four x/y pairs representing the new image corners
* @extends SDK.Action
* @memberOf Actions.Reshape
Expand Down
4 changes: 2 additions & 2 deletions src/actions/reshape/DistortArc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import {Qualifier} from "../../internal/qualifier/Qualifier.js";
/**
* @description Distorts the image to an arc shape.
*
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/transformation_reference#e_distort | Distorting images}</br>
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/image_transformations#image_shape_changes_and_distortion_effects | Distortion effects}
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/transformation_reference#e_distort|Distorting images}</br>
* <b>Learn more:</b> {@link https://cloudinary.com/documentation/image_transformations#image_shape_changes_and_distortion_effects|Distortion effects}
* @param {number} degrees The degrees to arc the image
* @extends SDK.Action
* @memberOf Actions.Reshape
Expand Down
4 changes: 2 additions & 2 deletions src/actions/resize.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ function scale(width?: number | string, height?: number | string): ResizeScaleAc
* @description
* Scales your image based on automatically calculated areas of interest within each specific photo.
*
* For details, see the Imagga Crop and Scale {@link https://cloudinary.com/documentation/imagga_crop_and_scale_addon#smartly_scale_images | add-on documentation}.
* For details, see the Imagga Crop and Scale {@link https://cloudinary.com/documentation/imagga_crop_and_scale_addon#smartly_scale_images|add-on documentation}.
* @memberOf Actions.Resize
* @param {number|string} width The required width of a transformed asset.
* @param {number|string} height The required height of a transformed asset.
Expand All @@ -100,7 +100,7 @@ function imaggaScale(width?: number | string, height?: number | string): ResizeS
* @description
* Crops your image based on automatically calculated areas of interest within each specific photo.
*
* For details, see the Imagga Crop and Scale {@link https://cloudinary.com/documentation/imagga_crop_and_scale_addon#smartly_crop_images | add-on documentation}.
* For details, see the Imagga Crop and Scale {@link https://cloudinary.com/documentation/imagga_crop_and_scale_addon#smartly_crop_images|add-on documentation}.
* @memberOf Actions.Resize
* @param {number|string} width The required width of a transformed asset.
* @param {number|string} height The required height of a transformed asset.
Expand Down
2 changes: 1 addition & 1 deletion src/actions/resize/ResizeSimpleAction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ class ResizeSimpleAction extends Action {

/**
* @description Sets the aspect ratio of the asset.
* For a list of supported types see {@link Qualifiers.AspectRatio |
* For a list of supported types see {@link Qualifiers.AspectRatio|
* AspectRatio values}
* @param {AspectRatioType|number|string} ratio The new aspect ratio, specified as a percentage or ratio.
* @return {this}
Expand Down
4 changes: 2 additions & 2 deletions src/actions/rotate/RotateAction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ const QUALIFIER_KEY = 'a';
/**
* @description Rotates or flips an image or video.
*
* <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}
* <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}
* @extends SDK.Action
* @memberOf Actions.Rotate
* @see Visit {@link Actions.Rotate|Rotate} for an example
Expand Down
4 changes: 2 additions & 2 deletions src/actions/roundCorners.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
* @description Round one or more corners of an image or video.
*
* <b>Learn more:</b>
* {@link https://cloudinary.com/documentation/image_transformations#rounding_corners_and_creating_circular_images | Rounded images}
* {@link https://cloudinary.com/documentation/video_manipulation_and_delivery#rounding_corners_and_creating_circular_videos | Rounded videos}
* {@link https://cloudinary.com/documentation/image_transformations#rounding_corners_and_creating_circular_images|Rounded images}
* {@link https://cloudinary.com/documentation/video_manipulation_and_delivery#rounding_corners_and_creating_circular_videos|Rounded videos}
* @memberOf Actions
* @namespace RoundCorners
* @example
Expand Down
Loading