Skip to content

Commit

Permalink
Removed examples from the comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
dlemstra committed Nov 7, 2023
1 parent 59efed4 commit 0bc9ce2
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 27 deletions.
22 changes: 5 additions & 17 deletions src/magick-image.ts
Original file line number Diff line number Diff line change
Expand Up @@ -161,35 +161,23 @@ export interface IMagickImage extends IDisposable {
compositeGravity(image: IMagickImage, gravity: Gravity, compose: CompositeOperator, point: Point, channels: Channels): void;
compositeGravity(image: IMagickImage, gravity: Gravity, compose: CompositeOperator, point: Point, args: string): void;
compositeGravity(image: IMagickImage, gravity: Gravity, compose: CompositeOperator, point: Point, args: string, channels: Channels): void;

/**
* Determines the connected-components of the image.
*
*
* @param connectivity The number of neighbors to visit (4 or 8).
* @see {@link https://imagemagick.org/script/connected-components.php}
*
* @example
* declare const image: MagickImage;
* const components = image.connectedComponents(4);
* // ^? ConnectedComponent[]
*/
connectedComponents(connectivity: Connectivity): ConnectedComponent[];

/**
* Determines the connected-components of the image.
*
*
* @param settings The connected-components operation settings.
* @see {@link https://imagemagick.org/script/connected-components.php}
*
* @example
* declare const image: MagickImage;
*
* const settings = new ConnectedComponentsSettings(4);
* settings.areaThreshold = new Threshold(50);
* settings.meanColor = true;
*
* const components = image.connectedComponents(settings);
* // ^? ConnectedComponent[]
*/
connectedComponents(settings: ConnectedComponentsSettings): ConnectedComponent[];

contrast(): void;
contrastStretch(blackPoint: Percentage): void;
contrastStretch(blackPoint: Percentage, whitePoint: Percentage): void;
Expand Down
10 changes: 0 additions & 10 deletions src/threshold.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,6 @@ export class Threshold {

/**
* Convert the threshold to a string.
*
* @example
* // no maximum
* const threshold = new Threshold(50);
* threshold.toString(); // '50'
*
* @example
* // with maximum
* const threshold = new Threshold(50, 100);
* threshold.toString(); // '50-100'
*/
toString(): string {
if (this.maximum === 0) {
Expand Down

0 comments on commit 0bc9ce2

Please sign in to comment.