Merge pull request #1426 from thomasvl/fix_comment_typo

Fix comments typo and update WKTs

objectivec/GPBCodedOutputStream.h

@@ -112,7 +112,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /// Write a double for the given field number.
 - (void)writeDouble:(int32_t)fieldNumber value:(double)value;
-/// Write a packaged array of double for the given field number.
+/// Write a packed array of double for the given field number.
 - (void)writeDoubleArray:(int32_t)fieldNumber
                   values:(GPBDoubleArray *)values
                      tag:(uint32_t)tag;
@@ -121,7 +121,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /// Write a float for the given field number.
 - (void)writeFloat:(int32_t)fieldNumber value:(float)value;
-/// Write a packaged array of float for the given field number.
+/// Write a packed array of float for the given field number.
 - (void)writeFloatArray:(int32_t)fieldNumber
                  values:(GPBFloatArray *)values
                     tag:(uint32_t)tag;
@@ -130,7 +130,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /// Write a uint64_t for the given field number.
 - (void)writeUInt64:(int32_t)fieldNumber value:(uint64_t)value;
-/// Write a packaged array of uint64_t for the given field number.
+/// Write a packed array of uint64_t for the given field number.
 - (void)writeUInt64Array:(int32_t)fieldNumber
                   values:(GPBUInt64Array *)values
                      tag:(uint32_t)tag;
@@ -139,7 +139,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /// Write a int64_t for the given field number.
 - (void)writeInt64:(int32_t)fieldNumber value:(int64_t)value;
-/// Write a packaged array of int64_t for the given field number.
+/// Write a packed array of int64_t for the given field number.
 - (void)writeInt64Array:(int32_t)fieldNumber
                  values:(GPBInt64Array *)values
                     tag:(uint32_t)tag;
@@ -148,7 +148,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /// Write a int32_t for the given field number.
 - (void)writeInt32:(int32_t)fieldNumber value:(int32_t)value;
-/// Write a packaged array of int32_t for the given field number.
+/// Write a packed array of int32_t for the given field number.
 - (void)writeInt32Array:(int32_t)fieldNumber
                  values:(GPBInt32Array *)values
                     tag:(uint32_t)tag;
@@ -157,7 +157,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /// Write a uint32_t for the given field number.
 - (void)writeUInt32:(int32_t)fieldNumber value:(uint32_t)value;
-/// Write a packaged array of uint32_t for the given field number.
+/// Write a packed array of uint32_t for the given field number.
 - (void)writeUInt32Array:(int32_t)fieldNumber
                   values:(GPBUInt32Array *)values
                      tag:(uint32_t)tag;
@@ -166,7 +166,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /// Write a uint64_t for the given field number.
 - (void)writeFixed64:(int32_t)fieldNumber value:(uint64_t)value;
-/// Write a packaged array of uint64_t for the given field number.
+/// Write a packed array of uint64_t for the given field number.
 - (void)writeFixed64Array:(int32_t)fieldNumber
                    values:(GPBUInt64Array *)values
                       tag:(uint32_t)tag;
@@ -175,7 +175,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /// Write a uint32_t for the given field number.
 - (void)writeFixed32:(int32_t)fieldNumber value:(uint32_t)value;
-/// Write a packaged array of uint32_t for the given field number.
+/// Write a packed array of uint32_t for the given field number.
 - (void)writeFixed32Array:(int32_t)fieldNumber
                    values:(GPBUInt32Array *)values
                       tag:(uint32_t)tag;
@@ -184,7 +184,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /// Write a int32_t for the given field number.
 - (void)writeSInt32:(int32_t)fieldNumber value:(int32_t)value;
-/// Write a packaged array of int32_t for the given field number.
+/// Write a packed array of int32_t for the given field number.
 - (void)writeSInt32Array:(int32_t)fieldNumber
                   values:(GPBInt32Array *)values
                      tag:(uint32_t)tag;
@@ -193,7 +193,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /// Write a int64_t for the given field number.
 - (void)writeSInt64:(int32_t)fieldNumber value:(int64_t)value;
-/// Write a packaged array of int64_t for the given field number.
+/// Write a packed array of int64_t for the given field number.
 - (void)writeSInt64Array:(int32_t)fieldNumber
                   values:(GPBInt64Array *)values
                      tag:(uint32_t)tag;
@@ -202,7 +202,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /// Write a int64_t for the given field number.
 - (void)writeSFixed64:(int32_t)fieldNumber value:(int64_t)value;
-/// Write a packaged array of int64_t for the given field number.
+/// Write a packed array of int64_t for the given field number.
 - (void)writeSFixed64Array:(int32_t)fieldNumber
                     values:(GPBInt64Array *)values
                        tag:(uint32_t)tag;
@@ -211,7 +211,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /// Write a int32_t for the given field number.
 - (void)writeSFixed32:(int32_t)fieldNumber value:(int32_t)value;
-/// Write a packaged array of int32_t for the given field number.
+/// Write a packed array of int32_t for the given field number.
 - (void)writeSFixed32Array:(int32_t)fieldNumber
                     values:(GPBInt32Array *)values
                        tag:(uint32_t)tag;
@@ -220,7 +220,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /// Write a BOOL for the given field number.
 - (void)writeBool:(int32_t)fieldNumber value:(BOOL)value;
-/// Write a packaged array of BOOL for the given field number.
+/// Write a packed array of BOOL for the given field number.
 - (void)writeBoolArray:(int32_t)fieldNumber
                 values:(GPBBoolArray *)values
                    tag:(uint32_t)tag;
@@ -229,7 +229,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 /// Write a int32_t for the given field number.
 - (void)writeEnum:(int32_t)fieldNumber value:(int32_t)value;
-/// Write a packaged array of int32_t for the given field number.
+/// Write a packed array of int32_t for the given field number.
 - (void)writeEnumArray:(int32_t)fieldNumber
                 values:(GPBEnumArray *)values
                    tag:(uint32_t)tag;
@@ -293,7 +293,7 @@ NS_ASSUME_NONNULL_END
 //%PDDM-DEFINE _WRITE_PACKABLE_DECLS(NAME, ARRAY_TYPE, TYPE)
 //%/// Write a TYPE for the given field number.
 //%- (void)write##NAME:(int32_t)fieldNumber value:(TYPE)value;
-//%/// Write a packaged array of TYPE for the given field number.
+//%/// Write a packed array of TYPE for the given field number.
 //%- (void)write##NAME##Array:(int32_t)fieldNumber
 //%       NAME$S     values:(GPB##ARRAY_TYPE##Array *)values
 //%       NAME$S        tag:(uint32_t)tag;

objectivec/google/protobuf/Any.pbobjc.h

@@ -9,6 +9,9 @@
 
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 CF_EXTERN_C_BEGIN
 
 NS_ASSUME_NONNULL_BEGIN
@@ -33,8 +36,36 @@ typedef GPB_ENUM(GPBAny_FieldNumber) {
   GPBAny_FieldNumber_Value = 2,
 };
 
-/// `Any` contains an arbitrary serialized message along with a URL
+/// `Any` contains an arbitrary serialized protocol buffer message along with a
-/// that describes the type of the serialized message.
+/// URL that describes the type of the serialized message.
+///
+/// Protobuf library provides support to pack/unpack Any values in the form
+/// of utility functions or additional generated methods of the Any type.
+///
+/// Example 1: Pack and unpack a message in C++.
+///
+///     Foo foo = ...;
+///     Any any;
+///     any.PackFrom(foo);
+///     ...
+///     if (any.UnpackTo(&foo)) {
+///       ...
+///     }
+///
+/// Example 2: Pack and unpack a message in Java.
+///
+///     Foo foo = ...;
+///     Any any = Any.pack(foo);
+///     ...
+///     if (any.is(Foo.class)) {
+///       foo = any.unpack(Foo.class);
+///     }
+///
+/// The pack methods provided by protobuf library will by default use
+/// 'type.googleapis.com/full.type.name' as the type URL and the unpack
+/// methods only use the fully qualified type name after the last '/'
+/// in the type URL, for example "foo.bar.com/x/y.z" will yield type
+/// name "y.z".
 ///
 ///
 /// JSON
@@ -67,7 +98,7 @@ typedef GPB_ENUM(GPBAny_FieldNumber) {
 @interface GPBAny : GPBMessage
 
 /// A URL/resource name whose content describes the type of the
-/// serialized message.
+/// serialized protocol buffer message.
 ///
 /// For URLs which use the schema `http`, `https`, or no schema, the
 /// following restrictions and interpretations apply:
@@ -87,7 +118,7 @@ typedef GPB_ENUM(GPBAny_FieldNumber) {
 /// used with implementation specific semantics.
 @property(nonatomic, readwrite, copy, null_resettable) NSString *typeURL;
 
-/// Must be valid serialized data of the above specified type.
+/// Must be a valid serialized protocol buffer of the above specified type.
 @property(nonatomic, readwrite, copy, null_resettable) NSData *value;
 
 @end
@@ -96,4 +127,6 @@ NS_ASSUME_NONNULL_END
 
 CF_EXTERN_C_END
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/Any.pbobjc.m

@@ -5,6 +5,9 @@
 #import "google/protobuf/Any.pbobjc.h"
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 #pragma mark - GPBAnyRoot
 
 @implementation GPBAnyRoot
@@ -85,4 +88,6 @@ typedef struct GPBAny__storage_ {
 @end
 
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/Api.pbobjc.h

@@ -9,6 +9,9 @@
 
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 CF_EXTERN_C_BEGIN
 
 @class GPBMethod;
@@ -254,4 +257,6 @@ NS_ASSUME_NONNULL_END
 
 CF_EXTERN_C_END
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/Api.pbobjc.m

@@ -7,6 +7,9 @@
 #import "google/protobuf/Type.pbobjc.h"
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 #pragma mark - GPBApiRoot
 
 @implementation GPBApiRoot
@@ -340,4 +343,6 @@ typedef struct GPBMixin__storage_ {
 @end
 
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/Duration.pbobjc.h

@@ -9,6 +9,9 @@
 
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 CF_EXTERN_C_BEGIN
 
 NS_ASSUME_NONNULL_BEGIN
@@ -93,4 +96,6 @@ NS_ASSUME_NONNULL_END
 
 CF_EXTERN_C_END
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/Duration.pbobjc.m

@@ -5,6 +5,9 @@
 #import "google/protobuf/Duration.pbobjc.h"
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 #pragma mark - GPBDurationRoot
 
 @implementation GPBDurationRoot
@@ -80,4 +83,6 @@ typedef struct GPBDuration__storage_ {
 @end
 
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/Empty.pbobjc.h

@@ -9,6 +9,9 @@
 
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 CF_EXTERN_C_BEGIN
 
 NS_ASSUME_NONNULL_BEGIN
@@ -45,4 +48,6 @@ NS_ASSUME_NONNULL_END
 
 CF_EXTERN_C_END
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/Empty.pbobjc.m

@@ -5,6 +5,9 @@
 #import "google/protobuf/Empty.pbobjc.h"
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 #pragma mark - GPBEmptyRoot
 
 @implementation GPBEmptyRoot
@@ -56,4 +59,6 @@ typedef struct GPBEmpty__storage_ {
 @end
 
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/FieldMask.pbobjc.h

@@ -9,6 +9,9 @@
 
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 CF_EXTERN_C_BEGIN
 
 NS_ASSUME_NONNULL_BEGIN
@@ -154,6 +157,33 @@ typedef GPB_ENUM(GPBFieldMask_FieldNumber) {
 ///     {
 ///       mask: "user.displayName,photo"
 ///     }
+///
+/// # Field Masks and Oneof Fields
+///
+/// Field masks treat fields in oneofs just as regular fields. Consider the
+/// following message:
+///
+///     message SampleMessage {
+///       oneof test_oneof {
+///         string name = 4;
+///         SubMessage sub_message = 9;
+///       }
+///     }
+///
+/// The field mask can be:
+///
+///     mask {
+///       paths: "name"
+///     }
+///
+/// Or:
+///
+///     mask {
+///       paths: "sub_message"
+///     }
+///
+/// Note that oneof type names ("test_oneof" in this case) cannot be used in
+/// paths.
 @interface GPBFieldMask : GPBMessage
 
 /// The set of field mask paths.
@@ -167,4 +197,6 @@ NS_ASSUME_NONNULL_END
 
 CF_EXTERN_C_END
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/FieldMask.pbobjc.m

@@ -5,6 +5,9 @@
 #import "google/protobuf/FieldMask.pbobjc.h"
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 #pragma mark - GPBFieldMaskRoot
 
 @implementation GPBFieldMaskRoot
@@ -69,4 +72,6 @@ typedef struct GPBFieldMask__storage_ {
 @end
 
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/SourceContext.pbobjc.h

@@ -9,6 +9,9 @@
 
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 CF_EXTERN_C_BEGIN
 
 NS_ASSUME_NONNULL_BEGIN
@@ -46,4 +49,6 @@ NS_ASSUME_NONNULL_END
 
 CF_EXTERN_C_END
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/SourceContext.pbobjc.m

@@ -5,6 +5,9 @@
 #import "google/protobuf/SourceContext.pbobjc.h"
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 #pragma mark - GPBSourceContextRoot
 
 @implementation GPBSourceContextRoot
@@ -69,4 +72,6 @@ typedef struct GPBSourceContext__storage_ {
 @end
 
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/Struct.pbobjc.h

@@ -9,6 +9,9 @@
 
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 CF_EXTERN_C_BEGIN
 
 @class GPBListValue;
@@ -67,7 +70,7 @@ typedef GPB_ENUM(GPBStruct_FieldNumber) {
 /// The JSON representation for `Struct` is JSON object.
 @interface GPBStruct : GPBMessage
 
-/// Map of dynamically typed values.
+/// Unordered map of dynamically typed values.
 @property(nonatomic, readwrite, strong, null_resettable) NSMutableDictionary<NSString*, GPBValue*> *fields;
 /// The number of items in @c fields without causing the array to be created.
 @property(nonatomic, readonly) NSUInteger fields_Count;
@@ -159,4 +162,6 @@ NS_ASSUME_NONNULL_END
 
 CF_EXTERN_C_END
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/Struct.pbobjc.m

@@ -5,6 +5,9 @@
 #import "google/protobuf/Struct.pbobjc.h"
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 #pragma mark - GPBStructRoot
 
 @implementation GPBStructRoot
@@ -265,4 +268,6 @@ typedef struct GPBListValue__storage_ {
 @end
 
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/Timestamp.pbobjc.h

@@ -9,6 +9,9 @@
 
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 CF_EXTERN_C_BEGIN
 
 NS_ASSUME_NONNULL_BEGIN
@@ -105,4 +108,6 @@ NS_ASSUME_NONNULL_END
 
 CF_EXTERN_C_END
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/Timestamp.pbobjc.m

@@ -5,6 +5,9 @@
 #import "google/protobuf/Timestamp.pbobjc.h"
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 #pragma mark - GPBTimestampRoot
 
 @implementation GPBTimestampRoot
@@ -80,4 +83,6 @@ typedef struct GPBTimestamp__storage_ {
 @end
 
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/Type.pbobjc.h

@@ -9,6 +9,9 @@
 
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 CF_EXTERN_C_BEGIN
 
 @class GPBAny;
@@ -365,4 +368,6 @@ NS_ASSUME_NONNULL_END
 
 CF_EXTERN_C_END
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/Type.pbobjc.m

@@ -7,6 +7,9 @@
 #import "google/protobuf/SourceContext.pbobjc.h"
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 #pragma mark - GPBTypeRoot
 
 @implementation GPBTypeRoot
@@ -685,4 +688,6 @@ typedef struct GPBOption__storage_ {
 @end
 
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/Wrappers.pbobjc.h

@@ -9,6 +9,9 @@
 
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 CF_EXTERN_C_BEGIN
 
 NS_ASSUME_NONNULL_BEGIN
@@ -174,4 +177,6 @@ NS_ASSUME_NONNULL_END
 
 CF_EXTERN_C_END
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)

objectivec/google/protobuf/Wrappers.pbobjc.m

@@ -5,6 +5,9 @@
 #import "google/protobuf/Wrappers.pbobjc.h"
 // @@protoc_insertion_point(imports)
 
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+
 #pragma mark - GPBWrappersRoot
 
 @implementation GPBWrappersRoot
@@ -412,4 +415,6 @@ typedef struct GPBBytesValue__storage_ {
 @end
 
 
+#pragma clang diagnostic pop
+
 // @@protoc_insertion_point(global_scope)