Updated documentation

JonasGessner · May 20, 2016 · 47bce61 · 47bce61
1 parent 77c152c
commit 47bce61
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 11 deletions.
diff --git a/JGProgressHUD/JGProgressHUD/JGProgressHUD-Defines.h b/JGProgressHUD/JGProgressHUD/JGProgressHUD-Defines.h
@@ -56,9 +56,9 @@ typedef NS_ENUM(NSUInteger, JGProgressHUDInteractionType) {
     JGProgressHUDInteractionTypeBlockNoTouches
 };
 
+#ifndef fequal
 /**
  Macro for safe floating point comparison (for internal use in JGProgressHUD).
  */
-#ifndef fequal
 #define fequal(a,b) (fabs((a) - (b)) < FLT_EPSILON)
 #endif
diff --git a/JGProgressHUD/JGProgressHUD/JGProgressHUD.h b/JGProgressHUD/JGProgressHUD/JGProgressHUD.h
@@ -220,12 +220,13 @@
 @property (nonatomic, assign) NSTimeInterval minimumDisplayTime;
 
 /**
- Determines whether voiceover announcements should be made upon displaying the HUD.
+ Determines whether Voice Over announcements should be made upon displaying the HUD (if Voice Over is active).
  @b Default: YES
  */
 @property (nonatomic, assign) BOOL voiceOverEnabled;
 
 
+
 /**
  Shows the HUD animated. You should preferably show the HUD in a UIViewController's view. The HUD will be repositioned in response to rotation and keyboard show/hide notifications.
  @param view The view to show the HUD in. The frame of the @c view will be used to calculate the position of the HUD.

diff --git a/JGProgressHUD/JGProgressHUD/JGProgressHUDImageIndicatorView.h b/JGProgressHUD/JGProgressHUD/JGProgressHUDImageIndicatorView.h
@@ -8,6 +8,11 @@
 
 #import "JGProgressHUDIndicatorView.h"
 
+/**
+ An indicator for displaying custom images. Supports animated images.
+ 
+ You may subclass this class to create a custom image indicator view.
+ */
 @interface JGProgressHUDImageIndicatorView : JGProgressHUDIndicatorView
 
 /**

diff --git a/JGProgressHUD/JGProgressHUD/JGProgressHUDIndeterminateIndicatorView.h b/JGProgressHUD/JGProgressHUD/JGProgressHUDIndeterminateIndicatorView.h
@@ -16,9 +16,6 @@
  */
 - (instancetype)initWithHUDStyle:(JGProgressHUDStyle)style;
 
-
-
-
 /**
  Set the color of the activity indicator view.
  @param color The color to apply to the activity indicator view.

diff --git a/JGProgressHUD/JGProgressHUD/JGProgressHUDPieIndicatorView.h b/JGProgressHUD/JGProgressHUD/JGProgressHUDPieIndicatorView.h
@@ -16,9 +16,6 @@
  */
 - (instancetype)initWithHUDStyle:(JGProgressHUDStyle)style;
 
-
-
-
 /**
  Tint color of the Pie. 
  

diff --git a/JGProgressHUD/JGProgressHUD/JGProgressHUDRingIndicatorView.h b/JGProgressHUD/JGProgressHUD/JGProgressHUDRingIndicatorView.h
@@ -16,9 +16,6 @@
  */
 - (instancetype)initWithHUDStyle:(JGProgressHUDStyle)style;
 
-
-
-
 /**
  Background color of the ring.