From f8561afacc4e47a00ceccee2f9d29908674386e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lukas=20Spie=C3=9F?= Date: Thu, 24 Apr 2014 16:11:05 +0200 Subject: [PATCH] Updates documentation --- Classes/BITCrashManager.h | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/Classes/BITCrashManager.h b/Classes/BITCrashManager.h index 476145969d..3afe47092b 100644 --- a/Classes/BITCrashManager.h +++ b/Classes/BITCrashManager.h @@ -260,16 +260,19 @@ typedef NS_ENUM(NSUInteger, BITCrashManagerUserInput) { /** Provides an interface to handle user input from a custom alert - On this input depends, whether crash reports are sent, always sent or not sent and deleted. + @param userInput On this input depends, whether crash reports are sent, always sent or not sent and deleted. + @param metaDescription The content of this string will be attached to the crash report as the description and allows to ask the user for e.g. additional comments or info - @return BOOl if the input is a valid option + @return Returns YES if the input is a valid option and successfully triggered further processing of the crash report @see BITCrashManagerUserInput */ - (BOOL)handleUserInput:(BITCrashManagerUserInput)userInput withUserProvidedCrashDescription:(NSString*)metaDescription; /** Property that lets you set a custom block which handles showing a custom UI and asking the user - whether he wants to send the crash report. Needs to call the `handleUserInput` method. + whether he wants to send the crash report. + + @warning Needs to call the `handleUserInput` method! */ @property (nonatomic, copy, setter = setAlertViewHandler:) customAlertViewHandler alertViewHandler;