From 65852d6e9cdb3d6e1120ef6af044968cbbaff733 Mon Sep 17 00:00:00 2001 From: Chris Bainbridge Date: Wed, 27 Oct 2021 19:28:21 +0100 Subject: [PATCH] Fix comment syntax in any.proto (#8792) * Fix comment syntax in any.proto Remove extra spaces which cause incorrect indentation in godoc. Remove the "====" style title which is not rendered by godoc. * Run ./generate_descriptor_proto.sh --- csharp/src/Google.Protobuf/WellKnownTypes/Any.cs | 6 +++--- objectivec/GPBAny.pbobjc.h | 6 +++--- php/src/Google/Protobuf/Any.php | 5 ++--- src/google/protobuf/any.proto | 6 +++--- 4 files changed, 11 insertions(+), 12 deletions(-) diff --git a/csharp/src/Google.Protobuf/WellKnownTypes/Any.cs b/csharp/src/Google.Protobuf/WellKnownTypes/Any.cs index 7b5019a8ac..13066da3fe 100644 --- a/csharp/src/Google.Protobuf/WellKnownTypes/Any.cs +++ b/csharp/src/Google.Protobuf/WellKnownTypes/Any.cs @@ -65,7 +65,7 @@ namespace Google.Protobuf.WellKnownTypes { /// foo = any.unpack(Foo.class); /// } /// - /// Example 3: Pack and unpack a message in Python. + /// Example 3: Pack and unpack a message in Python. /// /// foo = Foo(...) /// any = Any() @@ -75,7 +75,7 @@ namespace Google.Protobuf.WellKnownTypes { /// any.Unpack(foo) /// ... /// - /// Example 4: Pack and unpack a message in Go + /// Example 4: Pack and unpack a message in Go /// /// foo := &pb.Foo{...} /// any, err := anypb.New(foo) @@ -95,7 +95,7 @@ namespace Google.Protobuf.WellKnownTypes { /// name "y.z". /// /// JSON - /// ==== + /// /// The JSON representation of an `Any` value uses the regular /// representation of the deserialized, embedded message, with an /// additional field `@type` which contains the type URL. Example: diff --git a/objectivec/GPBAny.pbobjc.h b/objectivec/GPBAny.pbobjc.h index 21b7dcf4af..5ed3f2ee68 100644 --- a/objectivec/GPBAny.pbobjc.h +++ b/objectivec/GPBAny.pbobjc.h @@ -81,7 +81,7 @@ typedef GPB_ENUM(GPBAny_FieldNumber) { * foo = any.unpack(Foo.class); * } * - * Example 3: Pack and unpack a message in Python. + * Example 3: Pack and unpack a message in Python. * * foo = Foo(...) * any = Any() @@ -91,7 +91,7 @@ typedef GPB_ENUM(GPBAny_FieldNumber) { * any.Unpack(foo) * ... * - * Example 4: Pack and unpack a message in Go + * Example 4: Pack and unpack a message in Go * * foo := &pb.Foo{...} * any, err := anypb.New(foo) @@ -112,7 +112,7 @@ typedef GPB_ENUM(GPBAny_FieldNumber) { * * * JSON - * ==== + * * The JSON representation of an `Any` value uses the regular * representation of the deserialized, embedded message, with an * additional field `\@type` which contains the type URL. Example: diff --git a/php/src/Google/Protobuf/Any.php b/php/src/Google/Protobuf/Any.php index 8fdc3c483d..cc64bad3db 100644 --- a/php/src/Google/Protobuf/Any.php +++ b/php/src/Google/Protobuf/Any.php @@ -28,7 +28,7 @@ use Google\Protobuf\Internal\GPBUtil; * if (any.is(Foo.class)) { * foo = any.unpack(Foo.class); * } - * Example 3: Pack and unpack a message in Python. + * Example 3: Pack and unpack a message in Python. * foo = Foo(...) * any = Any() * any.Pack(foo) @@ -36,7 +36,7 @@ use Google\Protobuf\Internal\GPBUtil; * if any.Is(Foo.DESCRIPTOR): * any.Unpack(foo) * ... - * Example 4: Pack and unpack a message in Go + * Example 4: Pack and unpack a message in Go * foo := &pb.Foo{...} * any, err := anypb.New(foo) * if err != nil { @@ -53,7 +53,6 @@ use Google\Protobuf\Internal\GPBUtil; * in the type URL, for example "foo.bar.com/x/y.z" will yield type * name "y.z". * JSON - * ==== * The JSON representation of an `Any` value uses the regular * representation of the deserialized, embedded message, with an * additional field `@type` which contains the type URL. Example: diff --git a/src/google/protobuf/any.proto b/src/google/protobuf/any.proto index 6ed8a23cf5..e2c2042fdc 100644 --- a/src/google/protobuf/any.proto +++ b/src/google/protobuf/any.proto @@ -64,7 +64,7 @@ option objc_class_prefix = "GPB"; // foo = any.unpack(Foo.class); // } // -// Example 3: Pack and unpack a message in Python. +// Example 3: Pack and unpack a message in Python. // // foo = Foo(...) // any = Any() @@ -74,7 +74,7 @@ option objc_class_prefix = "GPB"; // any.Unpack(foo) // ... // -// Example 4: Pack and unpack a message in Go +// Example 4: Pack and unpack a message in Go // // foo := &pb.Foo{...} // any, err := anypb.New(foo) @@ -95,7 +95,7 @@ option objc_class_prefix = "GPB"; // // // JSON -// ==== +// // The JSON representation of an `Any` value uses the regular // representation of the deserialized, embedded message, with an // additional field `@type` which contains the type URL. Example: