More documentation improvements

Classes/BITHockeyManager.h

@@ -417,7 +417,10 @@
  This property is optional and can be used as an alternative to the delegate. If you
  want to define specific data for each component, use the delegate instead which does
  overwrite the values set by this property.
- 
+
+ @warning When returning a non nil value, crash reports are not anonymous any more
+ and the crash alerts will not show the word "anonymous"!
+
  @see userID
  @see userEmail
  @see `[BITHockeyManagerDelegate userNameForHockeyManager:componentManager:]`
@@ -437,6 +440,9 @@
  want to define specific data for each component, use the delegate instead which does
  overwrite the values set by this property.
  
+ @warning When returning a non nil value, crash reports are not anonymous any more
+ and the crash alerts will not show the word "anonymous"!
+
  @see userID
  @see userName
  @see `[BITHockeyManagerDelegate userEmailForHockeyManager:componentManager:]`

Classes/BITHockeyManagerDelegate.h

@@ -76,21 +76,22 @@
 ///-----------------------------------------------------------------------------
 
 /**
- * Implement to force the usage of the live identifier
- *
- * This is useful if you are e.g. distributing an enterprise app inside your company
- * and want to use the `liveIdentifier` for that even though it is not running from
- * the App Store.
- *
- * Example:
- *    - (BOOL)shouldUseLiveIdentifierForHockeyManager:(BITHockeyManager *)hockeyManager {
- *    #ifdef (CONFIGURATION_AppStore)
- *      return YES;
- *    #endif
- *      return NO;
- *    }
- *
- * @param hockeyManager BITHockeyManager instance
+ Implement to force the usage of the live identifier
+ 
+ This is useful if you are e.g. distributing an enterprise app inside your company
+ and want to use the `liveIdentifier` for that even though it is not running from
+ the App Store.
+ 
+ Example:
+ 
+     - (BOOL)shouldUseLiveIdentifierForHockeyManager:(BITHockeyManager *)hockeyManager {
+     #ifdef (CONFIGURATION_AppStore)
+       return YES;
+     #endif
+       return NO;
+     }
+ 
+ @param hockeyManager BITHockeyManager instance
  */
 - (BOOL)shouldUseLiveIdentifierForHockeyManager:(BITHockeyManager *)hockeyManager;
 
@@ -128,6 +129,7 @@
  not be asked for any user details by the component, including useerName or userEmail.
  
  You can find out the component requesting the userID like this:
+ 
     - (NSString *)userIDForHockeyManager:(BITHockeyManager *)hockeyManager componentManager:(BITHockeyBaseManager *)componentManager {
       if (componentManager == hockeyManager.feedbackManager) {
         return UserIDForFeedback;
@@ -138,14 +140,18 @@
       }
     }
  
+ For crash reports, this delegate is invoked on the startup after the crash!
  
+ Alternatively you can also use `[BITHockeyManager userID]` which will cache the value in the keychain.
+
+ @warning When returning a non nil value for the `BITCrashManager` component, crash reports
+ are not anonymous any more and the crash alerts will not show the word "anonymous"!
  
  @param hockeyManager The `BITHockeyManager` HockeyManager instance invoking this delegate
  @param componentManager The `BITHockeyBaseManager` component instance invoking this delegate, can be `BITCrashManager` or `BITFeedbackManager`
  @see userNameForHockeyManager:componentManager:
  @see userEmailForHockeyManager:componentManager:
- @warning When returning a non nil value for the `BITCrashManager` component, crash reports
- are not anonymous any more and the crash alerts will not show the word "anonymous"!
+ @see [BITHockeyManager userID]
  */
 - (NSString *)userIDForHockeyManager:(BITHockeyManager *)hockeyManager componentManager:(BITHockeyBaseManager *)componentManager;
 
@@ -159,6 +165,7 @@
  not be asked for any user details by the component, including useerName or userEmail.
  
  You can find out the component requesting the user name like this:
+ 
     - (NSString *)userNameForHockeyManager:(BITHockeyManager *)hockeyManager componentManager:(BITHockeyBaseManager *)componentManager {
       if (componentManager == hockeyManager.feedbackManager) {
         return UserNameForFeedback;
@@ -169,13 +176,18 @@
       }
  }
 
+ For crash reports, this delegate is invoked on the startup after the crash!
  
+ Alternatively you can also use `[BITHockeyManager userName]` which will cache the value in the keychain.
+ 
+ @warning When returning a non nil value for the `BITCrashManager` component, crash reports
+ are not anonymous any more and the crash alerts will not show the word "anonymous"!
+
  @param hockeyManager The `BITHockeyManager` HockeyManager instance invoking this delegate
  @param componentManager The `BITHockeyBaseManager` component instance invoking this delegate, can be `BITCrashManager` or `BITFeedbackManager`
  @see userIDForHockeyManager:componentManager:
  @see userEmailForHockeyManager:componentManager:
- @warning When returning a non nil value for the `BITCrashManager` component, crash reports
- are not anonymous any more and the crash alerts will not show the word "anonymous"!
+ @see [BITHockeyManager userName]
  */
 - (NSString *)userNameForHockeyManager:(BITHockeyManager *)hockeyManager componentManager:(BITHockeyBaseManager *)componentManager;
 
@@ -189,6 +201,7 @@
  not be asked for any user details by the component, including useerName or userEmail.
  
  You can find out the component requesting the user email like this:
+ 
     - (NSString *)userEmailForHockeyManager:(BITHockeyManager *)hockeyManager componentManager:(BITHockeyBaseManager *)componentManager {
       if (componentManager == hockeyManager.feedbackManager) {
         return UserEmailForFeedback;
@@ -199,13 +212,18 @@
        }
     }
  
+ For crash reports, this delegate is invoked on the startup after the crash!
  
+ Alternatively you can also use `[BITHockeyManager userEmail]` which will cache the value in the keychain.
+ 
+ @warning When returning a non nil value for the `BITCrashManager` component, crash reports
+ are not anonymous any more and the crash alerts will not show the word "anonymous"!
+
  @param hockeyManager The `BITHockeyManager` HockeyManager instance invoking this delegate
  @param componentManager The `BITHockeyBaseManager` component instance invoking this delegate, can be `BITCrashManager` or `BITFeedbackManager`
  @see userIDForHockeyManager:componentManager:
  @see userNameForHockeyManager:componentManager:
- @warning When returning a non nil value for the `BITCrashManager` component, crash reports
- are not anonymous any more and the crash alerts will not show the word "anonymous"!
+ @see [BITHockeyManager userEmail]
  */
 - (NSString *)userEmailForHockeyManager:(BITHockeyManager *)hockeyManager componentManager:(BITHockeyBaseManager *)componentManager;