Update doc comments for release (#6321)

* Update doc comments for release

* Remove not-parsed doc tag

* Add changelog entry

FirebaseAppDistribution/CHANGELOG.md

@@ -1,2 +1,5 @@
+# Unreleased
+- [changed] Updated header comments (#6321).
+
 # v0.9.0
 - Initial beta release.

FirebaseAppDistribution/Sources/Public/FIRAppDistribution.h

@@ -29,7 +29,7 @@ NS_ASSUME_NONNULL_BEGIN
 NS_SWIFT_NAME(AppDistribution)
 @interface FIRAppDistribution : NSObject
 
-// Is true if the App Distribution tester is signed in
+/// Returns true if the App Distribution tester is signed in.
 @property(nonatomic, readonly) BOOL isTesterSignedIn;
 
 /** :nodoc: */
@@ -62,28 +62,29 @@ NS_SWIFT_NAME(AppDistribution)
 
 @end
 
-// The error domain for codes in the FIRAppDistributionError enum.
+/// The error domain for codes in the `FIRAppDistributionError` enum.
 FOUNDATION_EXPORT NSString *const FIRAppDistributionErrorDomain
     NS_SWIFT_NAME(AppDistributionErrorDomain);
 
-// The key for finding error details in the NSError userInfo.
+/// The key for finding error details in the `NSError`'s `userInfo`.
 FOUNDATION_EXPORT NSString *const FIRAppDistributionErrorDetailsKey
     NS_SWIFT_NAME(FunctionsErrorDetailsKey);
 
 /**
- *  @enum AppDistributionError
+ * Error codes representing sign in or version check failure reasons.
  */
 typedef NS_ENUM(NSUInteger, FIRAppDistributionError) {
-  /// Unknown error.
+  /// Returned when an unknown error occurred.
   FIRAppDistributionErrorUnknown = 0,
 
-  // Authentication failed
+  /// Returned when App Distribution failed to authenticate the user.
   FIRAppDistributionErrorAuthenticationFailure = 1,
 
-  // Authentication canceled
+  /// Returned when sign-in was cancelled.
   FIRAppDistributionErrorAuthenticationCancelled = 2,
 
-  // Network unavailable to make requests or the request timed out
+  /// Returned when the network was unavailable to make requests or
+  /// the request timed out.
   FIRAppDistributionErrorNetworkFailure = 3,
 
 } NS_SWIFT_NAME(AppDistributionError);

FirebaseAppDistribution/Sources/Public/FIRAppDistributionRelease.h

@@ -23,19 +23,19 @@ NS_ASSUME_NONNULL_BEGIN
 NS_SWIFT_NAME(AppDistributionRelease)
 @interface FIRAppDistributionRelease : NSObject
 
-// The short bundle version of this build (example 1.0.0)
+/// The short bundle version of this build (example 1.0.0).
 @property(nonatomic, copy, readonly) NSString *displayVersion;
 
-// The build number of this build (example: 123)
+/// The build number of this build (example: 123).
 @property(nonatomic, copy, readonly) NSString *buildVersion;
 
-// The release notes for this build
+/// The release notes for this build.
 @property(nonatomic, copy, readonly) NSString *releaseNotes;
 
-// The URL for the build
+/// The URL for the build.
 @property(nonatomic, strong, readonly) NSURL *downloadURL;
 
-// Whether the download URL for this release is expired
+/// Whether the download URL for this release is expired.
 @property(nonatomic, readonly) BOOL isExpired;
 
 /** :nodoc: */