aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firebase/Messaging/Public
diff options
context:
space:
mode:
authorGravatar Riz <rsattar@gmail.com>2017-06-02 14:03:17 -0700
committerGravatar GitHub <noreply@github.com>2017-06-02 14:03:17 -0700
commitbc4667ff58c5a2a433f8454fde6744401ed46eb0 (patch)
treec58baad62cf531a2ecf41b4781ecc04cd5b67aca /Firebase/Messaging/Public
parent23e3cf6e2f3e92156a4ab196aebceb446c4ac1c7 (diff)
Fix formatting inconsistencies in Messaging header (#61)
The header comments are directly reflected in Firebase documentation, so this improves that as well.
Diffstat (limited to 'Firebase/Messaging/Public')
-rw-r--r--Firebase/Messaging/Public/FIRMessaging.h27
1 files changed, 14 insertions, 13 deletions
diff --git a/Firebase/Messaging/Public/FIRMessaging.h b/Firebase/Messaging/Public/FIRMessaging.h
index 84d2526..409b562 100644
--- a/Firebase/Messaging/Public/FIRMessaging.h
+++ b/Firebase/Messaging/Public/FIRMessaging.h
@@ -295,15 +295,15 @@ FIR_SWIFT_NAME(Messaging)
__deprecated_msg("Use 'delegate' property");
/**
- * When set to YES, Firebase Messaging will automatically establish a socket-based, direct channel
- * to the FCM server. You only need to enable this if you are sending upstream messages or
+ * When set to `YES`, Firebase Messaging will automatically establish a socket-based, direct
+ * channel to the FCM server. Enable this only if you are sending upstream messages or
* receiving non-APNS, data-only messages in foregrounded apps.
- * Default is NO.
+ * Default is `NO`.
*/
@property(nonatomic) BOOL shouldEstablishDirectChannel;
/**
- * Returns YES if the direct channel to the FCM server is active, NO otherwise.
+ * Returns `YES` if the direct channel to the FCM server is active, and `NO` otherwise.
*/
@property(nonatomic, readonly) BOOL isDirectChannelEstablished;
@@ -324,14 +324,15 @@ FIR_SWIFT_NAME(Messaging)
/**
* This property is used to set the APNS Token received by the application delegate.
*
- * FIRMessaging uses method swizzling to ensure the APNS token is set automatically.
- * However, if you have disabled swizzling by setting `FirebaseAppDelegateProxyEnabled`
- * to `NO` in your app's Info.plist, you should manually set the APNS token in your
- * application delegate's -application:didRegisterForRemoteNotificationsWithDeviceToken:
+ * FIRMessaging uses method swizzling to ensure that the APNS token is set
+ * automatically. However, if you have disabled swizzling by setting
+ * `FirebaseAppDelegateProxyEnabled` to `NO` in your app's
+ * Info.plist, you should manually set the APNS token in your application
+ * delegate's `-application:didRegisterForRemoteNotificationsWithDeviceToken:`
* method.
*
- * If you would like to set the type of the APNS token, rather than relying on automatic
- * detection, see: -setAPNSToken:type:.
+ * If you would like to set the type of the APNS token, rather than relying on
+ * automatic detection, see: `-setAPNSToken:type:`.
*/
@property(nonatomic, copy, nullable) NSData *APNSToken FIR_SWIFT_NAME(apnsToken);
@@ -416,7 +417,7 @@ FIR_SWIFT_NAME(Messaging)
* connect to FIRMessaging. Calling this on an already disconnected client is a no-op.
*
* Call this before `teardown` when your app is going to the background.
- * Since the FIRMessaging connection won't be allowed to live when in background it is
+ * Since the FIRMessaging connection won't be allowed to live when in the background, it is
* prudent to close the connection.
*/
- (void)disconnect
@@ -474,8 +475,8 @@ FIR_SWIFT_NAME(Messaging)
* Use this to track message delivery and analytics for messages, typically
* when you receive a notification in `application:didReceiveRemoteNotification:`.
* However, you only need to call this if you set the `FirebaseAppDelegateProxyEnabled`
- * flag to NO in your Info.plist. If `FirebaseAppDelegateProxyEnabled` is either missing
- * or set to YES in your Info.plist, the library will call this automatically.
+ * flag to `NO` in your Info.plist. If `FirebaseAppDelegateProxyEnabled` is either missing
+ * or set to `YES` in your Info.plist, the library will call this automatically.
*
* @param message The downstream message received by the application.
*