Merge pull request #2188 from ably/remove-nodoc-private-headers

Remove `:nodoc:` annotations from private headers

Author: lawrence-forooghian

Source/PrivateHeaders/Ably/ARTConnectionDetails.h

@@ -54,7 +54,6 @@ NS_ASSUME_NONNULL_BEGIN
 /// If the `objectsGCGracePeriod` is present in the `ConnectionDetails`, this contains an `NSNumber` wrapping an `NSTimeInterval` containing its value in seconds.
 @property (readonly, nonatomic, nullable) NSNumber *objectsGCGracePeriod;
 
-/// :nodoc:
 - (instancetype)initWithClientId:(NSString *_Nullable)clientId
                    connectionKey:(NSString *_Nullable)connectionKey
                   maxMessageSize:(NSInteger)maxMessageSize

Source/PrivateHeaders/Ably/ARTDataEncoder.h

@@ -9,7 +9,6 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-/// :nodoc:
 @interface ARTDataEncoderOutput : NSObject
 
 @property (readonly, nonatomic, nullable) id data;
@@ -35,7 +34,6 @@ NS_ASSUME_NONNULL_BEGIN
 
 @end
 
-/// :nodoc:
 @interface NSString (ARTDataEncoder)
 
 + (NSString *)artAddEncoding:(NSString *)encoding toString:(NSString *_Nullable)s;

Source/PrivateHeaders/Ably/ARTDeviceStorage.h

@@ -5,7 +5,6 @@ NS_ASSUME_NONNULL_BEGIN
 
 // Instances of ARTDeviceStorage should expect to have their methods called
 // from any thread.
-/// :nodoc:
 @protocol ARTDeviceStorage <NSObject>
 - (nullable id)objectForKey:(NSString *)key;
 - (void)setObject:(nullable id)value forKey:(NSString *)key;

Source/PrivateHeaders/Ably/ARTEncoder.h

@@ -17,15 +17,13 @@
 
 @protocol ARTPushRecipient;
 
-/// :nodoc:
 typedef NS_ENUM(NSUInteger, ARTEncoderFormat) {
     ARTEncoderFormatJson,
     ARTEncoderFormatMsgPack
 };
 
 NS_ASSUME_NONNULL_BEGIN
 
-/// :nodoc:
 @protocol ARTEncoder
 
 - (NSString *)mimeType;

Source/PrivateHeaders/Ably/ARTFallback.h

@@ -5,7 +5,6 @@ NS_ASSUME_NONNULL_BEGIN
 @class ARTHttpResponse;
 @class ARTClientOptions;
 
-/// :nodoc:
 @interface ARTFallback : NSObject
 
 /**

Source/PrivateHeaders/Ably/ARTHttp.h

@@ -10,15 +10,13 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-/// :nodoc:
 @protocol ARTHTTPExecutor
 
 - (nullable NSObject<ARTCancellable> *)executeRequest:(NSURLRequest *)request
                                            completion:(nullable ARTURLRequestCallback)callback;
 
 @end
 
-/// :nodoc:
 @interface ARTHttp : NSObject<ARTHTTPExecutor>
 
 + (void)setURLSessionClass:(Class)urlSessionClass;

Source/PrivateHeaders/Ably/ARTLocalDeviceStorage.h

@@ -5,7 +5,6 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-/// :nodoc:
 @interface ARTLocalDeviceStorage : NSObject<ARTDeviceStorage>
 
 - (instancetype)initWithLogger:(ARTInternalLog *)logger;

Source/PrivateHeaders/Ably/ARTMessageSendStatus.h

@@ -40,7 +40,6 @@ NS_ASSUME_NONNULL_BEGIN
 
 @end
 
-/// :nodoc:
 typedef void (^ARTMessageSendCallback)(ARTMessageSendStatus *status);
 
 NS_ASSUME_NONNULL_END

Source/PrivateHeaders/Ably/ARTPendingMessage.h

@@ -4,7 +4,6 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-/// :nodoc:
 @interface ARTPendingMessage : ARTQueuedMessage
 
 - (instancetype)initWithProtocolMessage:(ARTProtocolMessage *)msg sentCallback:(nullable ARTCallback)sentCallback ackCallback:(nullable ARTMessageSendCallback)ackCallback UNAVAILABLE_ATTRIBUTE;

Source/PrivateHeaders/Ably/ARTProtocolMessage.h

@@ -16,7 +16,6 @@
 @class ARTAnnotation;
 @class ARTPublishResult;
 
-/// :nodoc:
 typedef NS_ENUM(NSUInteger, ARTProtocolMessageAction) {
     ARTProtocolMessageHeartbeat = 0,
     ARTProtocolMessageAck = 1,
@@ -41,13 +40,11 @@ typedef NS_ENUM(NSUInteger, ARTProtocolMessageAction) {
     ARTProtocolMessageAnnotation = 21,
 };
 
-/// :nodoc:
 NSString *_Nonnull ARTProtocolMessageActionToStr(ARTProtocolMessageAction action);
 
 NS_ASSUME_NONNULL_BEGIN
 
 /**
- * :nodoc:
  * A message sent and received over the Realtime protocol.
  * ARTProtocolMessage always relates to a single channel only, but can contain multiple individual messages or presence messages.
  * ARTProtocolMessage are serially numbered on a connection.