From 7cf2918f2a3ff3c9e4fb3eda370bc2bae7dcae8c Mon Sep 17 00:00:00 2001 From: Joel Fischer Date: Wed, 6 May 2020 10:27:46 -0400 Subject: Fix some documentation --- SmartDeviceLink/SDLTouchManager.h | 37 +++++++++++++++---------------------- 1 file changed, 15 insertions(+), 22 deletions(-) diff --git a/SmartDeviceLink/SDLTouchManager.h b/SmartDeviceLink/SDLTouchManager.h index 7b7e65a97..c762d6822 100644 --- a/SmartDeviceLink/SDLTouchManager.h +++ b/SmartDeviceLink/SDLTouchManager.h @@ -33,39 +33,35 @@ typedef void(^SDLTouchEventHandler)(SDLTouch *touch, SDLTouchType type); @property (nonatomic, weak, nullable) id touchEventDelegate; /** - * @abstract - * Returns all OnTouchEvent notifications as SDLTouch and SDLTouchType objects. + Returns all OnTouchEvent notifications as SDLTouch and SDLTouchType objects. */ @property (copy, nonatomic, nullable) SDLTouchEventHandler touchEventHandler; /** Distance between two taps on the screen, in the head unit's coordinate system, used for registering double-tap callbacks. - @note Defaults to 50 px. + Defaults to 50 px. */ @property (nonatomic, assign) CGFloat tapDistanceThreshold; /** Minimum distance for a pan gesture in the head unit's coordinate system, used for registering pan callbacks. - @note Defaults to 8 px. + Defaults to 8 px. */ @property (nonatomic, assign) CGFloat panDistanceThreshold; /** - * @abstract - * Time (in seconds) between tap events to register a double-tap callback. - * @remark - * Default is 0.4 seconds. + Time (in seconds) between tap events to register a double-tap callback. This must be greater than 0.0. + + Default is 0.4 seconds. */ @property (nonatomic, assign) CGFloat tapTimeThreshold; /** - * @abstract - * Time (in seconds) between movement events to register panning or pinching - * callbacks. - * @remark - * Default is 0.05 seconds. + Time (in seconds) between movement events to register panning or pinching callbacks. + + Default is 0.05 seconds. */ @property (nonatomic, assign) CGFloat movementTimeThreshold __deprecated_msg("This is now unused, the movement time threshold is now synced to the framerate automatically"); @@ -75,19 +71,16 @@ typedef void(^SDLTouchEventHandler)(SDLTouch *touch, SDLTouchType type); @property (assign, nonatomic) BOOL enableSyncedPanning; /** - * @abstract - * Boolean denoting whether or not the touch manager should deliver touch event - * callbacks. - * @remark - * Default is true. + Boolean denoting whether or not the touch manager should deliver touch event callbacks. + + Default is true. */ @property (nonatomic, assign, getter=isTouchEnabled) BOOL touchEnabled; /** - * @abstract - * Cancels pending touch event timers that may be in progress. - * @remark - * Currently only impacts the timer used to register single taps. + Cancels pending touch event timers that may be in progress. + + Currently only impacts the timer used to register single taps. */ - (void)cancelPendingTouches; -- cgit v1.2.1