Skip to content

Commit bc4667f

Browse files
authored
Fix formatting inconsistencies in Messaging header (#61)
The header comments are directly reflected in Firebase documentation, so this improves that as well.
1 parent 23e3cf6 commit bc4667f

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

Firebase/Messaging/Public/FIRMessaging.h

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -295,15 +295,15 @@ FIR_SWIFT_NAME(Messaging)
295295
__deprecated_msg("Use 'delegate' property");
296296

297297
/**
298-
* When set to YES, Firebase Messaging will automatically establish a socket-based, direct channel
299-
* to the FCM server. You only need to enable this if you are sending upstream messages or
298+
* When set to `YES`, Firebase Messaging will automatically establish a socket-based, direct
299+
* channel to the FCM server. Enable this only if you are sending upstream messages or
300300
* receiving non-APNS, data-only messages in foregrounded apps.
301-
* Default is NO.
301+
* Default is `NO`.
302302
*/
303303
@property(nonatomic) BOOL shouldEstablishDirectChannel;
304304

305305
/**
306-
* Returns YES if the direct channel to the FCM server is active, NO otherwise.
306+
* Returns `YES` if the direct channel to the FCM server is active, and `NO` otherwise.
307307
*/
308308
@property(nonatomic, readonly) BOOL isDirectChannelEstablished;
309309

@@ -324,14 +324,15 @@ FIR_SWIFT_NAME(Messaging)
324324
/**
325325
* This property is used to set the APNS Token received by the application delegate.
326326
*
327-
* FIRMessaging uses method swizzling to ensure the APNS token is set automatically.
328-
* However, if you have disabled swizzling by setting `FirebaseAppDelegateProxyEnabled`
329-
* to `NO` in your app's Info.plist, you should manually set the APNS token in your
330-
* application delegate's -application:didRegisterForRemoteNotificationsWithDeviceToken:
327+
* FIRMessaging uses method swizzling to ensure that the APNS token is set
328+
* automatically. However, if you have disabled swizzling by setting
329+
* `FirebaseAppDelegateProxyEnabled` to `NO` in your app's
330+
* Info.plist, you should manually set the APNS token in your application
331+
* delegate's `-application:didRegisterForRemoteNotificationsWithDeviceToken:`
331332
* method.
332333
*
333-
* If you would like to set the type of the APNS token, rather than relying on automatic
334-
* detection, see: -setAPNSToken:type:.
334+
* If you would like to set the type of the APNS token, rather than relying on
335+
* automatic detection, see: `-setAPNSToken:type:`.
335336
*/
336337
@property(nonatomic, copy, nullable) NSData *APNSToken FIR_SWIFT_NAME(apnsToken);
337338

@@ -416,7 +417,7 @@ FIR_SWIFT_NAME(Messaging)
416417
* connect to FIRMessaging. Calling this on an already disconnected client is a no-op.
417418
*
418419
* Call this before `teardown` when your app is going to the background.
419-
* Since the FIRMessaging connection won't be allowed to live when in background it is
420+
* Since the FIRMessaging connection won't be allowed to live when in the background, it is
420421
* prudent to close the connection.
421422
*/
422423
- (void)disconnect
@@ -474,8 +475,8 @@ FIR_SWIFT_NAME(Messaging)
474475
* Use this to track message delivery and analytics for messages, typically
475476
* when you receive a notification in `application:didReceiveRemoteNotification:`.
476477
* However, you only need to call this if you set the `FirebaseAppDelegateProxyEnabled`
477-
* flag to NO in your Info.plist. If `FirebaseAppDelegateProxyEnabled` is either missing
478-
* or set to YES in your Info.plist, the library will call this automatically.
478+
* flag to `NO` in your Info.plist. If `FirebaseAppDelegateProxyEnabled` is either missing
479+
* or set to `YES` in your Info.plist, the library will call this automatically.
479480
*
480481
* @param message The downstream message received by the application.
481482
*

0 commit comments

Comments
 (0)