Skip to content

Commit ed2d74c

Browse files
mikelehenwilhuff
authored andcommitted
b/62961699: Use :nodoc: to prevent methods from showing up in reference docs. (#2600)
1 parent 438d49a commit ed2d74c

12 files changed

+13
-13
lines changed

Firestore/Source/Public/FIRCollectionReference.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ NS_ASSUME_NONNULL_BEGIN
2929
NS_SWIFT_NAME(CollectionReference)
3030
@interface FIRCollectionReference : FIRQuery
3131

32-
/** */
32+
/** :nodoc: */
3333
- (id)init __attribute__((unavailable("FIRCollectionReference cannot be created directly.")));
3434

3535
/** ID of the referenced collection. */

Firestore/Source/Public/FIRDocumentChange.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ typedef NS_ENUM(NSInteger, FIRDocumentChangeType) {
4040
NS_SWIFT_NAME(DocumentChange)
4141
@interface FIRDocumentChange : NSObject
4242

43-
/** */
43+
/** :nodoc: */
4444
- (id)init __attribute__((unavailable("FIRDocumentChange cannot be created directly.")));
4545

4646
/** The type of change that occurred (added, modified, or removed). */

Firestore/Source/Public/FIRDocumentReference.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ typedef void (^FIRDocumentSnapshotBlock)(FIRDocumentSnapshot *_Nullable snapshot
3737
NS_SWIFT_NAME(DocumentReference)
3838
@interface FIRDocumentReference : NSObject
3939

40-
/** */
40+
/** :nodoc: */
4141
- (instancetype)init
4242
__attribute__((unavailable("FIRDocumentReference cannot be created directly.")));
4343

Firestore/Source/Public/FIRDocumentSnapshot.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ typedef NS_ENUM(NSInteger, FIRServerTimestampBehavior) {
5858
NS_SWIFT_NAME(DocumentSnapshot)
5959
@interface FIRDocumentSnapshot : NSObject
6060

61-
/** */
61+
/** :nodoc: */
6262
- (instancetype)init
6363
__attribute__((unavailable("FIRDocumentSnapshot cannot be created directly.")));
6464

@@ -151,7 +151,7 @@ NS_SWIFT_NAME(DocumentSnapshot)
151151
NS_SWIFT_NAME(QueryDocumentSnapshot)
152152
@interface FIRQueryDocumentSnapshot : FIRDocumentSnapshot
153153

154-
/** */
154+
/** :nodoc: */
155155
- (instancetype)init
156156
__attribute__((unavailable("FIRQueryDocumentSnapshot cannot be created directly.")));
157157

Firestore/Source/Public/FIRFieldValue.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ NS_ASSUME_NONNULL_BEGIN
2424
NS_SWIFT_NAME(FieldValue)
2525
@interface FIRFieldValue : NSObject
2626

27-
/** */
27+
/** :nodoc: */
2828
- (instancetype)init NS_UNAVAILABLE;
2929

3030
/** Used with updateData() to mark a field for deletion. */

Firestore/Source/Public/FIRFirestore.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ NS_SWIFT_NAME(Firestore)
3434
@interface FIRFirestore : NSObject
3535

3636
#pragma mark - Initializing
37-
/** */
37+
/** :nodoc: */
3838
- (instancetype)init __attribute__((unavailable("Use a static constructor method.")));
3939

4040
/**

Firestore/Source/Public/FIRGeoPoint.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ NS_ASSUME_NONNULL_BEGIN
2828
NS_SWIFT_NAME(GeoPoint)
2929
@interface FIRGeoPoint : NSObject <NSCopying>
3030

31-
/** */
31+
/** :nodoc: */
3232
- (instancetype)init NS_UNAVAILABLE;
3333

3434
/**

Firestore/Source/Public/FIRQuery.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ typedef void (^FIRQuerySnapshotBlock)(FIRQuerySnapshot *_Nullable snapshot,
3535
*/
3636
NS_SWIFT_NAME(Query)
3737
@interface FIRQuery : NSObject
38-
/** */
38+
/** :nodoc: */
3939
- (id)init __attribute__((unavailable("FIRQuery cannot be created directly.")));
4040

4141
/** The `FIRFirestore` for the Firestore database (useful for performing transactions, etc.). */

Firestore/Source/Public/FIRQuerySnapshot.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ NS_ASSUME_NONNULL_BEGIN
3131
NS_SWIFT_NAME(QuerySnapshot)
3232
@interface FIRQuerySnapshot : NSObject
3333

34-
/** */
34+
/** :nodoc: */
3535
- (id)init __attribute__((unavailable("FIRQuerySnapshot cannot be created directly.")));
3636

3737
/**

Firestore/Source/Public/FIRSnapshotMetadata.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ NS_ASSUME_NONNULL_BEGIN
2222
NS_SWIFT_NAME(SnapshotMetadata)
2323
@interface FIRSnapshotMetadata : NSObject
2424

25-
/** */
25+
/** :nodoc: */
2626
- (instancetype)init NS_UNAVAILABLE;
2727

2828
/**

Firestore/Source/Public/FIRTimestamp.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ NS_ASSUME_NONNULL_BEGIN
3333
NS_SWIFT_NAME(Timestamp)
3434
@interface FIRTimestamp : NSObject <NSCopying>
3535

36-
/** */
36+
/** :nodoc: */
3737
- (instancetype)init NS_UNAVAILABLE;
3838

3939
/**

Firestore/Source/Public/FIRTransaction.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ NS_ASSUME_NONNULL_BEGIN
2929
NS_SWIFT_NAME(Transaction)
3030
@interface FIRTransaction : NSObject
3131

32-
/** */
32+
/** :nodoc: */
3333
- (id)init __attribute__((unavailable("FIRTransaction cannot be created directly.")));
3434

3535
/**

0 commit comments

Comments
 (0)