From 213c4cec06d9e9b65c7ed0a91f9e6395962abb1b Mon Sep 17 00:00:00 2001 From: Charles Powell Date: Sat, 12 Dec 2015 11:56:20 -0700 Subject: [PATCH] Update documentation on pauseLabel and unpauseLabel methods. --- MarqueeLabel.h | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/MarqueeLabel.h b/MarqueeLabel.h index 318ce766..fcf6ac5c 100755 --- a/MarqueeLabel.h +++ b/MarqueeLabel.h @@ -312,15 +312,18 @@ typedef NS_ENUM(NSUInteger, MarqueeType) { - (void)resetLabel; -/** Pauses the text scrolling animation, at any point during the animation. +/** Pauses the text scrolling animation, at any point during an in-progress animation. + @note This method has no effect if a scroll animation is NOT already in progress. To prevent automatic scrolling on a newly-initialized label prior to its presentation onscreen, see the `holdScrolling` property. + + @see holdScrolling @see unpauseLabel */ - (void)pauseLabel; -/** Un-pauses a previously paused text scrolling animation +/** Un-pauses a previously paused text scrolling animation. This method has no effect if the label was not previously paused using `pauseLabel`. @see pauseLabel */