Docs: cross-link removeAlpha and flatten

This commit is contained in:
Lovell Fuller
2021-05-23 18:46:23 +01:00
parent ed3377cb2d
commit 1b4d1521e0
5 changed files with 39 additions and 29 deletions

View File

@@ -270,9 +270,11 @@ function blur (sigma) {
/**
* Merge alpha transparency channel, if any, with a background, then remove the alpha channel.
*
* See also {@link /api-channel#removealpha|removeAlpha}.
*
* @example
* await sharp(rgbaInput)
* .flatten({background: '#F0A703' })
* .flatten({ background: '#F0A703' })
* .toBuffer();
*
* @param {Object} [options]
@@ -351,11 +353,10 @@ function normalize (normalize) {
}
/**
* Perform contrast limiting adaptive histogram equalization (CLAHE)
* Perform contrast limiting adaptive histogram equalization
* ({@link https://en.wikipedia.org/wiki/Adaptive_histogram_equalization#Contrast_Limited_AHE|CLAHE}).
*
* This will, in general, enhance the clarity of the image by bringing out
* darker details. Please read more about CLAHE here:
* https://en.wikipedia.org/wiki/Adaptive_histogram_equalization#Contrast_Limited_AHE
* This will, in general, enhance the clarity of the image by bringing out darker details.
*
* @since 0.28.3
*