Skip to content

Commit 09014fa

Browse files
authored
remove link tags to impgroxy docs
1 parent a1a034a commit 09014fa

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+101
-103
lines changed

populate-readme.cjs

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,7 @@ for (let i = 0; i < commentsWithExamples.length; i++) {
4848

4949
for (let j = 0; j < textLines.length; j++) {
5050
if (
51-
textLines[j]
52-
.trim()
53-
.startsWith('@see {@link https://github.com/imgproxy/imgproxy')
51+
textLines[j].trim().startsWith('See https://github.com/imgproxy/imgproxy')
5452
) {
5553
mode = 'link';
5654
} else if (textLines[j].startsWith('@example')) {
@@ -64,7 +62,7 @@ for (let i = 0; i < commentsWithExamples.length; i++) {
6462
description += ` ${textLines[j]}`;
6563
break;
6664
case 'link':
67-
url = textLines[j].replace(/^.+(https\:\/\/[^}]+).+$/, '$1');
65+
url = textLines[j].replace(/^.+(https\:\/\/[^ ]+).+$/, '$1');
6866
break;
6967
case 'example':
7068
for (let k = j + 1; k < textLines.length; k++) {

src/param-builder.ts

Lines changed: 49 additions & 49 deletions
Large diffs are not rendered by default.

src/transformers/adjust.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ type AdjustOptions = {
2323
/**
2424
* Defines the brightness, contrast, and saturation.
2525
*
26-
* @see {@link https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#adjust-idadjust}. for the imgproxy documentation
26+
* See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#adjust-idadjust for the imgproxy documentation
2727
*
2828
* @param options The adjustment options
2929
* @returns The adjustment param string

src/transformers/auto-rotate.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { stringifyOptions } from '../common';
33
/**
44
* Automatically rotates the image based on the EXIF orientation parameter.
55
*
6-
* @see {@link https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#auto-rotate}. for the imgproxy documentation
6+
* See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#auto-rotate for the imgproxy documentation
77
*
88
* @returns The auto-rotate param string
99
*/

src/transformers/background-alpha.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ type BackgroundAlphaOptions = number;
88
/**
99
* Adds alpha channel to background.
1010
*
11-
* @see {@link https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#background-alpha-idbackground-alpha}. for the imgproxy documentation
11+
* See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#background-alpha-idbackground-alpha for the imgproxy documentation
1212
*
1313
* @param percentage A positive floating point number between 0 and 1
1414
* @returns The background alpha param string

src/transformers/background.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ type BackgroundOptions =
2525
/**
2626
* Fills the image background with the specified color.
2727
*
28-
* @see {@link https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#background}. for the imgproxy documentation
28+
* See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#background for the imgproxy documentation
2929
*
3030
* @param options The background color (hex encoded string or RGB object)
3131
* @returns The background param string

src/transformers/blur-detections.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ type BlurDetectionOptions = {
1818
/**
1919
* Detects objects of the provided classes and blurs them.
2020
*
21-
* @see {@link https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#blur-detections-idblur-detections} for the imgproxy documentation
21+
* See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#blur-detections-idblur-detections for the imgproxy documentation
2222
*
2323
* @param options The detection options
2424
* @returns The blur detection param string

src/transformers/blur.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ type BlurOptions = number;
88
/**
99
* Applies a gaussian blur filter to the image.
1010
*
11-
* @see {@link https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#blur}. for the imgproxy documentation
11+
* See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#blur for the imgproxy documentation
1212
*
1313
* @param sigma The size of the blur mask
1414
* @returns The blur param string

src/transformers/brightness.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ type BrightnessOptions = number;
88
/**
99
* Adjusts the brightness of an image.
1010
*
11-
* @see {@link https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#brightness-idbrightness}. for the imgproxy documentation
11+
* See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#brightness-idbrightness for the imgproxy documentation
1212
*
1313
* @param value An integer number ranging from -255 to 255.
1414
* @returns The brightness param string

src/transformers/cache-buster.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ type CacheBusterOptions = string;
88
/**
99
* Adds a cache buster to the imgproxy params.
1010
*
11-
* @see {@link https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#cache-buster}. for the imgproxy documentation
11+
* See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#cache-buster for the imgproxy documentation
1212
*
1313
* @param buster The cache buster
1414
* @returns The cache buster param string

0 commit comments

Comments
 (0)