Skip to content

Commit 3b85546

Browse files
committed
Added more header documentation
1 parent 1a74c55 commit 3b85546

9 files changed

+33
-4
lines changed

TOPasscodeViewController/Views/Main/TOPasscodeView.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ NS_ASSUME_NONNULL_BEGIN
106106
/*
107107
Reset the passcode to nil and optionally play animation / vibration to match
108108
109-
@param animated Play a shaking animation to reset the password.
109+
@param animated Play a shaking animation to reset the passcode.
110110
@param impact On supported devices, play a small reset vibration as well.
111111
*/
112112
- (void)resetPasscodeAnimated:(BOOL)animated playImpact:(BOOL)impact;

TOPasscodeViewController/Views/Settings/TOPasscodeSettingsKeypadButton.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
/**
2828
A single button view that is used in a number keypad views styled in
2929
a pseudo-skeuomorphic style.
30-
3130
*/
3231
@interface TOPasscodeSettingsKeypadButton : UIButton
3332

TOPasscodeViewController/Views/Settings/TOPasscodeSettingsKeypadView.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@
2525

2626
NS_ASSUME_NONNULL_BEGIN
2727

28+
/**
29+
A keypad view of 9 buttons that allow numerical input on both iPad and iPhone.
30+
Designed to match the base system, with a pseudo-skeuomorphical styling.
31+
*/
2832
@interface TOPasscodeSettingsKeypadView : UIView
2933

3034
/* Whether the control is allowing input */

TOPasscodeViewController/Views/Settings/TOPasscodeSettingsWarningLabel.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@
2222

2323
#import <UIKit/UIKit.h>
2424

25+
/**
26+
When a user enters an incorrect passcode in the settings interface,
27+
this view is displayed to show the number of failed attempts.
28+
*/
2529
@interface TOPasscodeSettingsWarningLabel : UIImageView
2630

2731
/** The number of incorrect passcode attempts to display */

TOPasscodeViewController/Views/Shared/TOPasscodeButtonLabel.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@
2424

2525
NS_ASSUME_NONNULL_BEGIN
2626

27+
/**
28+
A view that manages two label subviews: a larger label showing a single number
29+
and a smaller label showing lettering as well.
30+
*/
2731
@interface TOPasscodeButtonLabel : UIView
2832

2933
// Draws the lettering label to the side

TOPasscodeViewController/Views/Shared/TOPasscodeCircleView.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424

2525
NS_ASSUME_NONNULL_BEGIN
2626

27+
/**
28+
A view containing two circle image views that can animate
29+
between filled and hollow, whilst maintaining compatibility
30+
with translucency views.
31+
*/
2732
@interface TOPasscodeCircleView : UIView
2833

2934
/* The circle patterns used for neutral and highlighted states. */

TOPasscodeViewController/Views/Shared/TOPasscodeFixedInputView.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@
2424

2525
@class TOPasscodeCircleView;
2626

27+
/**
28+
A basic content view showing a row of circles that can be used to represent
29+
a fixed size passcode.
30+
*/
2731
@interface TOPasscodeFixedInputView : UIView
2832

2933
/* The size of each circle in this view (Default is 16) */

TOPasscodeViewController/Views/Shared/TOPasscodeInputField.h

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@ typedef NS_ENUM(NSInteger, TOPasscodeInputFieldStyle) {
3333
TOPasscodeInputFieldStyleVariable // The passcode can be any arbitrary number of characters (Shows an empty rectangle)
3434
};
3535

36+
/**
37+
An abstract input view capable of receiving different types of passcodes.
38+
When a fixed character passcode is specified, the view shows a row of circles.
39+
When a variable passcode is specified, a rounded rectangle is shown.
40+
*/
3641
@interface TOPasscodeInputField : UIView <UIKeyInput>
3742

3843
/* The visual effects view used to control the vibrancy of the input field */
@@ -86,7 +91,7 @@ typedef NS_ENUM(NSInteger, TOPasscodeInputFieldStyle) {
8691
/* Init with the target length needed for this passcode */
8792
- (instancetype)initWithStyle:(TOPasscodeInputFieldStyle)style;
8893

89-
/* Replace the passcode with this one, and animate the transition */
94+
/* Replace the passcode with this one, and animate the transition. */
9095
- (void)setPasscode:(nullable NSString *)passcode animated:(BOOL)animated;
9196

9297
/* Add additional characters to the end of the passcode, and animate if desired. */
@@ -98,7 +103,7 @@ typedef NS_ENUM(NSInteger, TOPasscodeInputFieldStyle) {
98103
/* Plays a shaking animation and resets the passcode back to empty */
99104
- (void)resetPasscodeAnimated:(BOOL)animated playImpact:(BOOL)impact;
100105

101-
/* Animates the OK button changing location */
106+
/* Animates the OK button changing location. */
102107
- (void)setHorizontalLayout:(BOOL)horizontalLayout animated:(BOOL)animated duration:(CGFloat)duration;
103108

104109
@end

TOPasscodeViewController/Views/Shared/TOPasscodeVariableInputView.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@
2222

2323
#import <UIKit/UIKit.h>
2424

25+
/**
26+
A basic content view showing a rounded rectangle containing circles that can be used to represent
27+
a variable size passcode.
28+
*/
2529
@interface TOPasscodeVariableInputView : UIImageView
2630

2731
/* The thickness of the stroke around the view (Default is 1.5) */

0 commit comments

Comments
 (0)