Remove the @abstract and @discussion tags from the docs since the…

…es don't render at all

Summary: Also replaced `see` with See since that also doesn't render in any special way

Reviewed By: samodom

Differential Revision: D34120684

fbshipit-source-id: 5d026f45c2d7389528849d68dbb8a5ad072e73bd

FBSDKCoreKit/FBSDKCoreKit/include/FBSDKGraphRequest.h

@@ -32,7 +32,7 @@ NS_ASSUME_NONNULL_BEGIN
  By default, FBSDKGraphRequest will attempt to recover any errors returned from
  Facebook. You can disable this via `disableErrorRecovery:`.
 
- @see FBSDKGraphErrorRecoveryProcessor
+ See FBSDKGraphErrorRecoveryProcessor
  */
 NS_SWIFT_NAME(GraphRequest)
 @interface FBSDKGraphRequest : NSObject <FBSDKGraphRequest>

FBSDKLoginKit/FBSDKLoginKit/FBSDKDeviceLoginCodeInfo.h

@@ -11,40 +11,40 @@
 NS_ASSUME_NONNULL_BEGIN
 
 /**
- @abstract Describes the initial response when starting the device login flow.
- @discussion This is used by `FBSDKDeviceLoginManager`.
+ Describes the initial response when starting the device login flow.
+ This is used by `FBSDKDeviceLoginManager`.
  */
 NS_SWIFT_NAME(DeviceLoginCodeInfo)
 @interface FBSDKDeviceLoginCodeInfo : NSObject
 
 /**
- @abstract There is no public initializer.
+ There is no public initializer.
  */
 - (instancetype)init NS_UNAVAILABLE;
 + (instancetype)new NS_UNAVAILABLE;
 
 /**
- @abstract the unique id for this login flow.
+ The unique id for this login flow.
  */
 @property (nonatomic, readonly, copy) NSString *identifier;
 
 /**
- @abstract the short "user_code" that should be presented to the user.
+ The short "user_code" that should be presented to the user.
  */
 @property (nonatomic, readonly, copy) NSString *loginCode;
 
 /**
- @abstract the verification URL.
+ The verification URL.
  */
 @property (nonatomic, readonly, copy) NSURL *verificationURL;
 
 /**
- @abstract the expiration date.
+ The expiration date.
  */
 @property (nonatomic, readonly, copy) NSDate *expirationDate;
 
 /**
- @abstract the polling interval
+ The polling interval
  */
 @property (nonatomic, readonly, assign) NSUInteger pollingInterval;
 

FBSDKLoginKit/FBSDKLoginKit/FBSDKDeviceLoginManager.h

@@ -16,8 +16,8 @@ NS_ASSUME_NONNULL_BEGIN
 @protocol FBSDKDeviceLoginManagerDelegate;
 
 /**
- @abstract Use this class to perform a device login flow.
- @discussion The device login flow starts by requesting a code from the device login API.
+ Use this class to perform a device login flow.
+ The device login flow starts by requesting a code from the device login API.
    This class informs the delegate when this code is received. You should then present the
    code to the user to enter. In the meantime, this class polls the device login API
    periodically and informs the delegate of the results.
@@ -28,7 +28,7 @@ NS_SWIFT_NAME(DeviceLoginManager)
 @interface FBSDKDeviceLoginManager : NSObject <NSNetServiceDelegate>
 
 /**
- @abstract Initializes a new instance.
+ Initializes a new instance.
  @param permissions permissions to request.
  */
 - (instancetype)initWithPermissions:(NSArray<NSString *> *)permissions
@@ -38,29 +38,29 @@ NS_SWIFT_NAME(DeviceLoginManager)
 + (instancetype)new NS_UNAVAILABLE;
 
 /**
- @abstract the delegate.
+ The delegate.
  */
 @property (nonatomic, weak) id<FBSDKDeviceLoginManagerDelegate> delegate;
 
 /**
- @abstract the requested permissions.
+ The requested permissions.
  */
 @property (nonatomic, readonly, copy) NSArray<NSString *> *permissions;
 
 /**
- @abstract the optional URL to redirect the user to after they complete the login.
- @discussion the URL must be configured in your App Settings -> Advanced -> OAuth Redirect URIs
+ The optional URL to redirect the user to after they complete the login.
+ The URL must be configured in your App Settings -> Advanced -> OAuth Redirect URIs
  */
 @property (nullable, nonatomic, copy) NSURL *redirectURL;
 
 /**
- @abstract Starts the device login flow
- @discussion This instance will retain self until the flow is finished or cancelled.
+ Starts the device login flow
+ This instance will retain self until the flow is finished or cancelled.
  */
 - (void)start;
 
 /**
- @abstract Attempts to cancel the device login flow.
+ Attempts to cancel the device login flow.
  */
 - (void)cancel;
 

FBSDKLoginKit/FBSDKLoginKit/FBSDKDeviceLoginManagerDelegate.h

@@ -9,13 +9,13 @@
 NS_ASSUME_NONNULL_BEGIN
 
 /**
- @abstract A delegate for `FBSDKDeviceLoginManager`.
+ A delegate for `FBSDKDeviceLoginManager`.
  */
 NS_SWIFT_NAME(DeviceLoginManagerDelegate)
 @protocol FBSDKDeviceLoginManagerDelegate <NSObject>
 
 /**
- @abstract Indicates the device login flow has started. You should parse `codeInfo` to present the code to the user to enter.
+ Indicates the device login flow has started. You should parse `codeInfo` to present the code to the user to enter.
  @param loginManager the login manager instance.
  @param codeInfo the code info data.
  */
@@ -24,11 +24,11 @@ NS_SWIFT_NAME(DeviceLoginManagerDelegate)
        startedWithCodeInfo:(FBSDKDeviceLoginCodeInfo *)codeInfo;
 
 /**
- @abstract Indicates the device login flow has finished.
+ Indicates the device login flow has finished.
  @param loginManager the login manager instance.
  @param result the results of the login flow.
  @param error the error, if available.
- @discussion The flow can be finished if the user completed the flow, cancelled, or if the code has expired.
+ The flow can be finished if the user completed the flow, cancelled, or if the code has expired.
  */
 - (void)deviceLoginManager:(FBSDKDeviceLoginManager *)loginManager
        completedWithResult:(nullable FBSDKDeviceLoginManagerResult *)result

FBSDKLoginKit/FBSDKLoginKit/FBSDKDeviceLoginManagerResult.h

@@ -13,25 +13,25 @@
 NS_ASSUME_NONNULL_BEGIN
 
 /**
- @abstract Represents the results of the a device login flow.
- @discussion This is used by `FBSDKDeviceLoginManager`.
+ Represents the results of the a device login flow.
+ This is used by `FBSDKDeviceLoginManager`.
  */
 NS_SWIFT_NAME(DeviceLoginManagerResult)
 @interface FBSDKDeviceLoginManagerResult : NSObject
 
 /**
- @abstract There is no public initializer.
+ There is no public initializer.
  */
 - (instancetype)init NS_UNAVAILABLE;
 + (instancetype)new NS_UNAVAILABLE;
 
 /**
- @abstract The token.
+ The token.
  */
 @property (nullable, nonatomic, readonly, strong) FBSDKAccessToken *accessToken;
 
 /**
- @abstract Indicates if the login was cancelled by the user, or if the device
+ Indicates if the login was cancelled by the user, or if the device
   login code has expired.
  */
 @property (nonatomic, readonly, getter = isCancelled, assign) BOOL cancelled;

FBSDKLoginKit/FBSDKLoginKit/FBSDKLoginButton.h

@@ -69,8 +69,8 @@ NS_SWIFT_NAME(FBLoginButton)
  */
 @property (nonatomic, weak) IBOutlet id<FBSDKLoginButtonDelegate> delegate;
 /**
- @abstract The permissions to request.
- @discussion To provide the best experience, you should minimize the number of permissions you request, and only ask for them when needed.
+ The permissions to request.
+ To provide the best experience, you should minimize the number of permissions you request, and only ask for them when needed.
  For example, do not ask for "user_location" until you the information is actually used by the app.
 
  Note this is converted to NSSet and is only

FBSDKLoginKit/FBSDKLoginKit/FBSDKTooltipView.h

@@ -81,7 +81,7 @@ NS_SWIFT_NAME(FBTooltipView)
 
  If you need to show a tooltip for login, consider using the `FBSDKLoginTooltipView` view.
 
- @see FBSDKLoginTooltipView
+ See FBSDKLoginTooltipView
  */
 - (instancetype)initWithTagline:(nullable NSString *)tagline
                         message:(nullable NSString *)message

FBSDKLoginKit/FBSDKLoginKit/Internal/FBSDKDeviceLoginCodeInfo+Internal.h

@@ -16,7 +16,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 // UNCRUSTIFY_FORMAT_OFF
 /**
- @abstract Initializes a new instance
+ Initializes a new instance
  @param identifier the unique id for this login flow instance.
  @param loginCode the short "user_code".
  @param verificationURL the verification URL.

FBSDKLoginKit/FBSDKLoginKit/Internal/FBSDKDeviceLoginManagerResult+Internal.h

@@ -21,7 +21,7 @@ NS_ASSUME_NONNULL_BEGIN
 @interface FBSDKDeviceLoginManagerResult ()
 
 /**
- @abstract Initializes a new instance
+ Initializes a new instance
  @param token The token
  @param cancelled Indicates if the flow was cancelled.
  */

FBSDKShareKit/FBSDKShareKit/MessageDialog.swift

@@ -116,7 +116,7 @@ public final class MessageDialog: NSObject, SharingDialog {
    required but not available.  This method does not validate the content on the receiver, so this can be checked before
    building up the content.
 
-   @see `Sharing.validate()`
+   See `Sharing.validate()`
    @return `true` if the receiver can share, otherwise `false`.
    */
   public var canShow: Bool { canShowNative }

FBSDKShareKit/FBSDKShareKit/Sharing.swift

@@ -13,7 +13,7 @@ import Foundation
 /**
  The common interface for components that initiate sharing.
 
- @see ShareDialog, MessageDialog
+ See ShareDialog, MessageDialog
  */
 @objc(FBSDKSharing)
 public protocol Sharing {

FBSDKShareKit/FBSDKShareKit/SharingDialog.swift

@@ -21,7 +21,7 @@ public protocol SharingDialog: Sharing {
    required but not available.  This method does not validate the content on the receiver, so this can be checked before
    building up the content.
 
-   @see `Sharing.validate(error:)`
+   See `Sharing.validate(error:)`
    @return `true` if the receiver can share, otherwise `false`.
    */
   var canShow: Bool { get }

FBSDKTVOSKit/FBSDKTVOSKit/FBSDKDeviceLoginButton.h

@@ -15,8 +15,8 @@ NS_ASSUME_NONNULL_BEGIN
 @protocol FBSDKDeviceLoginButtonDelegate;
 
 /**
- @abstract A button that initiates a log in or log out flow upon tapping.
- @discussion `FBSDKLoginButton` works with `[FBSDKAccessToken currentAccessToken]` to
+ A button that initiates a log in or log out flow upon tapping.
+ `FBSDKLoginButton` works with `[FBSDKAccessToken currentAccessToken]` to
  determine what to display, and automatically starts authentication (by presenting
  `FBSDKDeviceLoginViewController`) when tapped (i.e., you do not need to manually
  subscribe action targets).
@@ -28,13 +28,13 @@ NS_SWIFT_NAME(FBDeviceLoginButton)
 @interface FBSDKDeviceLoginButton : FBSDKDeviceButton
 
 /**
- @abstract Gets or sets the delegate.
+ Gets or sets the delegate.
  */
 @property (nullable, nonatomic, weak) IBOutlet id<FBSDKDeviceLoginButtonDelegate> delegate;
 
 /**
- @abstract The permissions to request.
- @discussion To provide the best experience, you should minimize the number of permissions you request, and only ask for them when needed.
+ The permissions to request.
+ To provide the best experience, you should minimize the number of permissions you request, and only ask for them when needed.
  For example, do not ask for "user_location" until you the information is actually used by the app.
 
  Note this is converted to NSSet and is only
@@ -45,27 +45,27 @@ NS_SWIFT_NAME(FBDeviceLoginButton)
 @property (nonatomic, copy) NSArray<NSString *> *permissions;
 
 /**
- @abstract the optional URL to redirect the user to after they complete the login.
- @discussion the URL must be configured in your App Settings -> Advanced -> OAuth Redirect URIs
+ The optional URL to redirect the user to after they complete the login.
+ The URL must be configured in your App Settings -> Advanced -> OAuth Redirect URIs
  */
 @property (nullable, nonatomic, copy) NSURL *redirectURL;
 
 @end
 
 /**
  @protocol
- @abstract A delegate protocol for `FBSDKDeviceLoginButton`
+ A delegate protocol for `FBSDKDeviceLoginButton`
  */
 NS_SWIFT_NAME(DeviceLoginButtonDelegate)
 @protocol FBSDKDeviceLoginButtonDelegate <NSObject>
 
 /**
- @abstract Indicates the login was cancelled or timed out.
+ Indicates the login was cancelled or timed out.
  */
 - (void)deviceLoginButtonDidCancel:(FBSDKDeviceLoginButton *)button;
 
 /**
- @abstract Indicates the login finished. The `FBSDKAccessToken.currentAccessToken` will be set.
+ Indicates the login finished. The `FBSDKAccessToken.currentAccessToken` will be set.
  */
 
 // UNCRUSTIFY_FORMAT_OFF
@@ -74,12 +74,12 @@ NS_SWIFT_NAME(deviceLoginButtonDidLogIn(_:));
 // UNCRUSTIFY_FORMAT_ON
 
 /**
- @abstract Indicates the logout finished. The `FBSDKAccessToken.currentAccessToken` will be nil.
+ Indicates the logout finished. The `FBSDKAccessToken.currentAccessToken` will be nil.
  */
 - (void)deviceLoginButtonDidLogOut:(FBSDKDeviceLoginButton *)button;
 
 /**
- @abstract Indicates an error with the login.
+ Indicates an error with the login.
  */
 - (void)deviceLoginButton:(FBSDKDeviceLoginButton *)button didFailWithError:(NSError *)error;
 

FBSDKTVOSKit/FBSDKTVOSKit/FBSDKDeviceLoginViewController.h

@@ -15,31 +15,31 @@ NS_ASSUME_NONNULL_BEGIN
 @class FBSDKDeviceLoginViewController;
 
 /**
- @abstract A delegate for `FBSDKDeviceLoginViewController`
+ A delegate for `FBSDKDeviceLoginViewController`
  */
 NS_SWIFT_NAME(DeviceLoginViewControllerDelegate)
 @protocol FBSDKDeviceLoginViewControllerDelegate <NSObject>
 
 /**
- @abstract Indicates the login was cancelled or timed out.
+ Indicates the login was cancelled or timed out.
  */
 - (void)deviceLoginViewControllerDidCancel:(FBSDKDeviceLoginViewController *)viewController;
 
 /**
- @abstract Indicates the login finished. The `FBSDKAccessToken.currentAccessToken` will be set.
+ Indicates the login finished. The `FBSDKAccessToken.currentAccessToken` will be set.
  */
 - (void)deviceLoginViewControllerDidFinish:(FBSDKDeviceLoginViewController *)viewController;
 
 /**
- @abstract Indicates an error with the login.
+ Indicates an error with the login.
  */
 - (void)deviceLoginViewController:(FBSDKDeviceLoginViewController *)viewController didFailWithError:(NSError *)error;
 
 @end
 
 /**
- @abstract Use this view controller to initiate a Facebook Device Login.
- @discussion The `FBSDKDeviceLoginViewController` will dismiss itself and notify its delegate
+ Use this view controller to initiate a Facebook Device Login.
+ The `FBSDKDeviceLoginViewController` will dismiss itself and notify its delegate
   of the results. You should not re-use a `FBSDKDeviceLoginViewController` instance again.
 
   Upon success, `FBSDKAccessToken.currentAccessToken` will be set.
@@ -58,13 +58,13 @@ NS_SWIFT_NAME(FBDeviceLoginViewController)
 @interface FBSDKDeviceLoginViewController : FBSDKDeviceViewControllerBase
 
 /**
- @abstract The delegate.
+ The delegate.
  */
 @property (nullable, nonatomic, weak) id<FBSDKDeviceLoginViewControllerDelegate> delegate;
 
 /**
- @abstract The permissions to request.
- @discussion To provide the best experience, you should minimize the number of permissions you request, and only ask for them when needed.
+ The permissions to request.
+ To provide the best experience, you should minimize the number of permissions you request, and only ask for them when needed.
  For example, do not ask for "user_location" until you the information is actually used by the app.
 
  Note this is converted to NSSet and is only
@@ -75,8 +75,8 @@ NS_SWIFT_NAME(FBDeviceLoginViewController)
 @property (nonatomic, copy) NSArray<NSString *> *permissions;
 
 /**
- @abstract the optional URL to redirect the user to after they complete the login.
- @discussion the URL must be configured in your App Settings -> Advanced -> OAuth Redirect URIs
+ The optional URL to redirect the user to after they complete the login.
+ The URL must be configured in your App Settings -> Advanced -> OAuth Redirect URIs
  */
 @property (nullable, nonatomic, copy) NSURL *redirectURL;