From e3d44f370916402c2d49b1cf8385d1bc96478d89 Mon Sep 17 00:00:00 2001
From: Andreas Linde <mail@andreaslinde.de>
Date: Tue, 17 Sep 2013 20:08:11 +0200
Subject: [PATCH] Some more documentation improvements

---
 Classes/BITAuthenticator.h      | 4 ++++
 Classes/BITCrashManager.h       | 1 +
 Classes/BITFeedbackManager.h    | 2 ++
 Classes/BITStoreUpdateManager.h | 8 +++++---
 Classes/BITUpdateManager.h      | 1 +
 5 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/Classes/BITAuthenticator.h b/Classes/BITAuthenticator.h
index e61a2ab0c9..1801a993ca 100644
--- a/Classes/BITAuthenticator.h
+++ b/Classes/BITAuthenticator.h
@@ -122,6 +122,8 @@ typedef void(^tValidationCompletion)(BOOL validated, NSError *error);
  *    3. `BITAuthenticatorAuthTypeUDIDProvider`: authenticate the device via its UDID (_Default_)
  *
  * _Default_: `BITAuthenticatorAuthTypeUDIDProvider`
+ *
+ * @see BITAuthenticatorAuthType
  */
 @property (nonatomic, assign) BITAuthenticatorAuthType authenticationType;
 
@@ -136,6 +138,8 @@ typedef void(^tValidationCompletion)(BOOL validated, NSError *error);
  *    4. `BITAuthenticatorValidationTypeOnAppActive`: every time the app becomes active (needs internet connection)
  *
  * _Default_: `BITAuthenticatorValidationTypeNever`
+ *
+ * @see BITAuthenticatorValidationType
  */
 @property (nonatomic, assign) BITAuthenticatorValidationType validationType;
 
diff --git a/Classes/BITCrashManager.h b/Classes/BITCrashManager.h
index e74a200b34..93e933d1da 100644
--- a/Classes/BITCrashManager.h
+++ b/Classes/BITCrashManager.h
@@ -124,6 +124,7 @@ typedef NS_ENUM(NSUInteger, BITCrashManagerStatus) {
  have to make sure the new value is stored in the UserDefaults with the key
  `BITCrashManagerStatus`.
  
+ @see BITCrashManagerStatus
  @see showAlwaysButton
  */
 @property (nonatomic, assign) BITCrashManagerStatus crashManagerStatus;
diff --git a/Classes/BITFeedbackManager.h b/Classes/BITFeedbackManager.h
index a88bec4007..745b7a70be 100644
--- a/Classes/BITFeedbackManager.h
+++ b/Classes/BITFeedbackManager.h
@@ -138,6 +138,7 @@ typedef NS_ENUM(NSInteger, BITFeedbackUserDataElement) {
  `[BITHockeyManagerDelegate userNameForHockeyManager:componentManager:]` then this
  property will automatically be set to `BITFeedbackUserDataElementDontShow`
 
+ @see BITFeedbackUserDataElement
  @see requireUserEmail
  @see `[BITHockeyManagerDelegate userNameForHockeyManager:componentManager:]`
  */
@@ -160,6 +161,7 @@ typedef NS_ENUM(NSInteger, BITFeedbackUserDataElement) {
  `[BITHockeyManagerDelegate userEmailForHockeyManager:componentManager:]` then this
  property will automatically be set to `BITFeedbackUserDataElementDontShow`
  
+ @see BITFeedbackUserDataElement
  @see requireUserName
  @see `[BITHockeyManagerDelegate userEmailForHockeyManager:componentManager:]`
  */
diff --git a/Classes/BITStoreUpdateManager.h b/Classes/BITStoreUpdateManager.h
index 684a160bdd..038043db49 100644
--- a/Classes/BITStoreUpdateManager.h
+++ b/Classes/BITStoreUpdateManager.h
@@ -61,7 +61,10 @@ typedef NS_ENUM(NSInteger, BITStoreUpdateSetting) {
  This module automatically disables itself when **NOT** running in an App Store build by default!
  
  When an update is detected, it will open the apps page in the app store app.
-  
+ 
+ @warning This module can **NOT** check if the current device and OS version match the minimum requirements of
+ the new app version!
+ 
  */
 
 @interface BITStoreUpdateManager : BITHockeyBaseManager
@@ -80,8 +83,6 @@ typedef NS_ENUM(NSInteger, BITStoreUpdateSetting) {
 /// @name Update Checking
 ///-----------------------------------------------------------------------------
 
-// see BITHockeyStoreUpdateSetting-enum. Will be saved in user defaults.
-// default value: BITStoreUpdateCheckDaily
 /**
  When to check for new updates.
  
@@ -98,6 +99,7 @@ typedef NS_ENUM(NSInteger, BITStoreUpdateSetting) {
  invoke the update checking process yourself with `checkForUpdate` somehow, e.g. by
  proving an update check button for the user or integrating the Update View into your
  user interface.
+ @see BITStoreUpdateSetting
  @see countryCode
  @see checkForUpdateOnLaunch
  @see checkForUpdate
diff --git a/Classes/BITUpdateManager.h b/Classes/BITUpdateManager.h
index fbcf26265f..70f44da1a2 100644
--- a/Classes/BITUpdateManager.h
+++ b/Classes/BITUpdateManager.h
@@ -104,6 +104,7 @@ typedef NS_ENUM (NSUInteger, BITUpdateSetting) {
  invoke the update checking process yourself with `checkForUpdate` somehow, e.g. by
  proving an update check button for the user or integrating the Update View into your
  user interface.
+ @see BITUpdateSetting
  @see checkForUpdateOnLaunch
  @see checkForUpdate
  */