Added more header documentation

Author: TimOliver

TOPasscodeViewController/TOPasscodeSettingsViewController.h

@@ -88,10 +88,19 @@ NS_ASSUME_NONNULL_BEGIN
 /** If set, the view controller will disable input until this date time has been reached */
 @property (nonatomic, strong, nullable) NSDate *disabledInputDate;
 
-/* Create a new instance with the desird light or dark style */
+/*
+ Create a new instance with the desird light or dark style
+
+ @param style The visual style of the view controller
+ */
 - (instancetype)initWithStyle:(TOPasscodeSettingsViewStyle)style;
 
-/* Changes the passcode type and animates if required */
+/*
+ Changes the passcode type and animates if required
+
+ @param passcodeType Change the type of passcode to enter.
+ @param animated Play a crossfade animation.
+ */
 - (void)setPasscodeType:(TOPasscodeType)passcodeType animated:(BOOL)animated;
 
 @end

TOPasscodeViewController/TOPasscodeViewController.h

@@ -128,10 +128,20 @@ NS_ASSUME_NONNULL_BEGIN
      Useful for obscuring the content while the app is suspended. */
 @property (nonatomic, assign) BOOL contentHidden;
 
-/** Create a new instance of this view controller with the preset style. */
+/**
+ Create a new instance of this view controller with the preset style and passcode type.
+
+ @param style The visual style of the view controller (light/translucent)
+ @param type The type of passcode to enter (6-digit/numeric)
+ */
 - (instancetype)initWithStyle:(TOPasscodeViewStyle)style passcodeType:(TOPasscodeType)type;
 
-/** Hide all of the content views with a crossfade animation */
+/**
+ Hide everything except the background translucency view.
+
+ @param hidden Whether the content is hidden or not.
+ @param animated The content will play a crossfade animation.
+ */
 - (void)setContentHidden:(BOOL)hidden animated:(BOOL)animated;
 
 @end

TOPasscodeViewController/Views/Main/TOPasscodeCircleButton.h

@@ -27,6 +27,10 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/**
+ A UI control representing a single PIN code button for the keypad,
+ including the number, lettering (eg 'ABC'), and circle border.
+ */
 @interface TOPasscodeCircleButton : UIControl
 
 // Alpha value that properly controls the necessary subviews
@@ -56,9 +60,20 @@ NS_ASSUME_NONNULL_BEGIN
 // Callback handler
 @property (nonatomic, copy) void (^buttonTappedHandler)();
 
+/**
+ Create a new instance of the class with the supplied number and lettering string
+
+ @param numberString The string of the number to display in this button (eg '1').
+ @param letteringString The string of the lettering to display underneath.
+ */
 - (instancetype)initWithNumberString:(NSString *)numberString letteringString:(NSString *)letteringString;
 
-// Automatically called when tapped
+/**
+ Set the background of the button to be the filled circle instead of hollow.
+
+ @param highlighted When YES, the circle is full, when NO, it is hollow.
+ @param animated When animated, the transition is a crossfade.
+ */
 - (void)setHighlighted:(BOOL)highlighted animated:(BOOL)animated;
 
 @end

TOPasscodeViewController/Views/Main/TOPasscodeKeypadView.h

@@ -26,6 +26,10 @@ NS_ASSUME_NONNULL_BEGIN
 
 @class TOPasscodeCircleButton;
 
+/**
+ A view encompassing 9 circle buttons, making up a keypad view for entering PIN numbers.
+ Can be laid out vertically or horizontally.
+ */
 @interface TOPasscodeKeypadView : UIView <UIInputViewAudioFeedback>
 
 /** The type of layout for the buttons (Default is vertical) */
@@ -83,7 +87,13 @@ NS_ASSUME_NONNULL_BEGIN
 /** The block that is triggered whenever a user taps one of the buttons */
 @property (nonatomic, copy) void (^buttonTappedHandler)(NSInteger buttonNumber);
 
-/* Perform an animation of a set duration to the new layout */
+/*
+ Perform an animation to transition to a new layout.
+
+ @param horizontalLayout The content is laid out horizontally.
+ @param animated Whether the transition is animated
+ @param duration The animation length of the transition.
+ */
 - (void)setHorizontalLayout:(BOOL)horizontalLayout animated:(BOOL)animated duration:(CGFloat)duration;
 
 @end

TOPasscodeViewController/Views/Main/TOPasscodeView.h

@@ -30,6 +30,11 @@ NS_ASSUME_NONNULL_BEGIN
 @class TOPasscodeKeypadView;
 @class TOPasscodeViewContentLayout;
 
+/**
+ The passcode view is the primary content view for the passcode view controller.
+ On iPad, every view except the background view is a subview of this view.
+ On iPhone, the auxiliary buttons ('Touch ID', 'Cancel') are managed by the view controller.
+ */
 @interface TOPasscodeView : UIView
 
 /* The visual style of the view */
@@ -83,19 +88,43 @@ NS_ASSUME_NONNULL_BEGIN
 /* Callback triggered when the user has finished entering the passcode */
 @property (nonatomic, copy, nullable) void (^passcodeCompletedHandler)(NSString *passcode);
 
-/* Create a new instance with one of the style types */
+/*
+ Create a new instance with one of the style types
+
+ @param style The visual style of the passcode view.
+ @param type The type of passcode to accept.
+ */
 - (instancetype)initWithStyle:(TOPasscodeViewStyle)style passcodeType:(TOPasscodeType)type;
 
-/* Resize the view and all subviews for the optimum size to fit a super view of the suplied width. */
+/*
+ Resize the view and all subviews for the optimum size to fit a super view of the suplied width.
+
+ @param size The size of the view to which this view.
+ */
 - (void)sizeToFitSize:(CGSize)size;
 
-/* Reset the passcode to nil and optionally play animation / vibration to match */
+/*
+ Reset the passcode to nil and optionally play animation / vibration to match
+
+ @param animated Play a shaking animation to reset the password.
+ @param impact On supported devices, play a small reset vibration as well.
+ */
 - (void)resetPasscodeAnimated:(BOOL)animated playImpact:(BOOL)impact;
 
-/* Delete the last character from the passcode */
+/*
+ Delete the last character from the passcode
+
+ @param animated Whether the delete operation is animated or not.
+ */
 - (void)deleteLastPasscodeCharacterAnimated:(BOOL)animated;
 
-/* Animate the transition between horizontal and vertical layouts */
+/*
+ Animate the transition between horizontal and vertical layouts
+
+ @param horizontalLayout Whether to lay out the content vertically or horizontally.
+ @param animated Whether the transition is animated or not.
+ @param duration The duration of the animation
+ */
 - (void)setHorizontalLayout:(BOOL)horizontalLayout animated:(BOOL)animated duration:(CGFloat)duration;
 
 @end

TOPasscodeViewController/Views/Settings/TOPasscodeSettingsKeypadButton.h

@@ -24,6 +24,11 @@
 
 @class TOPasscodeButtonLabel;
 
+/**
+ A single button view that is used in a number keypad views styled in
+ a pseudo-skeuomorphic style.
+
+ */
 @interface TOPasscodeSettingsKeypadButton : UIButton
 
 /** Background Images */