google-protobuf 4.31.1 → 4.32.0.rc.1

data/ext/google/protobuf_c/defs.c

@@ -93,9 +93,15 @@ const upb_DefPool* DescriptorPool_GetSymtab(VALUE desc_pool_rb) {
   return pool->symtab;
 }
 
+/**
+ * ruby-doc: DescriptorPool
+ *
+ * A DescriptorPool is the registry of all known Protobuf descriptor objects.
+ *
+ */
+
 /*
- * call-seq:
- *     DescriptorPool.new => pool
+ * ruby-doc: DescriptorPool.new
  *
  * Creates a new, empty, descriptor pool.
  */
@@ -112,10 +118,14 @@ static VALUE DescriptorPool_alloc(VALUE klass) {
 }
 
 /*
- * call-seq:
- *     DescriptorPool.add_serialized_file(serialized_file_proto)
+ * ruby-doc: DescriptorPool#add_serialized_file
+ *
+ * Adds the given serialized
+ * {https://protobuf.com/docs/descriptors#file-descriptors FileDescriptorProto}
+ * to the pool.
  *
- * Adds the given serialized FileDescriptorProto to the pool.
+ * @param serialized_file_proto [String]
+ * @return [FileDescriptor]
  */
 VALUE DescriptorPool_add_serialized_file(VALUE _self,
                                          VALUE serialized_file_proto) {
@@ -143,11 +153,14 @@ VALUE DescriptorPool_add_serialized_file(VALUE _self,
 }
 
 /*
- * call-seq:
- *     DescriptorPool.lookup(name) => descriptor
+ * ruby-doc: DescriptorPool#lookup
  *
- * Finds a Descriptor, EnumDescriptor, FieldDescriptor or ServiceDescriptor by
+ * Finds a {Descriptor}, {EnumDescriptor},
+ * {FieldDescriptor} or {ServiceDescriptor} by
  * name and returns it, or nil if none exists with the given name.
+ *
+ * @param name [String]
+ * @return [Descriptor,EnumDescriptor,FieldDescriptor,ServiceDescriptor]
  */
 static VALUE DescriptorPool_lookup(VALUE _self, VALUE name) {
   DescriptorPool* self = ruby_to_DescriptorPool(_self);
@@ -187,13 +200,14 @@ static VALUE DescriptorPool_lookup(VALUE _self, VALUE name) {
 }
 
 /*
- * call-seq:
- *     DescriptorPool.generated_pool => descriptor_pool
+ * ruby-doc: DescriptorPool.generated_pool
  *
- * Class method that returns the global DescriptorPool. This is a singleton into
- * which generated-code message and enum types are registered. The user may also
- * register types in this pool for convenience so that they do not have to hold
- * a reference to a private pool instance.
+ * Class method that returns the global {DescriptorPool}. This is a singleton
+ * into which generated-code message and enum types are registered. The user may
+ * also register types in this pool for convenience so that they do not have to
+ * hold a reference to a private pool instance.
+ *
+ * @return [DescriptorPool]
  */
 static VALUE DescriptorPool_generated_pool(VALUE _self) {
   return generated_pool;
@@ -290,8 +304,13 @@ static VALUE decode_options(VALUE self, const char* option_type, int size,
 }
 
 /*
- * call-seq:
- *     Descriptor.new => descriptor
+ * ruby-doc: Descriptor
+ *
+ * A Descriptor provides information about a given Protobuf definition.
+ */
+
+/*
+ * ruby-doc: Descriptor.initialize
  *
  * Creates a new, empty, message type descriptor. At a minimum, its name must be
  * set before it is added to a pool. It cannot be used to create messages until
@@ -329,10 +348,11 @@ static VALUE Descriptor_initialize(VALUE _self, VALUE cookie,
 }
 
 /*
- * call-seq:
- *    Descriptor.file_descriptor
+ * ruby-doc: Descriptor#file_descriptor
  *
- * Returns the FileDescriptor object this message belongs to.
+ * Returns the {FileDescriptor} object this message belongs to.
+ *
+ * @return [FileDescriptor]
  */
 static VALUE Descriptor_file_descriptor(VALUE _self) {
   Descriptor* self = ruby_to_Descriptor(_self);
@@ -341,11 +361,12 @@ static VALUE Descriptor_file_descriptor(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     Descriptor.name => name
+ * ruby-doc: Descriptor#name
  *
  * Returns the name of this message type as a fully-qualified string (e.g.,
  * My.Package.MessageType).
+ *
+ * @return [String]
  */
 static VALUE Descriptor_name(VALUE _self) {
   Descriptor* self = ruby_to_Descriptor(_self);
@@ -353,10 +374,12 @@ static VALUE Descriptor_name(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     Descriptor.each(&block)
+ * ruby-doc: Descriptor#each
  *
  * Iterates over fields in this message type, yielding to the block on each one.
+ *
+ * @yield [FieldDescriptor]
+ * @return [nil]
  */
 static VALUE Descriptor_each(VALUE _self) {
   Descriptor* self = ruby_to_Descriptor(_self);
@@ -371,11 +394,13 @@ static VALUE Descriptor_each(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     Descriptor.lookup(name) => FieldDescriptor
+ * ruby-doc: Descriptor#lookup
  *
  * Returns the field descriptor for the field with the given name, if present,
  * or nil if none.
+ *
+ * @param name [String]
+ * @return [FieldDescriptor]
  */
 static VALUE Descriptor_lookup(VALUE _self, VALUE name) {
   Descriptor* self = ruby_to_Descriptor(_self);
@@ -388,11 +413,13 @@ static VALUE Descriptor_lookup(VALUE _self, VALUE name) {
 }
 
 /*
- * call-seq:
- *     Descriptor.each_oneof(&block) => nil
+ * ruby-doc: Descriptor#each_oneof
  *
  * Invokes the given block for each oneof in this message type, passing the
- * corresponding OneofDescriptor.
+ * corresponding {OneofDescriptor}.
+ *
+ * @yield [OneofDescriptor]
+ * @return [nil]
  */
 static VALUE Descriptor_each_oneof(VALUE _self) {
   Descriptor* self = ruby_to_Descriptor(_self);
@@ -407,11 +434,13 @@ static VALUE Descriptor_each_oneof(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     Descriptor.lookup_oneof(name) => OneofDescriptor
+ * ruby-doc: Descriptor#lookup_oneof
  *
  * Returns the oneof descriptor for the oneof with the given name, if present,
  * or nil if none.
+ *
+ * @param name [String]
+ * @return [OneofDescriptor]
  */
 static VALUE Descriptor_lookup_oneof(VALUE _self, VALUE name) {
   Descriptor* self = ruby_to_Descriptor(_self);
@@ -424,10 +453,11 @@ static VALUE Descriptor_lookup_oneof(VALUE _self, VALUE name) {
 }
 
 /*
- * call-seq:
- *     Descriptor.msgclass => message_klass
+ * ruby-doc: Descriptor#msgclass
  *
  * Returns the Ruby class created for this message type.
+ *
+ * @return [Class<Google::Protobuf::AbstractMessage>]
  */
 static VALUE Descriptor_msgclass(VALUE _self) {
   Descriptor* self = ruby_to_Descriptor(_self);
@@ -438,10 +468,13 @@ static VALUE Descriptor_msgclass(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     Descriptor.options => options
+ * ruby-doc: Descriptor#options
  *
- * Returns the `MessageOptions` for this `Descriptor`.
+ * Returns the
+ * {https://github.com/protocolbuffers/protobuf/blob/v30.2/src/google/protobuf/descriptor.proto#L571
+ * MessageOptions} for this {Descriptor}.
+ *
+ * @return [MessageOptions]
  */
 static VALUE Descriptor_options(VALUE _self) {
   Descriptor* self = ruby_to_Descriptor(_self);
@@ -458,10 +491,13 @@ static VALUE Descriptor_options(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     Descriptor.to_proto => DescriptorProto
+ * ruby-doc: Descriptor#to_proto
  *
- * Returns the `DescriptorProto` of this `Descriptor`.
+ * Returns the
+ * {https://github.com/protocolbuffers/protobuf/blob/v30.2/src/google/protobuf/descriptor.proto#L147
+ * DescriptorProto} of this {Descriptor}.
+ *
+ * @return [DescriptorProto]
  */
 static VALUE Descriptor_to_proto(VALUE _self) {
   Descriptor* self = ruby_to_Descriptor(_self);
@@ -534,9 +570,15 @@ static VALUE FileDescriptor_alloc(VALUE klass) {
   return ret;
 }
 
+/**
+ * ruby-doc: FileDescriptor
+ *
+ * A FileDescriptor provides information about all Protobuf definitions in a
+ * particular file.
+ */
+
 /*
- * call-seq:
- *     FileDescriptor.new => file
+ * ruby-doc: FileDescriptor#initialize
  *
  * Returns a new file descriptor. May
  * to a builder.
@@ -557,10 +599,11 @@ static VALUE FileDescriptor_initialize(VALUE _self, VALUE cookie,
 }
 
 /*
- * call-seq:
- *     FileDescriptor.name => name
+ * ruby-doc: FileDescriptor#name
  *
  * Returns the name of the file.
+ *
+ * @return [String]
  */
 static VALUE FileDescriptor_name(VALUE _self) {
   FileDescriptor* self = ruby_to_FileDescriptor(_self);
@@ -569,10 +612,13 @@ static VALUE FileDescriptor_name(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     FileDescriptor.options => options
+ * ruby-doc: FileDescriptor#options
+ *
+ * Returns the
+ * {https://github.com/protocolbuffers/protobuf/blob/v30.2/src/google/protobuf/descriptor.proto#L442
+ * FileOptions} for this {FileDescriptor}.
  *
- * Returns the `FileOptions` for this `FileDescriptor`.
+ * @return [FileOptions]
  */
 static VALUE FileDescriptor_options(VALUE _self) {
   FileDescriptor* self = ruby_to_FileDescriptor(_self);
@@ -587,10 +633,13 @@ static VALUE FileDescriptor_options(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     FileDescriptor.to_proto => FileDescriptorProto
+ * ruby-doc: FileDescriptor#to_proto
+ *
+ * Returns the
+ * {https://github.com/protocolbuffers/protobuf/blob/v30.2/src/google/protobuf/descriptor.proto#L104
+ * FileDescriptorProto} of this {FileDescriptor}.
  *
- * Returns the `FileDescriptorProto` of this `FileDescriptor`.
+ * @return [FileDescriptorProto]
  */
 static VALUE FileDescriptor_to_proto(VALUE _self) {
   FileDescriptor* self = ruby_to_FileDescriptor(_self);
@@ -651,9 +700,15 @@ static FieldDescriptor* ruby_to_FieldDescriptor(VALUE val) {
   return ret;
 }
 
+/**
+ * ruby-doc: FieldDescriptor
+ *
+ * A FieldDescriptor provides information about the Protobuf definition of a
+ * field inside a {Descriptor}.
+ */
+
 /*
- * call-seq:
- *     FieldDescriptor.new => field
+ * ruby-doc: FieldDescriptor#initialize
  *
  * Returns a new field descriptor. Its name, type, etc. must be set before it is
  * added to a message type.
@@ -687,10 +742,11 @@ static VALUE FieldDescriptor_initialize(VALUE _self, VALUE cookie,
 }
 
 /*
- * call-seq:
- *     FieldDescriptor.name => name
+ * ruby-doc: FieldDescriptor#name
  *
  * Returns the name of this field.
+ *
+ * @return [String]
  */
 static VALUE FieldDescriptor_name(VALUE _self) {
   FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
@@ -755,14 +811,15 @@ static VALUE descriptortype_to_ruby(upb_FieldType type) {
 }
 
 /*
- * call-seq:
- *     FieldDescriptor.type => type
+ * ruby-doc: FieldDescriptor#type
  *
  * Returns this field's type, as a Ruby symbol, or nil if not yet set.
  *
  * Valid field types are:
  *     :int32, :int64, :uint32, :uint64, :float, :double, :bool, :string,
  *     :bytes, :message.
+ *
+ * @return [Symbol]
  */
 static VALUE FieldDescriptor__type(VALUE _self) {
   FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
@@ -770,10 +827,11 @@ static VALUE FieldDescriptor__type(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     FieldDescriptor.default => default
+ * ruby-doc: FieldDescriptor#default
  *
  * Returns this field's default, as a Ruby object, or nil if not yet set.
+ *
+ * @return [Object,nil]
  */
 static VALUE FieldDescriptor_default(VALUE _self) {
   FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
@@ -788,10 +846,11 @@ static VALUE FieldDescriptor_default(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     FieldDescriptor.has_presence? => bool
+ * ruby-doc: FieldDescriptor.has_presence?
  *
  * Returns whether this field tracks presence.
+ *
+ * @return [Boolean]
  */
 static VALUE FieldDescriptor_has_presence(VALUE _self) {
   FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
@@ -799,10 +858,11 @@ static VALUE FieldDescriptor_has_presence(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     FieldDescriptor.required? => bool
+ * ruby-doc: FieldDescriptor#required?
  *
  * Returns whether this is a required field.
+ *
+ * @return [Boolean]
  */
 static VALUE FieldDescriptor_is_required(VALUE _self) {
   FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
@@ -810,10 +870,10 @@ static VALUE FieldDescriptor_is_required(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     FieldDescriptor.repeated? => bool
+ * ruby-doc: FieldDescriptor#repeated?
  *
  * Returns whether this is a repeated field.
+ * @return [Boolean]
  */
 static VALUE FieldDescriptor_is_repeated(VALUE _self) {
   FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
@@ -821,10 +881,10 @@ static VALUE FieldDescriptor_is_repeated(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     FieldDescriptor.is_packed? => bool
+ * ruby-doc: FieldDescriptor#is_packed?
  *
  * Returns whether this is a repeated field that uses packed encoding.
+ * @return [Boolean]
  */
 static VALUE FieldDescriptor_is_packed(VALUE _self) {
   FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
@@ -832,10 +892,11 @@ static VALUE FieldDescriptor_is_packed(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     FieldDescriptor.json_name => json_name
+ * ruby-doc: FieldDescriptor#json_name
  *
  * Returns this field's json_name, as a Ruby string, or nil if not yet set.
+ *
+ * @return [String,nil]
  */
 static VALUE FieldDescriptor_json_name(VALUE _self) {
   FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
@@ -845,15 +906,14 @@ static VALUE FieldDescriptor_json_name(VALUE _self) {
 }
 
 /*
- * DEPRECATED: Use repeated? or required? instead.
- *
- * call-seq:
- *     FieldDescriptor.label => label
+ * ruby-doc: FieldDescriptor#label
  *
  * Returns this field's label (i.e., plurality), as a Ruby symbol.
- *
  * Valid field labels are:
- *     :optional, :repeated
+ *   :optional, :repeated
+ *
+ * @return [Symbol]
+ * @deprecated Use {#repeated?} or {#required?} instead.
  */
 static VALUE FieldDescriptor_label(VALUE _self) {
   FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
@@ -873,10 +933,11 @@ static VALUE FieldDescriptor_label(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     FieldDescriptor.number => number
+ * ruby-doc: FieldDescriptor#number
  *
  * Returns the tag number for this field.
+ *
+ * @return [Integer]
  */
 static VALUE FieldDescriptor_number(VALUE _self) {
   FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
@@ -884,13 +945,14 @@ static VALUE FieldDescriptor_number(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     FieldDescriptor.submsg_name => submsg_name
+ * ruby-doc: FieldDescriptor#submsg_name
  *
  * Returns the name of the message or enum type corresponding to this field, if
  * it is a message or enum field (respectively), or nil otherwise. This type
  * name will be resolved within the context of the pool to which the containing
  * message type is added.
+ *
+ * @return [String,nil]
  */
 static VALUE FieldDescriptor_submsg_name(VALUE _self) {
   FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
@@ -907,13 +969,14 @@ static VALUE FieldDescriptor_submsg_name(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     FieldDescriptor.subtype => message_or_enum_descriptor
+ * ruby-doc: FieldDescriptor#subtype
  *
  * Returns the message or enum descriptor corresponding to this field's type if
  * it is a message or enum field, respectively, or nil otherwise. Cannot be
  * called *until* the containing message type is added to a pool (and thus
  * resolved).
+ *
+ * @return [Descriptor,EnumDescriptor,nil]
  */
 static VALUE FieldDescriptor_subtype(VALUE _self) {
   FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
@@ -930,11 +993,13 @@ static VALUE FieldDescriptor_subtype(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     FieldDescriptor.get(message) => value
+ * ruby-doc: FieldDescriptor#get
  *
  * Returns the value set for this field on the given message. Raises an
  * exception if message is of the wrong type.
+ *
+ * @param message [AbstractMessage]
+ * @return [Object]
  */
 static VALUE FieldDescriptor_get(VALUE _self, VALUE msg_rb) {
   FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
@@ -950,11 +1015,13 @@ static VALUE FieldDescriptor_get(VALUE _self, VALUE msg_rb) {
 }
 
 /*
- * call-seq:
- *     FieldDescriptor.has?(message) => boolean
+ * ruby-doc: FieldDescriptor.has?
  *
  * Returns whether the value is set on the given message. Raises an
  * exception when calling for fields that do not have presence.
+ *
+ * @param message [AbstractMessage]
+ * @return [Boolean]
  */
 static VALUE FieldDescriptor_has(VALUE _self, VALUE msg_rb) {
   FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
@@ -971,10 +1038,12 @@ static VALUE FieldDescriptor_has(VALUE _self, VALUE msg_rb) {
 }
 
 /*
- * call-seq:
- *     FieldDescriptor.clear(message)
+ * ruby-doc: FieldDescriptor#clear
  *
  * Clears the field from the message if it's set.
+ *
+ * @param message [AbstractMessage]
+ * @return [nil]
  */
 static VALUE FieldDescriptor_clear(VALUE _self, VALUE msg_rb) {
   FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
@@ -990,12 +1059,14 @@ static VALUE FieldDescriptor_clear(VALUE _self, VALUE msg_rb) {
 }
 
 /*
- * call-seq:
- *     FieldDescriptor.set(message, value)
+ * ruby-doc: FieldDescriptor#set
  *
  * Sets the value corresponding to this field to the given value on the given
  * message. Raises an exception if message is of the wrong type. Performs the
  * ordinary type-checks for field setting.
+ *
+ * @param message [AbstractMessage]
+ * @param value [Object]
  */
 static VALUE FieldDescriptor_set(VALUE _self, VALUE msg_rb, VALUE value) {
   FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
@@ -1015,10 +1086,13 @@ static VALUE FieldDescriptor_set(VALUE _self, VALUE msg_rb, VALUE value) {
 }
 
 /*
- * call-seq:
- *     FieldDescriptor.options => options
+ * ruby-doc: FieldDescriptor#options
+ *
+ * Returns the
+ * {https://github.com/protocolbuffers/protobuf/blob/v30.2/src/google/protobuf/descriptor.proto#L656
+ * FieldOptions} for this {FieldDescriptor}.
  *
- * Returns the `FieldOptions` for this `FieldDescriptor`.
+ * @return [FieldOptions]
  */
 static VALUE FieldDescriptor_options(VALUE _self) {
   FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
@@ -1034,10 +1108,13 @@ static VALUE FieldDescriptor_options(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     FieldDescriptor.to_proto => FieldDescriptorProto
+ * ruby-doc: FieldDescriptor#to_proto
+ *
+ * Returns the
+ * {https://github.com/protocolbuffers/protobuf/blob/v30.2/src/google/protobuf/descriptor.proto#L236
+ * FieldDescriptorProto} of this {FieldDescriptor}.
  *
- * Returns the `FieldDescriptorProto` of this `FieldDescriptor`.
+ * @return [FieldDescriptorProto]
  */
 static VALUE FieldDescriptor_to_proto(VALUE _self) {
   FieldDescriptor* self = ruby_to_FieldDescriptor(_self);
@@ -1110,9 +1187,15 @@ static OneofDescriptor* ruby_to_OneofDescriptor(VALUE val) {
   return ret;
 }
 
+/**
+ * ruby-doc: OneofDescriptor
+ *
+ * A OneofDescriptor provides information about the Protobuf definition of a
+ * oneof inside a {Descriptor}.
+ */
+
 /*
- * call-seq:
- *     OneofDescriptor.new => oneof_descriptor
+ * ruby-doc: OneofDescriptor#initialize
  *
  * Creates a new, empty, oneof descriptor. The oneof may only be modified prior
  * to being added to a message descriptor which is subsequently added to a pool.
@@ -1147,10 +1230,11 @@ static VALUE OneofDescriptor_initialize(VALUE _self, VALUE cookie,
 }
 
 /*
- * call-seq:
- *     OneofDescriptor.name => name
+ * ruby-doc: OneofDescriptor#name
  *
  * Returns the name of this oneof.
+ *
+ * @return [String]
  */
 static VALUE OneofDescriptor_name(VALUE _self) {
   OneofDescriptor* self = ruby_to_OneofDescriptor(_self);
@@ -1158,10 +1242,12 @@ static VALUE OneofDescriptor_name(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     OneofDescriptor.each(&block) => nil
+ * ruby-doc: OneofDescriptor#each
  *
  * Iterates through fields in this oneof, yielding to the block on each one.
+ *
+ * @yield [FieldDescriptor]
+ * @return [nil]
  */
 static VALUE OneofDescriptor_each(VALUE _self) {
   OneofDescriptor* self = ruby_to_OneofDescriptor(_self);
@@ -1176,10 +1262,13 @@ static VALUE OneofDescriptor_each(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     OneofDescriptor.options => options
+ * ruby-doc: OneofDescriptor#options
+ *
+ * Returns the
+ * {https://github.com/protocolbuffers/protobuf/blob/v30.2/src/google/protobuf/descriptor.proto#L824
+ * OneofOptions} for this {OneofDescriptor}.
  *
- * Returns the `OneofOptions` for this `OneofDescriptor`.
+ * @return [OneofOptions]
  */
 static VALUE OneOfDescriptor_options(VALUE _self) {
   OneofDescriptor* self = ruby_to_OneofDescriptor(_self);
@@ -1195,10 +1284,13 @@ static VALUE OneOfDescriptor_options(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     OneofDescriptor.to_proto => OneofDescriptorProto
+ * ruby-doc: OneofDescriptor#to_proto
+ *
+ * Returns the
+ * {https://github.com/protocolbuffers/protobuf/blob/v30.2/src/google/protobuf/descriptor.proto#L343
+ * OneofDescriptorProto} of this {OneofDescriptor}.
  *
- * Returns the `OneofDescriptorProto` of this `OneofDescriptor`.
+ * @return [OneofDescriptorProto]
  */
 static VALUE OneOfDescriptor_to_proto(VALUE _self) {
   OneofDescriptor* self = ruby_to_OneofDescriptor(_self);
@@ -1275,6 +1367,13 @@ const upb_EnumDef* EnumDescriptor_GetEnumDef(VALUE enum_desc_rb) {
   return desc->enumdef;
 }
 
+/**
+ * ruby-doc: EnumDescriptor
+ *
+ * An EnumDescriptor provides information about the Protobuf definition of an
+ * enum inside a {Descriptor}.
+ */
+
 /*
  * call-seq:
  *    EnumDescriptor.new(c_only_cookie, ptr) => EnumDescriptor
@@ -1297,10 +1396,11 @@ static VALUE EnumDescriptor_initialize(VALUE _self, VALUE cookie,
 }
 
 /*
- * call-seq:
- *    EnumDescriptor.file_descriptor
+ * ruby-doc: EnumDescriptor#file_descriptor
  *
- * Returns the FileDescriptor object this enum belongs to.
+ * Returns the {FileDescriptor} object this enum belongs to.
+ *
+ * @return [FileDescriptor]
  */
 static VALUE EnumDescriptor_file_descriptor(VALUE _self) {
   EnumDescriptor* self = ruby_to_EnumDescriptor(_self);
@@ -1309,10 +1409,11 @@ static VALUE EnumDescriptor_file_descriptor(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     EnumDescriptor.is_closed? => bool
+ * ruby-doc: EnumDescriptor#is_closed?
  *
  * Returns whether this enum is open or closed.
+ *
+ * @return [Boolean]
  */
 static VALUE EnumDescriptor_is_closed(VALUE _self) {
   EnumDescriptor* self = ruby_to_EnumDescriptor(_self);
@@ -1320,10 +1421,11 @@ static VALUE EnumDescriptor_is_closed(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     EnumDescriptor.name => name
+ * ruby-doc: EnumDescriptor#name
  *
  * Returns the name of this enum type.
+ *
+ * @return [String]
  */
 static VALUE EnumDescriptor_name(VALUE _self) {
   EnumDescriptor* self = ruby_to_EnumDescriptor(_self);
@@ -1331,11 +1433,13 @@ static VALUE EnumDescriptor_name(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     EnumDescriptor.lookup_name(name) => value
+ * ruby-doc: EnumDescriptor#lookup_name
  *
  * Returns the numeric value corresponding to the given key name (as a Ruby
  * symbol), or nil if none.
+ *
+ * @param name [Symbol]
+ * @return [Integer,nil]
  */
 static VALUE EnumDescriptor_lookup_name(VALUE _self, VALUE name) {
   EnumDescriptor* self = ruby_to_EnumDescriptor(_self);
@@ -1350,11 +1454,13 @@ static VALUE EnumDescriptor_lookup_name(VALUE _self, VALUE name) {
 }
 
 /*
- * call-seq:
- *     EnumDescriptor.lookup_value(name) => value
+ * ruby-doc: EnumDescriptor#lookup_value
  *
  * Returns the key name (as a Ruby symbol) corresponding to the integer value,
  * or nil if none.
+ *
+ * @param name [Integer]
+ * @return [Symbol,nil]
  */
 static VALUE EnumDescriptor_lookup_value(VALUE _self, VALUE number) {
   EnumDescriptor* self = ruby_to_EnumDescriptor(_self);
@@ -1369,11 +1475,13 @@ static VALUE EnumDescriptor_lookup_value(VALUE _self, VALUE number) {
 }
 
 /*
- * call-seq:
- *     EnumDescriptor.each(&block)
+ * ruby-doc: EnumDescriptor#each
  *
  * Iterates over key => value mappings in this enum's definition, yielding to
  * the block with (key, value) arguments for each one.
+ *
+ * @yield [Symbol, Integer]
+ * @return [nil]
  */
 static VALUE EnumDescriptor_each(VALUE _self) {
   EnumDescriptor* self = ruby_to_EnumDescriptor(_self);
@@ -1390,10 +1498,11 @@ static VALUE EnumDescriptor_each(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     EnumDescriptor.enummodule => module
+ * ruby-doc: EnumDescriptor#enummodule
  *
  * Returns the Ruby module corresponding to this enum type.
+ *
+ * @return [Module]
  */
 static VALUE EnumDescriptor_enummodule(VALUE _self) {
   EnumDescriptor* self = ruby_to_EnumDescriptor(_self);
@@ -1404,10 +1513,13 @@ static VALUE EnumDescriptor_enummodule(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     EnumDescriptor.options => options
+ * ruby-doc: EnumDescriptor#options
  *
- * Returns the `EnumOptions` for this `EnumDescriptor`.
+ * Returns the
+ * {https://github.com/protocolbuffers/protobuf/blob/v30.2/src/google/protobuf/descriptor.proto#L838
+ * EnumOptions} for this {EnumDescriptor}.
+ *
+ * @return [EnumOptions]
  */
 static VALUE EnumDescriptor_options(VALUE _self) {
   EnumDescriptor* self = ruby_to_EnumDescriptor(_self);
@@ -1422,10 +1534,12 @@ static VALUE EnumDescriptor_options(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     EnumDescriptor.to_proto => EnumDescriptorProto
+ * ruby-doc: EnumDescriptor#to_proto
  *
- * Returns the `EnumDescriptorProto` of this `EnumDescriptor`.
+ * Returns the
+ * {https://github.com/protocolbuffers/protobuf/blob/v30.2/src/google/protobuf/descriptor.proto#L349
+ * EnumDescriptorProto} of this {EnumDescriptor}.
+ * @return [EnumDescriptorProto]
  */
 static VALUE EnumDescriptor_to_proto(VALUE _self) {
   EnumDescriptor* self = ruby_to_EnumDescriptor(_self);
@@ -1503,6 +1617,13 @@ static VALUE ServiceDescriptor_alloc(VALUE klass) {
   return ret;
 }
 
+/**
+ * ruby-doc: ServiceDescriptor
+ *
+ * A ServiceDescriptor provides information about the Protobuf definition of an
+ * RPC service.
+ */
+
 /*
  * call-seq:
  *    ServiceDescriptor.new(c_only_cookie, ptr) => ServiceDescriptor
@@ -1525,10 +1646,11 @@ static VALUE ServiceDescriptor_initialize(VALUE _self, VALUE cookie,
 }
 
 /*
- * call-seq:
- *     ServiceDescriptor.name => name
+ * ruby-doc: ServiceDescriptor#name
  *
  * Returns the name of this service.
+ *
+ * @return [String]
  */
 static VALUE ServiceDescriptor_name(VALUE _self) {
   ServiceDescriptor* self = ruby_to_ServiceDescriptor(_self);
@@ -1536,10 +1658,10 @@ static VALUE ServiceDescriptor_name(VALUE _self) {
 }
 
 /*
- * call-seq:
- *    ServiceDescriptor.file_descriptor
+ * ruby-doc: ServiceDescriptor#file_descriptor
  *
- * Returns the FileDescriptor object this service belongs to.
+ * Returns the {FileDescriptor} object this service belongs to.
+ * @return [FileDescriptor]
  */
 static VALUE ServiceDescriptor_file_descriptor(VALUE _self) {
   ServiceDescriptor* self = ruby_to_ServiceDescriptor(_self);
@@ -1548,10 +1670,12 @@ static VALUE ServiceDescriptor_file_descriptor(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     ServiceDescriptor.each(&block)
+ * ruby-doc: ServiceDescriptor#each
  *
  * Iterates over methods in this service, yielding to the block on each one.
+ *
+ * @yield [MethodDescriptor]
+ * @return [nil]
  */
 static VALUE ServiceDescriptor_each(VALUE _self) {
   ServiceDescriptor* self = ruby_to_ServiceDescriptor(_self);
@@ -1566,10 +1690,13 @@ static VALUE ServiceDescriptor_each(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     ServiceDescriptor.options => options
+ * ruby-doc: ServiceDescriptor#options
  *
- * Returns the `ServiceOptions` for this `ServiceDescriptor`.
+ * Returns the
+ * {https://github.com/protocolbuffers/protobuf/blob/v30.2/src/google/protobuf/descriptor.proto#L901
+ * ServiceOptions} for this {ServiceDescriptor}.
+ *
+ * @return [ServiceOptions]
  */
 static VALUE ServiceDescriptor_options(VALUE _self) {
   ServiceDescriptor* self = ruby_to_ServiceDescriptor(_self);
@@ -1586,10 +1713,13 @@ static VALUE ServiceDescriptor_options(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     ServiceDescriptor.to_proto => ServiceDescriptorProto
+ * ruby-doc: ServiceDescriptor#to_proto
  *
- * Returns the `ServiceDescriptorProto` of this `ServiceDescriptor`.
+ * Returns the
+ * {https://github.com/protocolbuffers/protobuf/blob/v30.2/src/google/protobuf/descriptor.proto#L386
+ * ServiceDescriptorProto} of this {ServiceDescriptor}.
+ *
+ * @return [ServiceDescriptorProto]
  */
 static VALUE ServiceDescriptor_to_proto(VALUE _self) {
   ServiceDescriptor* self = ruby_to_ServiceDescriptor(_self);
@@ -1662,6 +1792,13 @@ static VALUE MethodDescriptor_alloc(VALUE klass) {
   return ret;
 }
 
+/**
+ * ruby-doc: MethodDescriptor
+ *
+ * A MethodDescriptor provides information about the Protobuf definition of a
+ * method inside an RPC service.
+ */
+
 /*
  * call-seq:
  *    MethodDescriptor.new(c_only_cookie, ptr) => MethodDescriptor
@@ -1684,10 +1821,11 @@ static VALUE MethodDescriptor_initialize(VALUE _self, VALUE cookie,
 }
 
 /*
- * call-seq:
- *     MethodDescriptor.name => name
+ * ruby-doc: MethodDescriptor#name
  *
  * Returns the name of this method
+ *
+ * @return [String]
  */
 static VALUE MethodDescriptor_name(VALUE _self) {
   MethodDescriptor* self = ruby_to_MethodDescriptor(_self);
@@ -1695,10 +1833,13 @@ static VALUE MethodDescriptor_name(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     MethodDescriptor.options => options
+ * ruby-doc: MethodDescriptor#options
  *
- * Returns the `MethodOptions` for this `MethodDescriptor`.
+ * Returns the
+ * {https://github.com/protocolbuffers/protobuf/blob/v30.2/src/google/protobuf/descriptor.proto#L927
+ * MethodOptions} for this {MethodDescriptor}.
+ *
+ * @return [MethodOptions]
  */
 static VALUE MethodDescriptor_options(VALUE _self) {
   MethodDescriptor* self = ruby_to_MethodDescriptor(_self);
@@ -1715,10 +1856,11 @@ static VALUE MethodDescriptor_options(VALUE _self) {
 }
 
 /*
- * call-seq:
- *      MethodDescriptor.input_type => Descriptor
+ * ruby-doc: MethodDescriptor#input_type
  *
- * Returns the `Descriptor` for the request message type of this method
+ * Returns the {Descriptor} for the request message type of this method
+ *
+ * @return [Descriptor]
  */
 static VALUE MethodDescriptor_input_type(VALUE _self) {
   MethodDescriptor* self = ruby_to_MethodDescriptor(_self);
@@ -1727,10 +1869,11 @@ static VALUE MethodDescriptor_input_type(VALUE _self) {
 }
 
 /*
- * call-seq:
- *      MethodDescriptor.output_type => Descriptor
+ * ruby-doc: MethodDescriptor#output_type
+ *
+ * Returns the {Descriptor} for the response message type of this method
  *
- * Returns the `Descriptor` for the response message type of this method
+ * @return [Descriptor]
  */
 static VALUE MethodDescriptor_output_type(VALUE _self) {
   MethodDescriptor* self = ruby_to_MethodDescriptor(_self);
@@ -1739,10 +1882,11 @@ static VALUE MethodDescriptor_output_type(VALUE _self) {
 }
 
 /*
- * call-seq:
- *      MethodDescriptor.client_streaming => bool
+ * ruby-doc: MethodDescriptor#client_streaming
  *
  * Returns whether or not this is a streaming request method
+ *
+ * @return [Boolean]
  */
 static VALUE MethodDescriptor_client_streaming(VALUE _self) {
   MethodDescriptor* self = ruby_to_MethodDescriptor(_self);
@@ -1750,10 +1894,13 @@ static VALUE MethodDescriptor_client_streaming(VALUE _self) {
 }
 
 /*
- * call-seq:
- *     MethodDescriptor.to_proto => MethodDescriptorProto
+ * ruby-doc: MethodDescriptor#to_proto
+ *
+ * Returns the
+ * {https://github.com/protocolbuffers/protobuf/blob/v30.2/src/google/protobuf/descriptor.proto#L394
+ * MethodDescriptorProto} of this {MethodDescriptor}.
  *
- * Returns the `MethodDescriptorProto` of this `MethodDescriptor`.
+ * @return [MethodDescriptorProto]
  */
 static VALUE MethodDescriptor_to_proto(VALUE _self) {
   MethodDescriptor* self = ruby_to_MethodDescriptor(_self);
@@ -1771,10 +1918,11 @@ static VALUE MethodDescriptor_to_proto(VALUE _self) {
 }
 
 /*
- * call-seq:
- *      MethodDescriptor.server_streaming => bool
+ * ruby-doc: MethodDescriptor#server_streaming
  *
  * Returns whether or not this is a streaming response method
+ *
+ * @return [Boolean]
  */
 static VALUE MethodDescriptor_server_streaming(VALUE _self) {
   MethodDescriptor* self = ruby_to_MethodDescriptor(_self);