diff options
author | Minh Nguyễn <mxn@1ec5.org> | 2018-02-07 12:42:21 -0800 |
---|---|---|
committer | Minh Nguyễn <mxn@1ec5.org> | 2018-02-07 12:42:21 -0800 |
commit | 2ed069cb0a4e057d0a6135530e073d7094e6c4ee (patch) | |
tree | 12f2fb7ed3caf5a2fab6ecf884be0a647c06ac3c /platform/darwin/src/MGLAbstractShapeSource.h | |
parent | 6c5e4575907c9c7ff73d327114f0c105e6684a4d (diff) | |
download | qtlocation-mapboxgl-2ed069cb0a4e057d0a6135530e073d7094e6c4ee.tar.gz |
[ios, macos] Copyedited computed source wrapping optionsupstream/1ec5-custom-wrap-docs
Renamed MGLShapeSourceOptionWrapCoordinates to MGLShapeSourceOptionWrapsCoordinates and MGLShapeSourceOptionClipCoordinates to MGLShapeSourceOptionClipsCoordinates. Copyedited their documentation comments.
Diffstat (limited to 'platform/darwin/src/MGLAbstractShapeSource.h')
-rw-r--r-- | platform/darwin/src/MGLAbstractShapeSource.h | 31 |
1 files changed, 19 insertions, 12 deletions
diff --git a/platform/darwin/src/MGLAbstractShapeSource.h b/platform/darwin/src/MGLAbstractShapeSource.h index a0c6af36c5..d61f41fbf6 100644 --- a/platform/darwin/src/MGLAbstractShapeSource.h +++ b/platform/darwin/src/MGLAbstractShapeSource.h @@ -82,22 +82,29 @@ extern MGL_EXPORT const MGLShapeSourceOption MGLShapeSourceOptionBuffer; extern MGL_EXPORT const MGLShapeSourceOption MGLShapeSourceOptionSimplificationTolerance; /** - An `NSNumber` object containing a boolean; specifies whether the geometry for a - `MGLComputedShapeSource` needs to be wrapped to accomodate coordinates with longitudes outside the [-180,180] extents. The default is `false.` + An `NSNumber` object containing a Boolean value; specifies whether the shape of + an `MGLComputedShapeSource` should be wrapped to accomodate coordinates with + longitudes beyond −180 and 180. The default value is `NO`. - Setting this option to `true` affects performance. - */ -extern MGL_EXPORT const MGLShapeSourceOption MGLShapeSourceOptionWrapCoordinates; + Setting this option to `YES` affects rendering performance. + + This option is ignored when creating an instance of a class besides + `MGLComputedShapeSource`. + */ +extern MGL_EXPORT const MGLShapeSourceOption MGLShapeSourceOptionWrapsCoordinates; /** - An `NSNumber` object containing a boolean; specifies whether the geometry for a - `MGLComputedShapeSource` needs to be clipped at the tile boundaries. - The default is `false.` - - Setting this options to `true` affects performance. Use this option to clip - polygons and lines at tile boundaries without artefacts. + An `NSNumber` object containing a Boolean value; specifies whether the shape of + an `MGLComputedShapeSource` should be clipped at the edge of each tile. The + default value is `NO`. + + Setting this option to `YES` affects rendering performance. Use this option to + clip `MGLPolyline`s and `MGLPolygon`s at tile boundaries without artifacts. + + This option is ignored when creating an instance of a class besides + `MGLComputedShapeSource`. */ -extern MGL_EXPORT const MGLShapeSourceOption MGLShapeSourceOptionClipCoordinates; +extern MGL_EXPORT const MGLShapeSourceOption MGLShapeSourceOptionClipsCoordinates; /** `MGLAbstractShapeSource` is an abstract base class for map content sources that |