diff options
author | Minh Nguyễn <mxn@1ec5.org> | 2016-05-09 16:05:14 -0700 |
---|---|---|
committer | Minh Nguyễn <mxn@1ec5.org> | 2016-05-10 09:59:04 -0700 |
commit | 1634058b51da4885224ba7f63aab14c7d794652f (patch) | |
tree | 810318a22f6d165466eace6804c247626b7fe891 /platform/darwin/src/MGLMultiPoint.h | |
parent | a025d8327afeea74a9a1a8c9a9a237e21af917bb (diff) | |
download | qtlocation-mapboxgl-1634058b51da4885224ba7f63aab14c7d794652f.tar.gz |
[ios, osx] Reformatted documentation comments
Reformatted documentation comments in public headers in the OS X SDK and public headers shared between the iOS and OS X SDKs to wrap at column 80 and avoid excessive indentation that causes SourceKitten to detect code blocks.
Diffstat (limited to 'platform/darwin/src/MGLMultiPoint.h')
-rw-r--r-- | platform/darwin/src/MGLMultiPoint.h | 19 |
1 files changed, 16 insertions, 3 deletions
diff --git a/platform/darwin/src/MGLMultiPoint.h b/platform/darwin/src/MGLMultiPoint.h index ad9db1e681..041c52e8f2 100644 --- a/platform/darwin/src/MGLMultiPoint.h +++ b/platform/darwin/src/MGLMultiPoint.h @@ -7,7 +7,14 @@ NS_ASSUME_NONNULL_BEGIN -/** The `MGLMultiPoint` class is an abstract superclass used to define shapes composed of multiple points. You should not create instances of this class directly. Instead, you should create instances of the `MGLPolyline` or `MGLPolygon` classes. However, you can use the method and properties of this class to access information about the specific points associated with the line or polygon. */ +/** + The `MGLMultiPoint` class is an abstract superclass used to define shapes + composed of multiple points. You should not create instances of this class + directly. Instead, you should create instances of the `MGLPolyline` or + `MGLPolygon` classes. However, you can use the method and properties of this + class to access information about the specific points associated with the line + or polygon. + */ @interface MGLMultiPoint : MGLShape /** The number of points associated with the shape. (read-only) */ @@ -16,8 +23,14 @@ NS_ASSUME_NONNULL_BEGIN /** Retrieves one or more coordinates associated with the shape. - @param coords On input, you must provide a C array of structures large enough to hold the desired number of coordinates. On output, this structure contains the requested coordinate data. - @param range The range of points you want. The `location` field indicates the first point you are requesting, with `0` being the first point, `1` being the second point, and so on. The `length` field indicates the number of points you want. The array in _`coords`_ must be large enough to accommodate the number of requested coordinates. + @param coords On input, you must provide a C array of structures large enough + to hold the desired number of coordinates. On output, this structure + contains the requested coordinate data. + @param range The range of points you want. The `location` field indicates the + first point you are requesting, with `0` being the first point, `1` being + the second point, and so on. The `length` field indicates the number of + points you want. The array in _`coords`_ must be large enough to accommodate + the number of requested coordinates. */ - (void)getCoordinates:(CLLocationCoordinate2D *)coords range:(NSRange)range; |