Improve documentation of ASLayoutRangeMode

This commit is contained in:
Huy Nguyen
2016-02-04 14:03:37 -08:00
parent b3b28b0df9
commit 260879db7d

View File

@@ -8,17 +8,23 @@
#import <Foundation/Foundation.h>
/// Each mode has a complete set of tuning parameters for range types.
/// Depends on some conditions (including interface state and direction of the scroll view, state of rendering engine, etc),
/// a range controller can choose which mode it should use at a given time.
/**
* Each mode has a complete set of tuning parameters for range types.
* Depending on some conditions (including interface state and direction of the scroll view, state of rendering engine, etc),
* a range controller can choose which mode it should use at a given time.
*/
typedef NS_ENUM(NSUInteger, ASLayoutRangeMode) {
/// Minimum mode is used when a range controller should limit the amount of work it performs.
/// Thus, less views/layers are created and less data is fetched.
/// Range controller can automatically switch to full mode when conditions changed.
/**
* Minimum mode is used when a range controller should limit the amount of work it performs.
* Thus, fewer views/layers are created and less data is fetched, saving system resources.
* Range controller can automatically switch to full mode when conditions change.
*/
ASLayoutRangeModeMinimum = 0,
/// Normal/Full mode that a range controller uses to provide the best experience for end users.
/// This mode is usually used for an active scroll view.
/// A range controller under this requires more resources compare to minimum mode.
/**
* Normal/Full mode that a range controller uses to provide the best experience for end users.
* This mode is usually used for an active scroll view.
* A range controller under this requires more resources compare to minimum mode.
*/
ASLayoutRangeModeFull,
ASLayoutRangeModeCount
};