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
This commit is contained in:
Chris Bainbridge 2021-10-27 19:28:21 +01:00 committed by GitHub
parent 1d2e8d9302
commit 65852d6e9c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 11 additions and 12 deletions

View File

@ -65,7 +65,7 @@ namespace Google.Protobuf.WellKnownTypes {
/// foo = any.unpack(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(...) /// foo = Foo(...)
/// any = Any() /// any = Any()
@ -75,7 +75,7 @@ namespace Google.Protobuf.WellKnownTypes {
/// any.Unpack(foo) /// any.Unpack(foo)
/// ... /// ...
/// ///
/// Example 4: Pack and unpack a message in Go /// Example 4: Pack and unpack a message in Go
/// ///
/// foo := &pb.Foo{...} /// foo := &pb.Foo{...}
/// any, err := anypb.New(foo) /// any, err := anypb.New(foo)
@ -95,7 +95,7 @@ namespace Google.Protobuf.WellKnownTypes {
/// name "y.z". /// name "y.z".
/// ///
/// JSON /// JSON
/// ==== ///
/// The JSON representation of an `Any` value uses the regular /// The JSON representation of an `Any` value uses the regular
/// representation of the deserialized, embedded message, with an /// representation of the deserialized, embedded message, with an
/// additional field `@type` which contains the type URL. Example: /// additional field `@type` which contains the type URL. Example:

View File

@ -81,7 +81,7 @@ typedef GPB_ENUM(GPBAny_FieldNumber) {
* foo = any.unpack(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(...) * foo = Foo(...)
* any = Any() * any = Any()
@ -91,7 +91,7 @@ typedef GPB_ENUM(GPBAny_FieldNumber) {
* any.Unpack(foo) * any.Unpack(foo)
* ... * ...
* *
* Example 4: Pack and unpack a message in Go * Example 4: Pack and unpack a message in Go
* *
* foo := &pb.Foo{...} * foo := &pb.Foo{...}
* any, err := anypb.New(foo) * any, err := anypb.New(foo)
@ -112,7 +112,7 @@ typedef GPB_ENUM(GPBAny_FieldNumber) {
* *
* *
* JSON * JSON
* ==== *
* The JSON representation of an `Any` value uses the regular * The JSON representation of an `Any` value uses the regular
* representation of the deserialized, embedded message, with an * representation of the deserialized, embedded message, with an
* additional field `\@type` which contains the type URL. Example: * additional field `\@type` which contains the type URL. Example:

View File

@ -28,7 +28,7 @@ use Google\Protobuf\Internal\GPBUtil;
* if (any.is(Foo.class)) { * if (any.is(Foo.class)) {
* foo = any.unpack(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(...) * foo = Foo(...)
* any = Any() * any = Any()
* any.Pack(foo) * any.Pack(foo)
@ -36,7 +36,7 @@ use Google\Protobuf\Internal\GPBUtil;
* if any.Is(Foo.DESCRIPTOR): * if any.Is(Foo.DESCRIPTOR):
* any.Unpack(foo) * any.Unpack(foo)
* ... * ...
* Example 4: Pack and unpack a message in Go * Example 4: Pack and unpack a message in Go
* foo := &pb.Foo{...} * foo := &pb.Foo{...}
* any, err := anypb.New(foo) * any, err := anypb.New(foo)
* if err != nil { * 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 * in the type URL, for example "foo.bar.com/x/y.z" will yield type
* name "y.z". * name "y.z".
* JSON * JSON
* ====
* The JSON representation of an `Any` value uses the regular * The JSON representation of an `Any` value uses the regular
* representation of the deserialized, embedded message, with an * representation of the deserialized, embedded message, with an
* additional field `@type` which contains the type URL. Example: * additional field `@type` which contains the type URL. Example:

View File

@ -64,7 +64,7 @@ option objc_class_prefix = "GPB";
// foo = any.unpack(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(...) // foo = Foo(...)
// any = Any() // any = Any()
@ -74,7 +74,7 @@ option objc_class_prefix = "GPB";
// any.Unpack(foo) // any.Unpack(foo)
// ... // ...
// //
// Example 4: Pack and unpack a message in Go // Example 4: Pack and unpack a message in Go
// //
// foo := &pb.Foo{...} // foo := &pb.Foo{...}
// any, err := anypb.New(foo) // any, err := anypb.New(foo)
@ -95,7 +95,7 @@ option objc_class_prefix = "GPB";
// //
// //
// JSON // JSON
// ==== //
// The JSON representation of an `Any` value uses the regular // The JSON representation of an `Any` value uses the regular
// representation of the deserialized, embedded message, with an // representation of the deserialized, embedded message, with an
// additional field `@type` which contains the type URL. Example: // additional field `@type` which contains the type URL. Example: