Documentation updates and fixes

This commit is contained in:
Andreas Linde
2015-06-19 15:29:42 +02:00
parent 5681b7791f
commit ea91c0722c
7 changed files with 21 additions and 6 deletions

View File

@@ -32,7 +32,8 @@ This document contains the following sections:
5. [Crash Reporting](#crashreporting)
6. [Feedback](#feedback)
7. [Store Updates](#storeupdates)
3. [In-App-Updates (Beta & Enterprise only)](#betaupdates)
8. [In-App-Updates (Beta & Enterprise only)](#betaupdates)
9. [Debug information](#debug)
4. [Documentation](#documentation)
5. [Contributing](#contributing)
6. [Contact](#contact)
@@ -104,7 +105,7 @@ From our experience, 3rd-party libraries usually reside inside a subdirectory (l
3. Search for the method
```swift
application(application: UIApplication, didFinishLaunchingWithOptions launchOptions:[NSObject: AnyObject]?) -> Bool`
application(application: UIApplication, didFinishLaunchingWithOptions launchOptions:[NSObject: AnyObject]?) -> Bool
```
4. Add the following lines to setup and start the Application Insights SDK:
@@ -351,6 +352,8 @@ The `BITHockeyManagerDelegate` protocol provides methods to add additional data
The `BITCrashManagerDelegate` protocol (which is automatically included in `BITHockeyManagerDelegate`) provides methods to add more crash specific data to a crash report:
1. Text attachments: `-(NSString *)applicationLogForCrashManager:(BITCrashManager *)crashManager`
Check the following tutorial for an example on how to add CocoaLumberjack log data: [How to Add Application Specific Log Data on iOS or OS X](http://support.hockeyapp.net/kb/client-integration-ios-mac-os-x/how-to-add-application-specific-log-data-on-ios-or-os-x)
2. Binary attachments: `-(BITHockeyAttachment *)attachmentForCrashManager:(BITCrashManager *)crashManager`
Make sure to implement the protocol
@@ -427,6 +430,19 @@ This feature can be disabled manually as follows:
If you want to see beta analytics, use the beta distribution feature with in-app updates, restrict versions to specific users, or want to know who is actually testing your app, you need to follow the instructions on our guide [Authenticating Users on iOS](http://support.hockeyapp.net/kb/client-integration-ios-mac-os-x/authenticating-users-on-ios)
<a id="debug"></a>
### 3.9 Debug information
To check if data is send properly to HockeyApp and also see some additional SDK debug log data in the console, add the following line before `startManager`:
```objectivec
[[BITHockeyManager sharedHockeyManager] configureWithIdentifier:@"APP_IDENTIFIER"];
[[BITHockeyManager sharedHockeyManager] setDebugLogEnabled:YES];
[[BITHockeyManager sharedHockeyManager] startManager];
```
<a id="documentation"></a>
## 4. Documentation

Binary file not shown.

Before

Width:  |  Height:  |  Size: 239 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 124 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 69 KiB

View File

@@ -15,7 +15,7 @@ The main SDK class is `BITHockeyManager`. It initializes all modules and provide
## Prerequisites
1. Before you integrate HockeySDK into your own app, you should add the app to HockeyApp if you haven't already. Read [this how-to](http://support.hockeyapp.net/kb/how-tos/how-to-create-a-new-app) on how to do it.
2. We also assume that you already have a project in Xcode and that this project is opened in Xcode 5.
2. We also assume that you already have a project in Xcode and that this project is opened in Xcode 6.
3. The SDK supports iOS 6.0 or newer.
## Release Notes
@@ -25,16 +25,15 @@ The main SDK class is `BITHockeyManager`. It initializes all modules and provide
## Guides
- [Installation & Setup](Guide-Installation-Setup)
- [Installation & Setup Advanced](Guide-Installation-Setup-Advanced) (Using Git submodule and Xcode sub-project)
- [Identify and authenticate users of Ad-Hoc or Enterprise builds](HowTo-Authenticating-Users-on-iOS)
- [Migration from previous SDK Versions](Guide-Migration-Kits)
- [Mac Desktop Uploader](http://support.hockeyapp.net/kb/services-webhooks-desktop-apps/how-to-upload-to-hockeyapp-on-a-mac)
## HowTos
- [How to do app versioning](HowTo-App-Versioning)
- [How to upload symbols for crash reporting](HowTo-Upload-Symbols)
- [How to handle crashes on startup](http://support.hockeyapp.net/kb/client-integration-ios-mac-os-x/how-to-handle-crashes-during-startup-on-ios)
- [How to add application specific log data](http://support.hockeyapp.net/kb/client-integration-ios-mac-os-x/how-to-add-application-specific-log-data-on-ios)
- [How to add application specific log data](http://support.hockeyapp.net/kb/client-integration-ios-mac-os-x/how-to-add-application-specific-log-data-on-ios-or-osx)
- [How to ask the user for more details about a crash](HowTo-Set-Custom-AlertViewHandler)
## Troubleshooting