Skip to content

Commit

Permalink
Restrict documented GeometryEngine types
Browse files Browse the repository at this point in the history
  • Loading branch information
BenMorel committed Oct 10, 2021
1 parent 3e78423 commit 3c449fb
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions src/Engine/GeometryEngine.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@

namespace Brick\Geo\Engine;

use Brick\Geo\Curve;
use Brick\Geo\Geometry;
use Brick\Geo\Exception\GeometryEngineException;
use Brick\Geo\MultiCurve;
use Brick\Geo\MultiSurface;
use Brick\Geo\Point;
use Brick\Geo\Surface;

/**
* Interface for geometry engines.
Expand Down Expand Up @@ -51,7 +55,7 @@ public function envelope(Geometry $g) : Geometry;
/**
* Returns the length of a Curve or MultiCurve in its associated spatial reference.
*
* @param Geometry $g The geometry.
* @param Curve|MultiCurve $g The geometry.
*
* @return float The length of the geometry.
*
Expand All @@ -62,7 +66,7 @@ public function length(Geometry $g) : float;
/**
* Returns the area of a Surface or MultiSurface in its SRID units.
*
* @param Geometry $g The geometry.
* @param Surface|MultiSurface $g The geometry.
*
* @return float The area of the geometry.
*
Expand Down Expand Up @@ -99,7 +103,7 @@ public function centroid(Geometry $g) : Point;
/**
* Returns a Point guaranteed to be on a Surface or MultiSurface.
*
* @param Geometry $g The geometry.
* @param Surface|MultiSurface $g The geometry.
*
* @return Geometry A point of the surface of the geometry.
*
Expand Down

0 comments on commit 3c449fb

Please sign in to comment.