Fix older HeaderDoc style documentation since these make the document…

…ation not render at all Summary: Replaced instances of "/*!" with "/**" Previously these would show as "Undocumented" but now the documentation shows up Reviewed By: linmx0130 Differential Revision: D34120245 fbshipit-source-id: 782e872111c00a7721504b4c1f1ab1edc4afb0d3
Mamidze · Feb 10, 2022 · 92d9596 · 92d9596
1 parent b9cc523
commit 92d9596
Show file tree

Hide file tree

Showing 14 changed files with 58 additions and 58 deletions.
diff --git a/FBSDKLoginKit/FBSDKLoginKit/FBSDKDeviceLoginCodeInfo.h b/FBSDKLoginKit/FBSDKLoginKit/FBSDKDeviceLoginCodeInfo.h
@@ -10,40 +10,40 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-/*!
+/**
  @abstract Describes the initial response when starting the device login flow.
  @discussion This is used by `FBSDKDeviceLoginManager`.
  */
 NS_SWIFT_NAME(DeviceLoginCodeInfo)
 @interface FBSDKDeviceLoginCodeInfo : NSObject
 
-/*!
+/**
  @abstract There is no public initializer.
  */
 - (instancetype)init NS_UNAVAILABLE;
 + (instancetype)new NS_UNAVAILABLE;
 
-/*!
+/**
  @abstract 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.
  */
 @property (nonatomic, readonly, copy) NSString *loginCode;
 
-/*!
+/**
  @abstract the verification URL.
  */
 @property (nonatomic, readonly, copy) NSURL *verificationURL;
 
-/*!
+/**
  @abstract the expiration date.
  */
 @property (nonatomic, readonly, copy) NSDate *expirationDate;
 
-/*!
+/**
  @abstract the polling interval
  */
 @property (nonatomic, readonly, assign) NSUInteger pollingInterval;

diff --git a/FBSDKLoginKit/FBSDKLoginKit/FBSDKDeviceLoginManager.h b/FBSDKLoginKit/FBSDKLoginKit/FBSDKDeviceLoginManager.h
@@ -15,7 +15,7 @@ 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.
    This class informs the delegate when this code is received. You should then present the
@@ -27,7 +27,7 @@ NS_ASSUME_NONNULL_BEGIN
 NS_SWIFT_NAME(DeviceLoginManager)
 @interface FBSDKDeviceLoginManager : NSObject <NSNetServiceDelegate>
 
-/*!
+/**
  @abstract Initializes a new instance.
  @param permissions permissions to request.
  */
@@ -37,29 +37,29 @@ NS_SWIFT_NAME(DeviceLoginManager)
 - (instancetype)init NS_UNAVAILABLE;
 + (instancetype)new NS_UNAVAILABLE;
 
-/*!
+/**
  @abstract the delegate.
  */
 @property (nonatomic, weak) id<FBSDKDeviceLoginManagerDelegate> delegate;
 
-/*!
+/**
  @abstract 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
  */
 @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.
  */
 - (void)start;
 
-/*!
+/**
  @abstract Attempts to cancel the device login flow.
  */
 - (void)cancel;

diff --git a/FBSDKLoginKit/FBSDKLoginKit/FBSDKDeviceLoginManagerDelegate.h b/FBSDKLoginKit/FBSDKLoginKit/FBSDKDeviceLoginManagerDelegate.h
@@ -8,13 +8,13 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-/*!
+/**
  @abstract 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.
  @param loginManager the login manager instance.
  @param codeInfo the code info data.
@@ -23,7 +23,7 @@ NS_SWIFT_NAME(DeviceLoginManagerDelegate)
 - (void)deviceLoginManager:(FBSDKDeviceLoginManager *)loginManager
        startedWithCodeInfo:(FBSDKDeviceLoginCodeInfo *)codeInfo;
 
-/*!
+/**
  @abstract Indicates the device login flow has finished.
  @param loginManager the login manager instance.
  @param result the results of the login flow.

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

diff --git a/FBSDKLoginKit/FBSDKLoginKit/FBSDKLoginButton.h b/FBSDKLoginKit/FBSDKLoginKit/FBSDKLoginButton.h
@@ -68,7 +68,7 @@ NS_SWIFT_NAME(FBLoginButton)
  Gets or sets the delegate.
  */
 @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.
  For example, do not ask for "user_location" until you the information is actually used by the app.

diff --git a/FBSDKLoginKit/FBSDKLoginKit/Internal/FBSDKDeviceLoginCodeInfo+Internal.h b/FBSDKLoginKit/FBSDKLoginKit/Internal/FBSDKDeviceLoginCodeInfo+Internal.h
@@ -15,7 +15,7 @@ NS_ASSUME_NONNULL_BEGIN
 @interface FBSDKDeviceLoginCodeInfo ()
 
 // UNCRUSTIFY_FORMAT_OFF
-/*!
+/**
  @abstract Initializes a new instance
  @param identifier the unique id for this login flow instance.
  @param loginCode the short "user_code".

diff --git a/FBSDKLoginKit/FBSDKLoginKit/Internal/FBSDKDeviceLoginManagerResult+Internal.h b/FBSDKLoginKit/FBSDKLoginKit/Internal/FBSDKDeviceLoginManagerResult+Internal.h
@@ -20,7 +20,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface FBSDKDeviceLoginManagerResult ()
 
-/*!
+/**
  @abstract Initializes a new instance
  @param token The token
  @param cancelled Indicates if the flow was cancelled.

diff --git a/FBSDKTVOSKit/FBSDKTVOSKit/FBSDKDeviceLoginButton.h b/FBSDKTVOSKit/FBSDKTVOSKit/FBSDKDeviceLoginButton.h
@@ -14,7 +14,7 @@ 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
  determine what to display, and automatically starts authentication (by presenting
@@ -27,12 +27,12 @@ NS_ASSUME_NONNULL_BEGIN
 NS_SWIFT_NAME(FBDeviceLoginButton)
 @interface FBSDKDeviceLoginButton : FBSDKDeviceButton
 
-/*!
+/**
  @abstract 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.
  For example, do not ask for "user_location" until you the information is actually used by the app.
@@ -44,27 +44,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
  */
 @property (nullable, nonatomic, copy) NSURL *redirectURL;
 
 @end
 
-/*!
+/**
  @protocol
  @abstract A delegate protocol for `FBSDKDeviceLoginButton`
  */
 NS_SWIFT_NAME(DeviceLoginButtonDelegate)
 @protocol FBSDKDeviceLoginButtonDelegate <NSObject>
 
-/*!
+/**
  @abstract Indicates the login was cancelled or timed out.
  */
 - (void)deviceLoginButtonDidCancel:(FBSDKDeviceLoginButton *)button;
 
-/*!
+/**
  @abstract Indicates the login finished. The `FBSDKAccessToken.currentAccessToken` will be set.
  */
 
@@ -73,12 +73,12 @@ NS_SWIFT_NAME(DeviceLoginButtonDelegate)
 NS_SWIFT_NAME(deviceLoginButtonDidLogIn(_:));
 // UNCRUSTIFY_FORMAT_ON
 
-/*!
+/**
  @abstract Indicates the logout finished. The `FBSDKAccessToken.currentAccessToken` will be nil.
  */
 - (void)deviceLoginButtonDidLogOut:(FBSDKDeviceLoginButton *)button;
 
-/*!
+/**
  @abstract Indicates an error with the login.
  */
 - (void)deviceLoginButton:(FBSDKDeviceLoginButton *)button didFailWithError:(NSError *)error;

diff --git a/FBSDKTVOSKit/FBSDKTVOSKit/FBSDKDeviceLoginViewController.h b/FBSDKTVOSKit/FBSDKTVOSKit/FBSDKDeviceLoginViewController.h
@@ -14,30 +14,30 @@ NS_ASSUME_NONNULL_BEGIN
 
 @class FBSDKDeviceLoginViewController;
 
-/*!
+/**
  @abstract A delegate for `FBSDKDeviceLoginViewController`
  */
 NS_SWIFT_NAME(DeviceLoginViewControllerDelegate)
 @protocol FBSDKDeviceLoginViewControllerDelegate <NSObject>
 
-/*!
+/**
  @abstract Indicates the login was cancelled or timed out.
  */
 - (void)deviceLoginViewControllerDidCancel:(FBSDKDeviceLoginViewController *)viewController;
 
-/*!
+/**
  @abstract Indicates the login finished. The `FBSDKAccessToken.currentAccessToken` will be set.
  */
 - (void)deviceLoginViewControllerDidFinish:(FBSDKDeviceLoginViewController *)viewController;
 
-/*!
+/**
  @abstract 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
   of the results. You should not re-use a `FBSDKDeviceLoginViewController` instance again.
@@ -57,12 +57,12 @@ NS_SWIFT_NAME(DeviceLoginViewControllerDelegate)
 NS_SWIFT_NAME(FBDeviceLoginViewController)
 @interface FBSDKDeviceLoginViewController : FBSDKDeviceViewControllerBase
 
-/*!
+/**
  @abstract 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.
  For example, do not ask for "user_location" until you the information is actually used by the app.
@@ -74,7 +74,7 @@ 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
  */

diff --git a/FBSDKTVOSKit/FBSDKTVOSKit/FBSDKJS.h b/FBSDKTVOSKit/FBSDKTVOSKit/FBSDKJS.h
@@ -13,24 +13,24 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-/*!
+/**
  @abstract Marker protocol to export native functions to Javascript contexts.
  @discussion see `FBSDKJS` for integration in TVML apps.
  */
 NS_SWIFT_NAME(JSExports)
 @protocol FBSDKJSExports <JSExport>
 
-/*!
+/**
  @abstract Returns the current access token string, if available.
  */
 @property (class, nullable, nonatomic, readonly, copy) NSString *accessTokenString;
 
-/*!
+/**
  @abstract returns true if there is a current access token.
  */
 @property (class, nonatomic, readonly, getter = isLoggedIn, assign) BOOL loggedIn;
 
-/*!
+/**
  @abstract Returns true if there is a current access token and the permission has been granted.
  */
 
@@ -39,30 +39,30 @@ NS_SWIFT_NAME(JSExports)
 NS_SWIFT_NAME(hasGranted(permission:));
 // UNCRUSTIFY_FORMAT_ON
 
-/*!
+/**
  @abstract Log an event for analytics. In TVJS this is defined as `FBSDKJS.logEventParameters(...)`.
  @param eventName the event name
  @discussion See `FBSDKAppEvents logEvent:parameters:`.
  */
 + (void)logEvent:(FBSDKAppEventName)eventName;
 
-/*!
+/**
  @abstract Log an event for analytics. In TVJS this is defined as `FBSDKJS.logEventParameters(...)`.
  @param eventName the event name
  @param parameters the parameters (optional).
  @discussion See `FBSDKAppEvents logEvent:parameters:`.
  */
 + (void)logEvent:(FBSDKAppEventName)eventName parameters:(nullable NSDictionary<FBSDKAppEventParameterName, id> *)parameters;
 
-/*!
+/**
  @abstract Log an event for analytics. In TVJS this is defined as `FBSDKJS.logPurchaseCurrencyParameters(...)`.
  @param purchaseAmount the purchase amount
  @param currency the currency, e.g, "USD"
  @discussion See `FBSDKAppEvents logPurchase:currency:parameters:`.
  */
 + (void)logPurchase:(double)purchaseAmount currency:(NSString *)currency;
 
-/*!
+/**
  @abstract Log an event for analytics. In TVJS this is defined as `FBSDKJS.logPurchaseCurrencyParameters(...)`.
  @param purchaseAmount the purchase amount
  @param currency the currency, e.g, "USD"
@@ -75,7 +75,7 @@ NS_SWIFT_NAME(hasGranted(permission:));
 
 @end
 
-/*!
+/**
  @abstract Utility class to export common native functions to Javascript contexts.
  @discussion You should connect this to your `TVApplicationControllerDelegate`. For example,
  <code>