From 6ee16a9c60e734104aeb738503fe3f411c97bd88 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sat, 8 Jun 2019 22:48:09 +0200 Subject: [PATCH 1/4] Draft: Fix javadoc warnings in generated files --- .../compiler/java/java_doc_comment.cc | 44 ++++++++++++++++--- .../protobuf/compiler/java/java_doc_comment.h | 4 ++ .../protobuf/compiler/java/java_enum.cc | 2 + .../protobuf/compiler/java/java_enum_lite.cc | 2 + .../protobuf/compiler/java/java_message.cc | 2 + .../compiler/java/java_message_field.cc | 32 +++++++------- .../compiler/java/java_message_field_lite.cc | 4 +- .../compiler/java/java_primitive_field.cc | 16 +++---- .../java/java_primitive_field_lite.cc | 20 ++++----- .../compiler/java/java_string_field.cc | 24 +++++----- 10 files changed, 97 insertions(+), 53 deletions(-) diff --git a/src/google/protobuf/compiler/java/java_doc_comment.cc b/src/google/protobuf/compiler/java/java_doc_comment.cc index 29447ac005..9b0124549e 100644 --- a/src/google/protobuf/compiler/java/java_doc_comment.cc +++ b/src/google/protobuf/compiler/java/java_doc_comment.cc @@ -173,13 +173,10 @@ void WriteMessageDocComment(io::Printer* printer, const Descriptor* message) { } void WriteFieldDocComment(io::Printer* printer, const FieldDescriptor* field) { - // In theory we should have slightly different comments for setters, getters, - // etc., but in practice everyone already knows the difference between these - // so it's redundant information. - // We start the comment with the main body based on the comments from the - // .proto file (if present). We then end with the field declaration, e.g.: + // .proto file (if present). We then continue with the field declaration, e.g.: // optional string foo = 5; + // And then we end with the javadoc tags if applicable. // If the field is a group, the debug string might end with {. printer->Print("/**\n"); WriteDocCommentBody(printer, field); @@ -188,6 +185,43 @@ void WriteFieldDocComment(io::Printer* printer, const FieldDescriptor* field) { printer->Print(" */\n"); } +void WriteFieldGetterDocComment(io::Printer* printer, const FieldDescriptor* field) { + printer->Print("/**\n"); + WriteDocCommentBody(printer, field); + printer->Print(" * $def$\n", "def", + EscapeJavadoc(FirstLineOf(field->DebugString()))); + printer->Print(" * @return The $name$.\n", "name", field->camelcase_name()); + printer->Print(" */\n"); +} + +void WriteFieldHaserDocComment(io::Printer* printer, const FieldDescriptor* field) { + printer->Print("/**\n"); + WriteDocCommentBody(printer, field); + printer->Print(" * $def$\n", "def", + EscapeJavadoc(FirstLineOf(field->DebugString()))); + printer->Print(" * @return Whether the $name$ field is set.\n", "name", field->camelcase_name()); + printer->Print(" */\n"); +} + +void WriteFieldSetterDocComment(io::Printer* printer, const FieldDescriptor* field) { + printer->Print("/**\n"); + WriteDocCommentBody(printer, field); + printer->Print(" * $def$\n", "def", + EscapeJavadoc(FirstLineOf(field->DebugString()))); + printer->Print(" * @param value The $name$ to set.\n", "name", field->camelcase_name()); + printer->Print(" * @return This builder for chaining.\n"); + printer->Print(" */\n"); +} + +void WriteFieldClearerDocComment(io::Printer* printer, const FieldDescriptor* field) { + printer->Print("/**\n"); + WriteDocCommentBody(printer, field); + printer->Print(" * $def$\n", "def", + EscapeJavadoc(FirstLineOf(field->DebugString()))); + printer->Print(" * @return This builder for chaining.\n"); + printer->Print(" */\n"); +} + void WriteEnumDocComment(io::Printer* printer, const EnumDescriptor* enum_) { printer->Print("/**\n"); WriteDocCommentBody(printer, enum_); diff --git a/src/google/protobuf/compiler/java/java_doc_comment.h b/src/google/protobuf/compiler/java/java_doc_comment.h index ef9b3a9072..ce2eb988fb 100644 --- a/src/google/protobuf/compiler/java/java_doc_comment.h +++ b/src/google/protobuf/compiler/java/java_doc_comment.h @@ -54,6 +54,10 @@ namespace java { void WriteMessageDocComment(io::Printer* printer, const Descriptor* message); void WriteFieldDocComment(io::Printer* printer, const FieldDescriptor* field); +void WriteFieldGetterDocComment(io::Printer* printer, const FieldDescriptor* field); +void WriteFieldHaserDocComment(io::Printer* printer, const FieldDescriptor* field); +void WriteFieldSetterDocComment(io::Printer* printer, const FieldDescriptor* field); +void WriteFieldClearerDocComment(io::Printer* printer, const FieldDescriptor* field); void WriteEnumDocComment(io::Printer* printer, const EnumDescriptor* enum_); void WriteEnumValueDocComment(io::Printer* printer, const EnumValueDescriptor* value); diff --git a/src/google/protobuf/compiler/java/java_enum.cc b/src/google/protobuf/compiler/java/java_enum.cc index 0dade1c354..bf911be4b9 100644 --- a/src/google/protobuf/compiler/java/java_enum.cc +++ b/src/google/protobuf/compiler/java/java_enum.cc @@ -175,6 +175,8 @@ void EnumGenerator::Generate(io::Printer* printer) { "}\n" "\n" "/**\n" + " * @param value The number of the enum to look for.\n" + " * @return The enum associated with the given number.\n" " * @deprecated Use {@link #forNumber(int)} instead.\n" " */\n" "@java.lang.Deprecated\n" diff --git a/src/google/protobuf/compiler/java/java_enum_lite.cc b/src/google/protobuf/compiler/java/java_enum_lite.cc index a00624b5db..f8e0653d23 100644 --- a/src/google/protobuf/compiler/java/java_enum_lite.cc +++ b/src/google/protobuf/compiler/java/java_enum_lite.cc @@ -150,6 +150,8 @@ void EnumLiteGenerator::Generate(io::Printer* printer) { "}\n" "\n" "/**\n" + " * @param value The number of the enum to look for.\n" + " * @return The enum associated with the given number.\n" " * @deprecated Use {@link #forNumber(int)} instead.\n" " */\n" "@java.lang.Deprecated\n" diff --git a/src/google/protobuf/compiler/java/java_message.cc b/src/google/protobuf/compiler/java/java_message.cc index 5bbdccee08..63bbe02016 100644 --- a/src/google/protobuf/compiler/java/java_message.cc +++ b/src/google/protobuf/compiler/java/java_message.cc @@ -439,6 +439,8 @@ void ImmutableMessageGenerator::Generate(io::Printer* printer) { printer->Print( vars, "/**\n" + " * @param value The number of the enum to look for.\n" + " * @return The enum associated with the given number.\n" " * @deprecated Use {@link #forNumber(int)} instead.\n" " */\n" "@java.lang.Deprecated\n" diff --git a/src/google/protobuf/compiler/java/java_message_field.cc b/src/google/protobuf/compiler/java/java_message_field.cc index eb3ed51b1b..0b441a67f9 100644 --- a/src/google/protobuf/compiler/java/java_message_field.cc +++ b/src/google/protobuf/compiler/java/java_message_field.cc @@ -144,12 +144,12 @@ void ImmutableMessageFieldGenerator::GenerateInterfaceMembers( // interface so that builders can choose dynamically to either return a // message or a nested builder, so that asking for the interface doesn't // cause a message to ever be built. - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$boolean has$capitalized_name$();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$$type$ get$capitalized_name$();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print( variables_, "$deprecation$$type$OrBuilder get$capitalized_name$OrBuilder();\n"); @@ -161,14 +161,14 @@ void ImmutableMessageFieldGenerator::GenerateMembers( PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" " return $get_has_field_bit_message$;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print( variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" @@ -185,14 +185,14 @@ void ImmutableMessageFieldGenerator::GenerateMembers( "}\n"); printer->Annotate("{", "}", descriptor_); } else { - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" " return $name$_ != null;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print( variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" @@ -261,7 +261,7 @@ void ImmutableMessageFieldGenerator::GenerateBuilderMembers( // field of type "Field" called "Field". // boolean hasField() - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); if (support_field_presence) { printer->Print( variables_, @@ -279,14 +279,14 @@ void ImmutableMessageFieldGenerator::GenerateBuilderMembers( } // Field getField() - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); PrintNestedBuilderFunction( printer, "$deprecation$public $type$ ${$get$capitalized_name$$}$()", "return $name$_ == null ? $type$.getDefaultInstance() : $name$_;\n", "return $name$Builder_.getMessage();\n", NULL); // Field.Builder setField(Field value) - WriteFieldDocComment(printer, descriptor_); + WriteFieldSetterDocComment(printer, descriptor_); PrintNestedBuilderFunction( printer, "$deprecation$public Builder ${$set$capitalized_name$$}$($type$ value)", @@ -303,7 +303,7 @@ void ImmutableMessageFieldGenerator::GenerateBuilderMembers( "return this;\n"); // Field.Builder setField(Field.Builder builderForValue) - WriteFieldDocComment(printer, descriptor_); + WriteFieldSetterDocComment(printer, descriptor_); PrintNestedBuilderFunction( printer, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" @@ -347,7 +347,7 @@ void ImmutableMessageFieldGenerator::GenerateBuilderMembers( "return this;\n"); // Field.Builder clearField() - WriteFieldDocComment(printer, descriptor_); + WriteFieldClearerDocComment(printer, descriptor_); PrintNestedBuilderFunction( printer, "$deprecation$public Builder ${$clear$capitalized_name$$}$()", @@ -535,13 +535,13 @@ ImmutableMessageOneofFieldGenerator::~ImmutableMessageOneofFieldGenerator() {} void ImmutableMessageOneofFieldGenerator::GenerateMembers( io::Printer* printer) const { PrintExtraFieldInfo(variables_, printer); - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" " return $has_oneof_case_message$;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" " if ($has_oneof_case_message$) {\n" @@ -579,7 +579,7 @@ void ImmutableMessageOneofFieldGenerator::GenerateBuilderMembers( // field of type "Field" called "Field". // boolean hasField() - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" " return $has_oneof_case_message$;\n" @@ -587,7 +587,7 @@ void ImmutableMessageOneofFieldGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); // Field getField() - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); PrintNestedBuilderFunction( printer, "$deprecation$public $type$ ${$get$capitalized_name$$}$()", diff --git a/src/google/protobuf/compiler/java/java_message_field_lite.cc b/src/google/protobuf/compiler/java/java_message_field_lite.cc index 3a6909fc73..cc6563135e 100644 --- a/src/google/protobuf/compiler/java/java_message_field_lite.cc +++ b/src/google/protobuf/compiler/java/java_message_field_lite.cc @@ -121,9 +121,9 @@ int ImmutableMessageFieldLiteGenerator::GetNumBitsForMessage() const { void ImmutableMessageFieldLiteGenerator::GenerateInterfaceMembers( io::Printer* printer) const { - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$boolean has$capitalized_name$();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$$type$ get$capitalized_name$();\n"); } diff --git a/src/google/protobuf/compiler/java/java_primitive_field.cc b/src/google/protobuf/compiler/java/java_primitive_field.cc index 9aef29bd79..7eb7174489 100644 --- a/src/google/protobuf/compiler/java/java_primitive_field.cc +++ b/src/google/protobuf/compiler/java/java_primitive_field.cc @@ -219,7 +219,7 @@ void ImmutablePrimitiveFieldGenerator::GenerateMembers( printer->Print(variables_, "private $field_type$ $name$_;\n"); PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" @@ -228,7 +228,7 @@ void ImmutablePrimitiveFieldGenerator::GenerateMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" " return $name$_;\n" @@ -241,7 +241,7 @@ void ImmutablePrimitiveFieldGenerator::GenerateBuilderMembers( printer->Print(variables_, "private $field_type$ $name$_ $default_init$;\n"); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" @@ -250,7 +250,7 @@ void ImmutablePrimitiveFieldGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" " return $name$_;\n" @@ -492,7 +492,7 @@ void ImmutablePrimitiveOneofFieldGenerator::GenerateMembers( io::Printer* printer) const { PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" @@ -501,7 +501,7 @@ void ImmutablePrimitiveOneofFieldGenerator::GenerateMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" " if ($has_oneof_case_message$) {\n" @@ -515,7 +515,7 @@ void ImmutablePrimitiveOneofFieldGenerator::GenerateMembers( void ImmutablePrimitiveOneofFieldGenerator::GenerateBuilderMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" @@ -524,7 +524,7 @@ void ImmutablePrimitiveOneofFieldGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" " if ($has_oneof_case_message$) {\n" diff --git a/src/google/protobuf/compiler/java/java_primitive_field_lite.cc b/src/google/protobuf/compiler/java/java_primitive_field_lite.cc index 880bd92dac..6428b3da21 100644 --- a/src/google/protobuf/compiler/java/java_primitive_field_lite.cc +++ b/src/google/protobuf/compiler/java/java_primitive_field_lite.cc @@ -198,11 +198,11 @@ int ImmutablePrimitiveFieldLiteGenerator::GetNumBitsForMessage() const { void ImmutablePrimitiveFieldLiteGenerator::GenerateInterfaceMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$boolean has$capitalized_name$();\n"); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$$type$ get$capitalized_name$();\n"); } @@ -218,7 +218,7 @@ void ImmutablePrimitiveFieldLiteGenerator::GenerateMembers( printer->Print(variables_, "private $field_type$ $name$_;\n"); PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); printer->Print( variables_, "@java.lang.Override\n" @@ -228,7 +228,7 @@ void ImmutablePrimitiveFieldLiteGenerator::GenerateMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" @@ -264,7 +264,7 @@ void ImmutablePrimitiveFieldLiteGenerator::GenerateMembers( void ImmutablePrimitiveFieldLiteGenerator::GenerateBuilderMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); printer->Print( variables_, "@java.lang.Override\n" @@ -274,7 +274,7 @@ void ImmutablePrimitiveFieldLiteGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" @@ -347,7 +347,7 @@ void ImmutablePrimitiveOneofFieldLiteGenerator::GenerateMembers( io::Printer* printer) const { PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); printer->Print( variables_, "@java.lang.Override\n" @@ -357,7 +357,7 @@ void ImmutablePrimitiveOneofFieldLiteGenerator::GenerateMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" @@ -397,7 +397,7 @@ void ImmutablePrimitiveOneofFieldLiteGenerator::GenerateFieldInfo( void ImmutablePrimitiveOneofFieldLiteGenerator::GenerateBuilderMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); printer->Print( variables_, "@java.lang.Override\n" @@ -407,7 +407,7 @@ void ImmutablePrimitiveOneofFieldLiteGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" diff --git a/src/google/protobuf/compiler/java/java_string_field.cc b/src/google/protobuf/compiler/java/java_string_field.cc index 6ebc3e27c9..0a4592b322 100644 --- a/src/google/protobuf/compiler/java/java_string_field.cc +++ b/src/google/protobuf/compiler/java/java_string_field.cc @@ -190,14 +190,14 @@ int ImmutableStringFieldGenerator::GetNumBitsForBuilder() const { void ImmutableStringFieldGenerator::GenerateInterfaceMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$boolean has$capitalized_name$();\n"); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$java.lang.String get$capitalized_name$();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$com.google.protobuf.ByteString\n" " get$capitalized_name$Bytes();\n"); @@ -209,7 +209,7 @@ void ImmutableStringFieldGenerator::GenerateMembers( PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" @@ -218,7 +218,7 @@ void ImmutableStringFieldGenerator::GenerateMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print( variables_, "$deprecation$public java.lang.String ${$get$capitalized_name$$}$() {\n" @@ -242,7 +242,7 @@ void ImmutableStringFieldGenerator::GenerateMembers( " return s;\n" " }\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$public com.google.protobuf.ByteString\n" " ${$get$capitalized_name$Bytes$}$() {\n" @@ -265,7 +265,7 @@ void ImmutableStringFieldGenerator::GenerateBuilderMembers( printer->Print(variables_, "private java.lang.Object $name$_ $default_init$;\n"); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldHaserDocComment(printer, descriptor_); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" @@ -274,7 +274,7 @@ void ImmutableStringFieldGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print( variables_, "$deprecation$public java.lang.String ${$get$capitalized_name$$}$() {\n" @@ -299,7 +299,7 @@ void ImmutableStringFieldGenerator::GenerateBuilderMembers( " }\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldGetterDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$public com.google.protobuf.ByteString\n" " ${$get$capitalized_name$Bytes$}$() {\n" @@ -316,7 +316,7 @@ void ImmutableStringFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldSetterDocComment(printer, descriptor_); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " java.lang.String value) {\n" @@ -327,7 +327,7 @@ void ImmutableStringFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldClearerDocComment(printer, descriptor_); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -342,7 +342,7 @@ void ImmutableStringFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldSetterDocComment(printer, descriptor_); printer->Print( variables_, "$deprecation$public Builder ${$set$capitalized_name$Bytes$}$(\n" From 73e0d748b9acdc40b693f2879ce82ecb1a849b81 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sat, 15 Jun 2019 20:31:31 +0200 Subject: [PATCH 2/4] Switch to using enum based methods --- .../compiler/java/java_doc_comment.cc | 169 ++++++++++++++++-- .../protobuf/compiler/java/java_doc_comment.h | 32 +++- .../protobuf/compiler/java/java_enum_field.cc | 92 +++++----- .../compiler/java/java_enum_field_lite.cc | 119 ++++++------ .../compiler/java/java_message_field.cc | 32 ++-- .../compiler/java/java_message_field_lite.cc | 4 +- .../compiler/java/java_primitive_field.cc | 54 +++--- .../java/java_primitive_field_lite.cc | 24 +-- .../compiler/java/java_string_field.cc | 79 ++++---- .../compiler/java/java_string_field_lite.cc | 101 ++++++----- 10 files changed, 442 insertions(+), 264 deletions(-) diff --git a/src/google/protobuf/compiler/java/java_doc_comment.cc b/src/google/protobuf/compiler/java/java_doc_comment.cc index 9b0124549e..7926f10f84 100644 --- a/src/google/protobuf/compiler/java/java_doc_comment.cc +++ b/src/google/protobuf/compiler/java/java_doc_comment.cc @@ -185,42 +185,177 @@ void WriteFieldDocComment(io::Printer* printer, const FieldDescriptor* field) { printer->Print(" */\n"); } -void WriteFieldGetterDocComment(io::Printer* printer, const FieldDescriptor* field) { +void WriteFieldAccessorDocComment(io::Printer* printer, + const FieldDescriptor* field, + const FieldAccessorType type, + const bool builder) { printer->Print("/**\n"); WriteDocCommentBody(printer, field); printer->Print(" * $def$\n", "def", EscapeJavadoc(FirstLineOf(field->DebugString()))); - printer->Print(" * @return The $name$.\n", "name", field->camelcase_name()); + switch (type) { + case HAZZER: + printer->Print(" * @return Whether the $name$ field is set.\n", "name", + field->camelcase_name()); + break; + case GETTER: + printer->Print(" * @return The $name$.\n", "name", + field->camelcase_name()); + break; + case SETTER: + printer->Print(" * @param value The $name$ to set.\n", "name", + field->camelcase_name()); + break; + case CLEARER: + // Print nothing + break; + // Repeated + case LIST_COUNT: + printer->Print(" * @return The number of $name$(s).\n", "name", + field->camelcase_name()); + break; + case LIST_GETTER: + printer->Print(" * @return A list containing the $name$(s).\n", "name", + field->camelcase_name()); + break; + case LIST_INDEXED_GETTER: + printer->Print(" * @param index The index of the element to return.\n"); + printer->Print(" * @return The $name$(s) at the given index.\n", "name", + field->camelcase_name()); + break; + case LIST_INDEXED_SETTER: + printer->Print(" * @param index The index to set the value at.\n"); + printer->Print(" * @param value The $name$ to set.\n", "name", + field->camelcase_name()); + break; + case LIST_ADDER: + printer->Print(" * @param value The $name$ to add.\n", "name", + field->camelcase_name()); + break; + case LIST_MULTI_ADDER: + printer->Print(" * @param values The $name$(s) to add.\n", "name", + field->camelcase_name()); + break; + } + if (builder) { + printer->Print(" * @return This builder for chaining.\n"); + } printer->Print(" */\n"); } -void WriteFieldHaserDocComment(io::Printer* printer, const FieldDescriptor* field) { +void WriteFieldEnumValueAccessorDocComment(io::Printer* printer, + const FieldDescriptor* field, + const FieldAccessorType type, + const bool builder) { printer->Print("/**\n"); WriteDocCommentBody(printer, field); - printer->Print(" * $def$\n", "def", + printer->Print(" * $def$\n", "def", EscapeJavadoc(FirstLineOf(field->DebugString()))); - printer->Print(" * @return Whether the $name$ field is set.\n", "name", field->camelcase_name()); + switch (type) { + case HAZZER: + // Should never happen + break; + case GETTER: + printer->Print(" * @return The enum value for $name$.\n", "name", + field->camelcase_name()); + break; + case SETTER: + printer->Print(" * @param value The enum value for $name$ to set.\n", + "name", field->camelcase_name()); + break; + case CLEARER: + // Print nothing + break; + // Repeated + case LIST_COUNT: + // Should never happen + break; + case LIST_GETTER: + printer->Print(" * @return A list containing the enum values for $name$(s).\n", + "name", field->camelcase_name()); + break; + case LIST_INDEXED_GETTER: + printer->Print(" * @param index The index of the value to return.\n"); + printer->Print(" * @return The enum value of the $name$ at the given index.\n", + "name", field->camelcase_name()); + break; + case LIST_INDEXED_SETTER: + printer->Print(" * @param index The index of the value to return.\n"); + printer->Print(" * @param value The enum value of the $name$ to set.\n", + "name", field->camelcase_name()); + break; + case LIST_ADDER: + printer->Print(" * @param value The enum value of the $name$ to add.\n", + "name", field->camelcase_name()); + break; + case LIST_MULTI_ADDER: + printer->Print(" * @param values The enum values of the $name$(s) to add.\n", + "name", field->camelcase_name()); + break; + } + if (builder) { + printer->Print(" * @return This builder for chaining.\n"); + } printer->Print(" */\n"); } -void WriteFieldSetterDocComment(io::Printer* printer, const FieldDescriptor* field) { +void WriteFieldStringBytesAccessorDocComment(io::Printer* printer, + const FieldDescriptor* field, + const FieldAccessorType type, + const bool builder) { printer->Print("/**\n"); WriteDocCommentBody(printer, field); - printer->Print(" * $def$\n", "def", + printer->Print(" * $def$\n", "def", EscapeJavadoc(FirstLineOf(field->DebugString()))); - printer->Print(" * @param value The $name$ to set.\n", "name", field->camelcase_name()); - printer->Print(" * @return This builder for chaining.\n"); + switch (type) { + case HAZZER: + // Should never happen + break; + case GETTER: + printer->Print(" * @return The bytes for $name$.\n", "name", + field->camelcase_name()); + break; + case SETTER: + printer->Print(" * @param value The bytes for $name$ to set.\n", + "name", field->camelcase_name()); + break; + case CLEARER: + // Print nothing + break; + // Repeated + case LIST_COUNT: + // Should never happen + break; + case LIST_GETTER: + printer->Print(" * @return A list containing the bytes for $name$(s).\n", + "name", field->camelcase_name()); + break; + case LIST_INDEXED_GETTER: + printer->Print(" * @param index The index of the value to return.\n"); + printer->Print(" * @return The bytes of the $name$ at the given index.\n", + "name", field->camelcase_name()); + break; + case LIST_INDEXED_SETTER: + printer->Print(" * @param index The index of the value to return.\n"); + printer->Print(" * @param value The bytes of the $name$ to set.\n", + "name", field->camelcase_name()); + break; + case LIST_ADDER: + printer->Print(" * @param value The bytes of the $name$ to add.\n", + "name", field->camelcase_name()); + break; + case LIST_MULTI_ADDER: + printer->Print(" * @param values The bytes of the $name$(s) to add.\n", + "name", field->camelcase_name()); + break; + } + if (builder) { + printer->Print(" * @return This builder for chaining.\n"); + } printer->Print(" */\n"); } -void WriteFieldClearerDocComment(io::Printer* printer, const FieldDescriptor* field) { - printer->Print("/**\n"); - WriteDocCommentBody(printer, field); - printer->Print(" * $def$\n", "def", - EscapeJavadoc(FirstLineOf(field->DebugString()))); - printer->Print(" * @return This builder for chaining.\n"); - printer->Print(" */\n"); -} +// Enum void WriteEnumDocComment(io::Printer* printer, const EnumDescriptor* enum_) { printer->Print("/**\n"); diff --git a/src/google/protobuf/compiler/java/java_doc_comment.h b/src/google/protobuf/compiler/java/java_doc_comment.h index ce2eb988fb..a5ef09690c 100644 --- a/src/google/protobuf/compiler/java/java_doc_comment.h +++ b/src/google/protobuf/compiler/java/java_doc_comment.h @@ -52,12 +52,36 @@ namespace protobuf { namespace compiler { namespace java { +enum FieldAccessorType { + + HAZZER, + GETTER, + SETTER, + CLEARER, + // Repeated + LIST_COUNT, + LIST_GETTER, + LIST_INDEXED_GETTER, + LIST_INDEXED_SETTER, + LIST_ADDER, + LIST_MULTI_ADDER + +}; + void WriteMessageDocComment(io::Printer* printer, const Descriptor* message); void WriteFieldDocComment(io::Printer* printer, const FieldDescriptor* field); -void WriteFieldGetterDocComment(io::Printer* printer, const FieldDescriptor* field); -void WriteFieldHaserDocComment(io::Printer* printer, const FieldDescriptor* field); -void WriteFieldSetterDocComment(io::Printer* printer, const FieldDescriptor* field); -void WriteFieldClearerDocComment(io::Printer* printer, const FieldDescriptor* field); +void WriteFieldAccessorDocComment(io::Printer* printer, + const FieldDescriptor* field, + const FieldAccessorType type, + const bool builder = false); +void WriteFieldEnumValueAccessorDocComment(io::Printer* printer, + const FieldDescriptor* field, + const FieldAccessorType type, + const bool builder = false); +void WriteFieldStringBytesAccessorDocComment(io::Printer* printer, + const FieldDescriptor* field, + const FieldAccessorType type, + const bool builder = false); void WriteEnumDocComment(io::Printer* printer, const EnumDescriptor* enum_); void WriteEnumValueDocComment(io::Printer* printer, const EnumValueDescriptor* value); diff --git a/src/google/protobuf/compiler/java/java_enum_field.cc b/src/google/protobuf/compiler/java/java_enum_field.cc index 280efaf579..c6e0905fdc 100644 --- a/src/google/protobuf/compiler/java/java_enum_field.cc +++ b/src/google/protobuf/compiler/java/java_enum_field.cc @@ -156,16 +156,16 @@ int ImmutableEnumFieldGenerator::GetNumBitsForBuilder() const { void ImmutableEnumFieldGenerator::GenerateInterfaceMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print(variables_, "$deprecation$boolean has$capitalized_name$();\n"); } if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$int get$capitalized_name$Value();\n"); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$$type$ get$capitalized_name$();\n"); } @@ -173,7 +173,7 @@ void ImmutableEnumFieldGenerator::GenerateMembers(io::Printer* printer) const { printer->Print(variables_, "private int $name$_;\n"); PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" @@ -182,7 +182,7 @@ void ImmutableEnumFieldGenerator::GenerateMembers(io::Printer* printer) const { printer->Annotate("{", "}", descriptor_); } if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "$deprecation$public int ${$get$capitalized_name$Value$}$() {\n" @@ -190,7 +190,7 @@ void ImmutableEnumFieldGenerator::GenerateMembers(io::Printer* printer) const { "}\n"); printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" " @SuppressWarnings(\"deprecation\")\n" @@ -204,7 +204,7 @@ void ImmutableEnumFieldGenerator::GenerateBuilderMembers( io::Printer* printer) const { printer->Print(variables_, "private int $name$_ = $default_number$;\n"); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" @@ -213,14 +213,14 @@ void ImmutableEnumFieldGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); } if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "$deprecation$public int ${$get$capitalized_name$Value$}$() {\n" " return $name$_;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, SETTER); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$Value$}$(int value) {\n" @@ -230,7 +230,7 @@ void ImmutableEnumFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" " @SuppressWarnings(\"deprecation\")\n" @@ -238,7 +238,7 @@ void ImmutableEnumFieldGenerator::GenerateBuilderMembers( " return result == null ? $unknown$ : result;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$$}$($type$ value) {\n" @@ -251,7 +251,7 @@ void ImmutableEnumFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -385,7 +385,7 @@ void ImmutableEnumOneofFieldGenerator::GenerateMembers( io::Printer* printer) const { PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" @@ -394,7 +394,7 @@ void ImmutableEnumOneofFieldGenerator::GenerateMembers( printer->Annotate("{", "}", descriptor_); } if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "$deprecation$public int ${$get$capitalized_name$Value$}$() {\n" @@ -405,7 +405,7 @@ void ImmutableEnumOneofFieldGenerator::GenerateMembers( "}\n"); printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" " if ($has_oneof_case_message$) {\n" @@ -422,7 +422,7 @@ void ImmutableEnumOneofFieldGenerator::GenerateMembers( void ImmutableEnumOneofFieldGenerator::GenerateBuilderMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" @@ -431,7 +431,7 @@ void ImmutableEnumOneofFieldGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); } if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "$deprecation$public int ${$get$capitalized_name$Value$}$() {\n" @@ -441,7 +441,7 @@ void ImmutableEnumOneofFieldGenerator::GenerateBuilderMembers( " return $default_number$;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, SETTER, true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$Value$}$(int value) {\n" @@ -452,7 +452,7 @@ void ImmutableEnumOneofFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" " if ($has_oneof_case_message$) {\n" @@ -464,7 +464,7 @@ void ImmutableEnumOneofFieldGenerator::GenerateBuilderMembers( " return $default$;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$$}$($type$ value) {\n" @@ -477,7 +477,7 @@ void ImmutableEnumOneofFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -603,22 +603,23 @@ int RepeatedImmutableEnumFieldGenerator::GetNumBitsForBuilder() const { void RepeatedImmutableEnumFieldGenerator::GenerateInterfaceMembers( io::Printer* printer) const { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print( variables_, "$deprecation$java.util.List<$type$> get$capitalized_name$List();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); printer->Print(variables_, "$deprecation$int get$capitalized_name$Count();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print(variables_, "$deprecation$$type$ get$capitalized_name$(int index);\n"); if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print(variables_, "$deprecation$java.util.List\n" "get$capitalized_name$ValueList();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, + LIST_INDEXED_GETTER); printer->Print(variables_, "$deprecation$int get$capitalized_name$Value(int index);\n"); } @@ -641,7 +642,7 @@ void RepeatedImmutableEnumFieldGenerator::GenerateMembers( " }\n" " };\n"); PrintExtraFieldInfo(variables_, printer); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print( variables_, "$deprecation$public java.util.List<$type$> " @@ -650,14 +651,14 @@ void RepeatedImmutableEnumFieldGenerator::GenerateMembers( " java.lang.Integer, $type$>($name$_, $name$_converter_);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER); printer->Print( variables_, "$deprecation$public int ${$get$capitalized_name$Count$}$() {\n" " return $name$_.size();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print( variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$(int index) {\n" @@ -665,14 +666,15 @@ void RepeatedImmutableEnumFieldGenerator::GenerateMembers( "}\n"); printer->Annotate("{", "}", descriptor_); if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print(variables_, "$deprecation$public java.util.List\n" "${$get$capitalized_name$ValueList$}$() {\n" " return $name$_;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, + LIST_INDEXED_GETTER); printer->Print(variables_, "$deprecation$public int " "${$get$capitalized_name$Value$}$(int index) {\n" @@ -709,7 +711,7 @@ void RepeatedImmutableEnumFieldGenerator::GenerateBuilderMembers( " }\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print( variables_, // Note: We return an unmodifiable list because otherwise the caller @@ -722,21 +724,21 @@ void RepeatedImmutableEnumFieldGenerator::GenerateBuilderMembers( " java.lang.Integer, $type$>($name$_, $name$_converter_);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); printer->Print( variables_, "$deprecation$public int ${$get$capitalized_name$Count$}$() {\n" " return $name$_.size();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print( variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$(int index) {\n" " return $name$_converter_.convert($name$_.get(index));\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER, true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " int index, $type$ value) {\n" @@ -749,7 +751,7 @@ void RepeatedImmutableEnumFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER, true); printer->Print(variables_, "$deprecation$public Builder " "${$add$capitalized_name$$}$($type$ value) {\n" @@ -762,7 +764,7 @@ void RepeatedImmutableEnumFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER, true); printer->Print(variables_, "$deprecation$public Builder ${$addAll$capitalized_name$$}$(\n" " java.lang.Iterable values) {\n" @@ -774,7 +776,7 @@ void RepeatedImmutableEnumFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -786,21 +788,23 @@ void RepeatedImmutableEnumFieldGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print(variables_, "$deprecation$public java.util.List\n" "${$get$capitalized_name$ValueList$}$() {\n" " return java.util.Collections.unmodifiableList($name$_);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, + LIST_INDEXED_GETTER); printer->Print(variables_, "$deprecation$public int " "${$get$capitalized_name$Value$}$(int index) {\n" " return $name$_.get(index);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, + LIST_INDEXED_GETTER, true); printer->Print( variables_, "$deprecation$public Builder ${$set$capitalized_name$Value$}$(\n" @@ -811,7 +815,8 @@ void RepeatedImmutableEnumFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, LIST_ADDER, + true); printer->Print(variables_, "$deprecation$public Builder " "${$add$capitalized_name$Value$}$(int value) {\n" @@ -821,7 +826,8 @@ void RepeatedImmutableEnumFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, LIST_ADDER, + true); printer->Print( variables_, "$deprecation$public Builder ${$addAll$capitalized_name$Value$}$(\n" diff --git a/src/google/protobuf/compiler/java/java_enum_field_lite.cc b/src/google/protobuf/compiler/java/java_enum_field_lite.cc index 376aa8616f..e93a22bc0c 100644 --- a/src/google/protobuf/compiler/java/java_enum_field_lite.cc +++ b/src/google/protobuf/compiler/java/java_enum_field_lite.cc @@ -143,16 +143,16 @@ int ImmutableEnumFieldLiteGenerator::GetNumBitsForMessage() const { void ImmutableEnumFieldLiteGenerator::GenerateInterfaceMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print(variables_, "$deprecation$boolean has$capitalized_name$();\n"); } if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$int get$capitalized_name$Value();\n"); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$$type$ get$capitalized_name$();\n"); } @@ -161,7 +161,7 @@ void ImmutableEnumFieldLiteGenerator::GenerateMembers( printer->Print(variables_, "private int $name$_;\n"); PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "@java.lang.Override\n" @@ -171,7 +171,7 @@ void ImmutableEnumFieldLiteGenerator::GenerateMembers( printer->Annotate("{", "}", descriptor_); } if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "@java.lang.Override\n" @@ -180,7 +180,7 @@ void ImmutableEnumFieldLiteGenerator::GenerateMembers( "}\n"); printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" @@ -191,14 +191,14 @@ void ImmutableEnumFieldLiteGenerator::GenerateMembers( // Generate private setters for the builder to proxy into. if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, SETTER); printer->Print(variables_, "private void set$capitalized_name$Value(int value) {\n" " $set_has_field_bit_message$" " $name$_ = value;\n" "}\n"); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER); printer->Print(variables_, "private void set$capitalized_name$($type$ value) {\n" " if (value == null) {\n" @@ -207,7 +207,7 @@ void ImmutableEnumFieldLiteGenerator::GenerateMembers( " $set_has_field_bit_message$\n" " $name$_ = value.getNumber();\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER); printer->Print(variables_, "private void clear$capitalized_name$() {\n" " $clear_has_field_bit_message$\n" @@ -218,7 +218,7 @@ void ImmutableEnumFieldLiteGenerator::GenerateMembers( void ImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "@java.lang.Override\n" @@ -228,7 +228,7 @@ void ImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); } if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "@java.lang.Override\n" @@ -236,7 +236,7 @@ void ImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " return instance.get$capitalized_name$Value();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$Value$}$(int value) {\n" @@ -246,14 +246,14 @@ void ImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" " return instance.get$capitalized_name$();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, SETTER, true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$$}$($type$ value) {\n" @@ -262,7 +262,7 @@ void ImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -317,7 +317,7 @@ void ImmutableEnumOneofFieldLiteGenerator::GenerateMembers( io::Printer* printer) const { PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "@java.lang.Override\n" @@ -327,7 +327,7 @@ void ImmutableEnumOneofFieldLiteGenerator::GenerateMembers( printer->Annotate("{", "}", descriptor_); } if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "@java.lang.Override\n" @@ -339,7 +339,7 @@ void ImmutableEnumOneofFieldLiteGenerator::GenerateMembers( "}\n"); printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" @@ -354,14 +354,14 @@ void ImmutableEnumOneofFieldLiteGenerator::GenerateMembers( // Generate private setters for the builder to proxy into. if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, SETTER); printer->Print(variables_, "private void set$capitalized_name$Value(int value) {\n" " $set_oneof_case_message$;\n" " $oneof_name$_ = value;\n" "}\n"); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER); printer->Print(variables_, "private void set$capitalized_name$($type$ value) {\n" " if (value == null) {\n" @@ -370,7 +370,7 @@ void ImmutableEnumOneofFieldLiteGenerator::GenerateMembers( " $set_oneof_case_message$;\n" " $oneof_name$_ = value.getNumber();\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER); printer->Print(variables_, "private void clear$capitalized_name$() {\n" " if ($has_oneof_case_message$) {\n" @@ -397,7 +397,7 @@ void ImmutableEnumOneofFieldLiteGenerator::GenerateFieldInfo( void ImmutableEnumOneofFieldLiteGenerator::GenerateBuilderMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "@java.lang.Override\n" @@ -407,7 +407,7 @@ void ImmutableEnumOneofFieldLiteGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); } if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "@java.lang.Override\n" @@ -415,7 +415,7 @@ void ImmutableEnumOneofFieldLiteGenerator::GenerateBuilderMembers( " return instance.get$capitalized_name$Value();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, SETTER, true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$Value$}$(int value) {\n" @@ -425,14 +425,14 @@ void ImmutableEnumOneofFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" " return instance.get$capitalized_name$();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$$}$($type$ value) {\n" @@ -441,7 +441,7 @@ void ImmutableEnumOneofFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -475,22 +475,23 @@ int RepeatedImmutableEnumFieldLiteGenerator::GetNumBitsForMessage() const { void RepeatedImmutableEnumFieldLiteGenerator::GenerateInterfaceMembers( io::Printer* printer) const { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print( variables_, "$deprecation$java.util.List<$type$> get$capitalized_name$List();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); printer->Print(variables_, "$deprecation$int get$capitalized_name$Count();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print(variables_, "$deprecation$$type$ get$capitalized_name$(int index);\n"); if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print(variables_, "$deprecation$java.util.List\n" "get$capitalized_name$ValueList();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, + LIST_INDEXED_GETTER); printer->Print(variables_, "$deprecation$int get$capitalized_name$Value(int index);\n"); } @@ -513,7 +514,7 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateMembers( " }\n" " };\n"); PrintExtraFieldInfo(variables_, printer); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print( variables_, "@java.lang.Override\n" @@ -523,7 +524,7 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateMembers( " java.lang.Integer, $type$>($name$_, $name$_converter_);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); printer->Print( variables_, "@java.lang.Override\n" @@ -531,7 +532,7 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateMembers( " return $name$_.size();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print( variables_, "@java.lang.Override\n" @@ -540,7 +541,7 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateMembers( "}\n"); printer->Annotate("{", "}", descriptor_); if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public java.util.List\n" @@ -548,7 +549,8 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateMembers( " return $name$_;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, + LIST_INDEXED_GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public int " @@ -572,7 +574,7 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateMembers( " com.google.protobuf.GeneratedMessageLite.mutableCopy($name$_);\n" " }\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER); printer->Print(variables_, "private void set$capitalized_name$(\n" " int index, $type$ value) {\n" @@ -582,7 +584,7 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateMembers( " ensure$capitalized_name$IsMutable();\n" " $name$_.setInt(index, value.getNumber());\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER); printer->Print(variables_, "private void add$capitalized_name$($type$ value) {\n" " if (value == null) {\n" @@ -591,7 +593,7 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateMembers( " ensure$capitalized_name$IsMutable();\n" " $name$_.addInt(value.getNumber());\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER); printer->Print(variables_, "private void addAll$capitalized_name$(\n" " java.lang.Iterable values) {\n" @@ -600,27 +602,28 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateMembers( " $name$_.addInt(value.getNumber());\n" " }\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER); printer->Print(variables_, "private void clear$capitalized_name$() {\n" " $name$_ = emptyIntList();\n" "}\n"); if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, SETTER); printer->Print(variables_, "private void set$capitalized_name$Value(\n" " int index, int value) {\n" " ensure$capitalized_name$IsMutable();\n" " $name$_.setInt(index, value);\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, LIST_ADDER); printer->Print(variables_, "private void add$capitalized_name$Value(int value) {\n" " ensure$capitalized_name$IsMutable();\n" " $name$_.addInt(value);\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, + LIST_MULTI_ADDER); printer->Print(variables_, "private void addAll$capitalized_name$Value(\n" " java.lang.Iterable values) {\n" @@ -648,7 +651,7 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateFieldInfo( void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( io::Printer* printer) const { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public java.util.List<$type$> " @@ -656,7 +659,7 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " return instance.get$capitalized_name$List();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); printer->Print( variables_, "@java.lang.Override\n" @@ -664,7 +667,7 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " return instance.get$capitalized_name$Count();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print( variables_, "@java.lang.Override\n" @@ -672,7 +675,7 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " return instance.get$capitalized_name$(index);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER, true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " int index, $type$ value) {\n" @@ -681,7 +684,7 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER, true); printer->Print(variables_, "$deprecation$public Builder " "${$add$capitalized_name$$}$($type$ value) {\n" @@ -690,7 +693,7 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER, true); printer->Print(variables_, "$deprecation$public Builder ${$addAll$capitalized_name$$}$(\n" " java.lang.Iterable values) {\n" @@ -699,7 +702,7 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -710,7 +713,7 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); if (SupportUnknownEnumValue(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public java.util.List\n" @@ -719,7 +722,8 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " instance.get$capitalized_name$ValueList());\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, + LIST_INDEXED_GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public int " @@ -727,7 +731,8 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " return instance.get$capitalized_name$Value(index);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, + LIST_INDEXED_SETTER, true); printer->Print( variables_, "$deprecation$public Builder ${$set$capitalized_name$Value$}$(\n" @@ -737,7 +742,8 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, LIST_ADDER, + true); printer->Print(variables_, "$deprecation$public Builder " "${$add$capitalized_name$Value$}$(int value) {\n" @@ -745,7 +751,8 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, + LIST_MULTI_ADDER, true); printer->Print( variables_, "$deprecation$public Builder ${$addAll$capitalized_name$Value$}$(\n" diff --git a/src/google/protobuf/compiler/java/java_message_field.cc b/src/google/protobuf/compiler/java/java_message_field.cc index 0b441a67f9..273faecedb 100644 --- a/src/google/protobuf/compiler/java/java_message_field.cc +++ b/src/google/protobuf/compiler/java/java_message_field.cc @@ -144,12 +144,12 @@ void ImmutableMessageFieldGenerator::GenerateInterfaceMembers( // interface so that builders can choose dynamically to either return a // message or a nested builder, so that asking for the interface doesn't // cause a message to ever be built. - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print(variables_, "$deprecation$boolean has$capitalized_name$();\n"); - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$$type$ get$capitalized_name$();\n"); - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldDocComment(printer, descriptor_); printer->Print( variables_, "$deprecation$$type$OrBuilder get$capitalized_name$OrBuilder();\n"); @@ -161,14 +161,14 @@ void ImmutableMessageFieldGenerator::GenerateMembers( PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" " return $get_has_field_bit_message$;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" @@ -185,14 +185,14 @@ void ImmutableMessageFieldGenerator::GenerateMembers( "}\n"); printer->Annotate("{", "}", descriptor_); } else { - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" " return $name$_ != null;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" @@ -261,7 +261,7 @@ void ImmutableMessageFieldGenerator::GenerateBuilderMembers( // field of type "Field" called "Field". // boolean hasField() - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); if (support_field_presence) { printer->Print( variables_, @@ -279,14 +279,14 @@ void ImmutableMessageFieldGenerator::GenerateBuilderMembers( } // Field getField() - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); PrintNestedBuilderFunction( printer, "$deprecation$public $type$ ${$get$capitalized_name$$}$()", "return $name$_ == null ? $type$.getDefaultInstance() : $name$_;\n", "return $name$Builder_.getMessage();\n", NULL); // Field.Builder setField(Field value) - WriteFieldSetterDocComment(printer, descriptor_); + WriteFieldDocComment(printer, descriptor_); PrintNestedBuilderFunction( printer, "$deprecation$public Builder ${$set$capitalized_name$$}$($type$ value)", @@ -303,7 +303,7 @@ void ImmutableMessageFieldGenerator::GenerateBuilderMembers( "return this;\n"); // Field.Builder setField(Field.Builder builderForValue) - WriteFieldSetterDocComment(printer, descriptor_); + WriteFieldDocComment(printer, descriptor_); PrintNestedBuilderFunction( printer, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" @@ -347,7 +347,7 @@ void ImmutableMessageFieldGenerator::GenerateBuilderMembers( "return this;\n"); // Field.Builder clearField() - WriteFieldClearerDocComment(printer, descriptor_); + WriteFieldDocComment(printer, descriptor_); PrintNestedBuilderFunction( printer, "$deprecation$public Builder ${$clear$capitalized_name$$}$()", @@ -535,13 +535,13 @@ ImmutableMessageOneofFieldGenerator::~ImmutableMessageOneofFieldGenerator() {} void ImmutableMessageOneofFieldGenerator::GenerateMembers( io::Printer* printer) const { PrintExtraFieldInfo(variables_, printer); - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print(variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" " return $has_oneof_case_message$;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" " if ($has_oneof_case_message$) {\n" @@ -579,7 +579,7 @@ void ImmutableMessageOneofFieldGenerator::GenerateBuilderMembers( // field of type "Field" called "Field". // boolean hasField() - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print(variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" " return $has_oneof_case_message$;\n" @@ -587,7 +587,7 @@ void ImmutableMessageOneofFieldGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); // Field getField() - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); PrintNestedBuilderFunction( printer, "$deprecation$public $type$ ${$get$capitalized_name$$}$()", diff --git a/src/google/protobuf/compiler/java/java_message_field_lite.cc b/src/google/protobuf/compiler/java/java_message_field_lite.cc index cc6563135e..1a055fea12 100644 --- a/src/google/protobuf/compiler/java/java_message_field_lite.cc +++ b/src/google/protobuf/compiler/java/java_message_field_lite.cc @@ -121,9 +121,9 @@ int ImmutableMessageFieldLiteGenerator::GetNumBitsForMessage() const { void ImmutableMessageFieldLiteGenerator::GenerateInterfaceMembers( io::Printer* printer) const { - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print(variables_, "$deprecation$boolean has$capitalized_name$();\n"); - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$$type$ get$capitalized_name$();\n"); } diff --git a/src/google/protobuf/compiler/java/java_primitive_field.cc b/src/google/protobuf/compiler/java/java_primitive_field.cc index 7eb7174489..feee062597 100644 --- a/src/google/protobuf/compiler/java/java_primitive_field.cc +++ b/src/google/protobuf/compiler/java/java_primitive_field.cc @@ -206,11 +206,11 @@ int ImmutablePrimitiveFieldGenerator::GetNumBitsForBuilder() const { void ImmutablePrimitiveFieldGenerator::GenerateInterfaceMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print(variables_, "$deprecation$boolean has$capitalized_name$();\n"); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$$type$ get$capitalized_name$();\n"); } @@ -219,7 +219,7 @@ void ImmutablePrimitiveFieldGenerator::GenerateMembers( printer->Print(variables_, "private $field_type$ $name$_;\n"); PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" @@ -228,7 +228,7 @@ void ImmutablePrimitiveFieldGenerator::GenerateMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" " return $name$_;\n" @@ -241,7 +241,7 @@ void ImmutablePrimitiveFieldGenerator::GenerateBuilderMembers( printer->Print(variables_, "private $field_type$ $name$_ $default_init$;\n"); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" @@ -250,14 +250,14 @@ void ImmutablePrimitiveFieldGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" " return $name$_;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$$}$($type$ value) {\n" @@ -269,7 +269,7 @@ void ImmutablePrimitiveFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -492,7 +492,7 @@ void ImmutablePrimitiveOneofFieldGenerator::GenerateMembers( io::Printer* printer) const { PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" @@ -501,7 +501,7 @@ void ImmutablePrimitiveOneofFieldGenerator::GenerateMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" " if ($has_oneof_case_message$) {\n" @@ -515,7 +515,7 @@ void ImmutablePrimitiveOneofFieldGenerator::GenerateMembers( void ImmutablePrimitiveOneofFieldGenerator::GenerateBuilderMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" @@ -524,7 +524,7 @@ void ImmutablePrimitiveOneofFieldGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" " if ($has_oneof_case_message$) {\n" @@ -534,7 +534,7 @@ void ImmutablePrimitiveOneofFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$$}$($type$ value) {\n" @@ -546,7 +546,7 @@ void ImmutablePrimitiveOneofFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -642,14 +642,14 @@ int RepeatedImmutablePrimitiveFieldGenerator::GetNumBitsForBuilder() const { void RepeatedImmutablePrimitiveFieldGenerator::GenerateInterfaceMembers( io::Printer* printer) const { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print(variables_, "$deprecation$java.util.List<$boxed_type$> " "get$capitalized_name$List();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); printer->Print(variables_, "$deprecation$int get$capitalized_name$Count();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print(variables_, "$deprecation$$type$ get$capitalized_name$(int index);\n"); } @@ -658,21 +658,21 @@ void RepeatedImmutablePrimitiveFieldGenerator::GenerateMembers( io::Printer* printer) const { printer->Print(variables_, "private $field_list_type$ $name$_;\n"); PrintExtraFieldInfo(variables_, printer); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print(variables_, "$deprecation$public java.util.List<$boxed_type$>\n" " ${$get$capitalized_name$List$}$() {\n" " return $name$_;\n" // note: unmodifiable list "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); printer->Print( variables_, "$deprecation$public int ${$get$capitalized_name$Count$}$() {\n" " return $name$_.size();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print( variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$(int index) {\n" @@ -712,7 +712,7 @@ void RepeatedImmutablePrimitiveFieldGenerator::GenerateBuilderMembers( // could hold on to the returned list and modify it after the message // has been built, thus mutating the message which is supposed to be // immutable. - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print( variables_, "$deprecation$public java.util.List<$boxed_type$>\n" @@ -721,21 +721,21 @@ void RepeatedImmutablePrimitiveFieldGenerator::GenerateBuilderMembers( " java.util.Collections.unmodifiableList($name$_) : $name$_;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); printer->Print( variables_, "$deprecation$public int ${$get$capitalized_name$Count$}$() {\n" " return $name$_.size();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print( variables_, "$deprecation$public $type$ ${$get$capitalized_name$$}$(int index) {\n" " return $repeated_get$(index);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER, true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " int index, $type$ value) {\n" @@ -746,7 +746,7 @@ void RepeatedImmutablePrimitiveFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER, true); printer->Print(variables_, "$deprecation$public Builder " "${$add$capitalized_name$$}$($type$ value) {\n" @@ -757,7 +757,7 @@ void RepeatedImmutablePrimitiveFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER, true); printer->Print(variables_, "$deprecation$public Builder ${$addAll$capitalized_name$$}$(\n" " java.lang.Iterable values) {\n" @@ -768,7 +768,7 @@ void RepeatedImmutablePrimitiveFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" diff --git a/src/google/protobuf/compiler/java/java_primitive_field_lite.cc b/src/google/protobuf/compiler/java/java_primitive_field_lite.cc index 6428b3da21..22a6ede14b 100644 --- a/src/google/protobuf/compiler/java/java_primitive_field_lite.cc +++ b/src/google/protobuf/compiler/java/java_primitive_field_lite.cc @@ -198,11 +198,11 @@ int ImmutablePrimitiveFieldLiteGenerator::GetNumBitsForMessage() const { void ImmutablePrimitiveFieldLiteGenerator::GenerateInterfaceMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print(variables_, "$deprecation$boolean has$capitalized_name$();\n"); } - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$$type$ get$capitalized_name$();\n"); } @@ -218,7 +218,7 @@ void ImmutablePrimitiveFieldLiteGenerator::GenerateMembers( printer->Print(variables_, "private $field_type$ $name$_;\n"); PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "@java.lang.Override\n" @@ -228,7 +228,7 @@ void ImmutablePrimitiveFieldLiteGenerator::GenerateMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" @@ -236,7 +236,7 @@ void ImmutablePrimitiveFieldLiteGenerator::GenerateMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER); printer->Print(variables_, "private void set$capitalized_name$($type$ value) {\n" "$null_check$" @@ -244,7 +244,7 @@ void ImmutablePrimitiveFieldLiteGenerator::GenerateMembers( " $name$_ = value;\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER); printer->Print(variables_, "private void clear$capitalized_name$() {\n" " $clear_has_field_bit_message$\n"); @@ -264,7 +264,7 @@ void ImmutablePrimitiveFieldLiteGenerator::GenerateMembers( void ImmutablePrimitiveFieldLiteGenerator::GenerateBuilderMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "@java.lang.Override\n" @@ -274,7 +274,7 @@ void ImmutablePrimitiveFieldLiteGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" @@ -347,7 +347,7 @@ void ImmutablePrimitiveOneofFieldLiteGenerator::GenerateMembers( io::Printer* printer) const { PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "@java.lang.Override\n" @@ -357,7 +357,7 @@ void ImmutablePrimitiveOneofFieldLiteGenerator::GenerateMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" @@ -397,7 +397,7 @@ void ImmutablePrimitiveOneofFieldLiteGenerator::GenerateFieldInfo( void ImmutablePrimitiveOneofFieldLiteGenerator::GenerateBuilderMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "@java.lang.Override\n" @@ -407,7 +407,7 @@ void ImmutablePrimitiveOneofFieldLiteGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public $type$ ${$get$capitalized_name$$}$() {\n" diff --git a/src/google/protobuf/compiler/java/java_string_field.cc b/src/google/protobuf/compiler/java/java_string_field.cc index 0a4592b322..bf5fbc053f 100644 --- a/src/google/protobuf/compiler/java/java_string_field.cc +++ b/src/google/protobuf/compiler/java/java_string_field.cc @@ -190,14 +190,14 @@ int ImmutableStringFieldGenerator::GetNumBitsForBuilder() const { void ImmutableStringFieldGenerator::GenerateInterfaceMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print(variables_, "$deprecation$boolean has$capitalized_name$();\n"); } - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$java.lang.String get$capitalized_name$();\n"); - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$com.google.protobuf.ByteString\n" " get$capitalized_name$Bytes();\n"); @@ -209,7 +209,7 @@ void ImmutableStringFieldGenerator::GenerateMembers( PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" @@ -218,7 +218,7 @@ void ImmutableStringFieldGenerator::GenerateMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "$deprecation$public java.lang.String ${$get$capitalized_name$$}$() {\n" @@ -242,7 +242,7 @@ void ImmutableStringFieldGenerator::GenerateMembers( " return s;\n" " }\n" "}\n"); - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$public com.google.protobuf.ByteString\n" " ${$get$capitalized_name$Bytes$}$() {\n" @@ -265,7 +265,7 @@ void ImmutableStringFieldGenerator::GenerateBuilderMembers( printer->Print(variables_, "private java.lang.Object $name$_ $default_init$;\n"); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldHaserDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" @@ -274,7 +274,7 @@ void ImmutableStringFieldGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "$deprecation$public java.lang.String ${$get$capitalized_name$$}$() {\n" @@ -299,7 +299,7 @@ void ImmutableStringFieldGenerator::GenerateBuilderMembers( " }\n" "}\n"); - WriteFieldGetterDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$public com.google.protobuf.ByteString\n" " ${$get$capitalized_name$Bytes$}$() {\n" @@ -316,7 +316,7 @@ void ImmutableStringFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldSetterDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " java.lang.String value) {\n" @@ -327,7 +327,7 @@ void ImmutableStringFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldClearerDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -342,7 +342,7 @@ void ImmutableStringFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); - WriteFieldSetterDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, SETTER); printer->Print( variables_, "$deprecation$public Builder ${$set$capitalized_name$Bytes$}$(\n" @@ -481,7 +481,7 @@ void ImmutableStringOneofFieldGenerator::GenerateMembers( PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" @@ -490,7 +490,7 @@ void ImmutableStringOneofFieldGenerator::GenerateMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "$deprecation$public java.lang.String ${$get$capitalized_name$$}$() {\n" @@ -520,7 +520,7 @@ void ImmutableStringOneofFieldGenerator::GenerateMembers( " return s;\n" " }\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$public com.google.protobuf.ByteString\n" @@ -547,7 +547,7 @@ void ImmutableStringOneofFieldGenerator::GenerateMembers( void ImmutableStringOneofFieldGenerator::GenerateBuilderMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "$deprecation$public boolean ${$has$capitalized_name$$}$() {\n" @@ -556,7 +556,7 @@ void ImmutableStringOneofFieldGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "$deprecation$public java.lang.String ${$get$capitalized_name$$}$() {\n" @@ -586,7 +586,7 @@ void ImmutableStringOneofFieldGenerator::GenerateBuilderMembers( " }\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$public com.google.protobuf.ByteString\n" " ${$get$capitalized_name$Bytes$}$() {\n" @@ -608,7 +608,7 @@ void ImmutableStringOneofFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " java.lang.String value) {\n" @@ -619,7 +619,7 @@ void ImmutableStringOneofFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -632,7 +632,7 @@ void ImmutableStringOneofFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, SETTER, true); printer->Print( variables_, "$deprecation$public Builder ${$set$capitalized_name$Bytes$}$(\n" @@ -723,7 +723,7 @@ int RepeatedImmutableStringFieldGenerator::GetNumBitsForBuilder() const { void RepeatedImmutableStringFieldGenerator::GenerateInterfaceMembers( io::Printer* printer) const { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print( variables_, // NOTE: the same method in the implementation class actually returns @@ -734,14 +734,15 @@ void RepeatedImmutableStringFieldGenerator::GenerateInterfaceMembers( // with different return types exist in the compiled byte code. "$deprecation$java.util.List\n" " get$capitalized_name$List();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); printer->Print(variables_, "$deprecation$int get$capitalized_name$Count();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print( variables_, "$deprecation$java.lang.String get$capitalized_name$(int index);\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, + LIST_INDEXED_GETTER); printer->Print(variables_, "$deprecation$com.google.protobuf.ByteString\n" " get$capitalized_name$Bytes(int index);\n"); @@ -752,28 +753,29 @@ void RepeatedImmutableStringFieldGenerator::GenerateMembers( printer->Print(variables_, "private com.google.protobuf.LazyStringList $name$_;\n"); PrintExtraFieldInfo(variables_, printer); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print(variables_, "$deprecation$public com.google.protobuf.ProtocolStringList\n" " ${$get$capitalized_name$List$}$() {\n" " return $name$_;\n" // note: unmodifiable list "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); printer->Print( variables_, "$deprecation$public int ${$get$capitalized_name$Count$}$() {\n" " return $name$_.size();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print(variables_, "$deprecation$public java.lang.String " "${$get$capitalized_name$$}$(int index) {\n" " return $name$_.get(index);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, + LIST_INDEXED_GETTER); printer->Print(variables_, "$deprecation$public com.google.protobuf.ByteString\n" " ${$get$capitalized_name$Bytes$}$(int index) {\n" @@ -810,35 +812,35 @@ void RepeatedImmutableStringFieldGenerator::GenerateBuilderMembers( // could hold on to the returned list and modify it after the message // has been built, thus mutating the message which is supposed to be // immutable. - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print(variables_, "$deprecation$public com.google.protobuf.ProtocolStringList\n" " ${$get$capitalized_name$List$}$() {\n" " return $name$_.getUnmodifiableView();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); printer->Print( variables_, "$deprecation$public int ${$get$capitalized_name$Count$}$() {\n" " return $name$_.size();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print(variables_, "$deprecation$public java.lang.String " "${$get$capitalized_name$$}$(int index) {\n" " return $name$_.get(index);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, LIST_ADDER); printer->Print(variables_, "$deprecation$public com.google.protobuf.ByteString\n" " ${$get$capitalized_name$Bytes$}$(int index) {\n" " return $name$_.getByteString(index);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER, true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " int index, java.lang.String value) {\n" @@ -849,7 +851,7 @@ void RepeatedImmutableStringFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER, true); printer->Print(variables_, "$deprecation$public Builder ${$add$capitalized_name$$}$(\n" " java.lang.String value) {\n" @@ -860,7 +862,7 @@ void RepeatedImmutableStringFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER, true); printer->Print(variables_, "$deprecation$public Builder ${$addAll$capitalized_name$$}$(\n" " java.lang.Iterable values) {\n" @@ -871,7 +873,7 @@ void RepeatedImmutableStringFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -882,7 +884,8 @@ void RepeatedImmutableStringFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, LIST_ADDER, + true); printer->Print( variables_, "$deprecation$public Builder ${$add$capitalized_name$Bytes$}$(\n" diff --git a/src/google/protobuf/compiler/java/java_string_field_lite.cc b/src/google/protobuf/compiler/java/java_string_field_lite.cc index 40868fac2a..710a615b31 100644 --- a/src/google/protobuf/compiler/java/java_string_field_lite.cc +++ b/src/google/protobuf/compiler/java/java_string_field_lite.cc @@ -163,14 +163,14 @@ int ImmutableStringFieldLiteGenerator::GetNumBitsForMessage() const { void ImmutableStringFieldLiteGenerator::GenerateInterfaceMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print(variables_, "$deprecation$boolean has$capitalized_name$();\n"); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$java.lang.String get$capitalized_name$();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "$deprecation$com.google.protobuf.ByteString\n" " get$capitalized_name$Bytes();\n"); @@ -182,7 +182,7 @@ void ImmutableStringFieldLiteGenerator::GenerateMembers( PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "@java.lang.Override\n" @@ -192,7 +192,7 @@ void ImmutableStringFieldLiteGenerator::GenerateMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "@java.lang.Override\n" @@ -200,7 +200,7 @@ void ImmutableStringFieldLiteGenerator::GenerateMembers( " return $name$_;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "@java.lang.Override\n" @@ -210,7 +210,7 @@ void ImmutableStringFieldLiteGenerator::GenerateMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER); printer->Print(variables_, "private void set$capitalized_name$(\n" " java.lang.String value) {\n" @@ -218,7 +218,7 @@ void ImmutableStringFieldLiteGenerator::GenerateMembers( " $set_has_field_bit_message$\n" " $name$_ = value;\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER); printer->Print(variables_, "private void clear$capitalized_name$() {\n" " $clear_has_field_bit_message$\n" @@ -228,7 +228,7 @@ void ImmutableStringFieldLiteGenerator::GenerateMembers( " $name$_ = getDefaultInstance().get$capitalized_name$();\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, SETTER); printer->Print(variables_, "private void set$capitalized_name$Bytes(\n" " com.google.protobuf.ByteString value) {\n" @@ -245,7 +245,7 @@ void ImmutableStringFieldLiteGenerator::GenerateMembers( void ImmutableStringFieldLiteGenerator::GenerateBuilderMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "@java.lang.Override\n" @@ -255,7 +255,7 @@ void ImmutableStringFieldLiteGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "@java.lang.Override\n" @@ -264,7 +264,7 @@ void ImmutableStringFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public com.google.protobuf.ByteString\n" @@ -273,7 +273,7 @@ void ImmutableStringFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " java.lang.String value) {\n" @@ -282,7 +282,7 @@ void ImmutableStringFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -292,7 +292,7 @@ void ImmutableStringFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, SETTER, true); printer->Print( variables_, "$deprecation$public Builder ${$set$capitalized_name$Bytes$}$(\n" @@ -342,7 +342,7 @@ void ImmutableStringOneofFieldLiteGenerator::GenerateMembers( PrintExtraFieldInfo(variables_, printer); if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "@java.lang.Override\n" @@ -352,7 +352,7 @@ void ImmutableStringOneofFieldLiteGenerator::GenerateMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "@java.lang.Override\n" @@ -364,8 +364,8 @@ void ImmutableStringOneofFieldLiteGenerator::GenerateMembers( " return ref;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public com.google.protobuf.ByteString\n" @@ -378,7 +378,7 @@ void ImmutableStringOneofFieldLiteGenerator::GenerateMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER); printer->Print(variables_, "private void ${$set$capitalized_name$$}$(\n" " java.lang.String value) {\n" @@ -387,7 +387,7 @@ void ImmutableStringOneofFieldLiteGenerator::GenerateMembers( " $oneof_name$_ = value;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER); printer->Print(variables_, "private void ${$clear$capitalized_name$$}$() {\n" " if ($has_oneof_case_message$) {\n" @@ -397,7 +397,7 @@ void ImmutableStringOneofFieldLiteGenerator::GenerateMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, SETTER); printer->Print(variables_, "private void ${$set$capitalized_name$Bytes$}$(\n" " com.google.protobuf.ByteString value) {\n" @@ -423,7 +423,7 @@ void ImmutableStringOneofFieldLiteGenerator::GenerateFieldInfo( void ImmutableStringOneofFieldLiteGenerator::GenerateBuilderMembers( io::Printer* printer) const { if (SupportFieldPresence(descriptor_->file())) { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, HAZZER); printer->Print( variables_, "@java.lang.Override\n" @@ -433,7 +433,7 @@ void ImmutableStringOneofFieldLiteGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); } - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, GETTER); printer->Print( variables_, "@java.lang.Override\n" @@ -442,7 +442,7 @@ void ImmutableStringOneofFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public com.google.protobuf.ByteString\n" @@ -451,7 +451,7 @@ void ImmutableStringOneofFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " java.lang.String value) {\n" @@ -460,7 +460,7 @@ void ImmutableStringOneofFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -470,7 +470,7 @@ void ImmutableStringOneofFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, SETTER); printer->Print( variables_, "$deprecation$public Builder ${$set$capitalized_name$Bytes$}$(\n" @@ -503,18 +503,18 @@ int RepeatedImmutableStringFieldLiteGenerator::GetNumBitsForMessage() const { void RepeatedImmutableStringFieldLiteGenerator::GenerateInterfaceMembers( io::Printer* printer) const { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print(variables_, "$deprecation$java.util.List\n" " get$capitalized_name$List();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); printer->Print(variables_, "$deprecation$int get$capitalized_name$Count();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print( variables_, "$deprecation$java.lang.String get$capitalized_name$(int index);\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print(variables_, "$deprecation$com.google.protobuf.ByteString\n" " get$capitalized_name$Bytes(int index);\n"); @@ -527,7 +527,7 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateMembers( "private com.google.protobuf.Internal.ProtobufList " "$name$_;\n"); PrintExtraFieldInfo(variables_, printer); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public java.util.List " @@ -535,7 +535,7 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateMembers( " return $name$_;\n" // note: unmodifiable list "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); printer->Print( variables_, "@java.lang.Override\n" @@ -543,7 +543,7 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateMembers( " return $name$_.size();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public java.lang.String " @@ -551,7 +551,8 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateMembers( " return $name$_.get(index);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, + LIST_INDEXED_GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public com.google.protobuf.ByteString\n" @@ -570,7 +571,7 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateMembers( " }\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER); printer->Print(variables_, "private void set$capitalized_name$(\n" " int index, java.lang.String value) {\n" @@ -578,7 +579,7 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateMembers( " ensure$capitalized_name$IsMutable();\n" " $name$_.set(index, value);\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER); printer->Print(variables_, "private void add$capitalized_name$(\n" " java.lang.String value) {\n" @@ -586,7 +587,7 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateMembers( " ensure$capitalized_name$IsMutable();\n" " $name$_.add(value);\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER); printer->Print(variables_, "private void addAll$capitalized_name$(\n" " java.lang.Iterable values) {\n" @@ -594,13 +595,13 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateMembers( " com.google.protobuf.AbstractMessageLite.addAll(\n" " values, $name$_);\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER); printer->Print(variables_, "private void clear$capitalized_name$() {\n" " $name$_ = $empty_list$;\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, LIST_ADDER); printer->Print(variables_, "private void add$capitalized_name$Bytes(\n" " com.google.protobuf.ByteString value) {\n" @@ -616,7 +617,7 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateMembers( void RepeatedImmutableStringFieldLiteGenerator::GenerateBuilderMembers( io::Printer* printer) const { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public java.util.List\n" @@ -625,7 +626,7 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateBuilderMembers( " instance.get$capitalized_name$List());\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); printer->Print( variables_, "@java.lang.Override\n" @@ -633,7 +634,7 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateBuilderMembers( " return instance.get$capitalized_name$Count();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public java.lang.String " @@ -641,7 +642,8 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateBuilderMembers( " return instance.get$capitalized_name$(index);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, + LIST_INDEXED_GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public com.google.protobuf.ByteString\n" @@ -649,7 +651,7 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateBuilderMembers( " return instance.get$capitalized_name$Bytes(index);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER, true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " int index, java.lang.String value) {\n" @@ -658,7 +660,7 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER); printer->Print(variables_, "$deprecation$public Builder ${$add$capitalized_name$$}$(\n" " java.lang.String value) {\n" @@ -667,7 +669,7 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER, true); printer->Print(variables_, "$deprecation$public Builder ${$addAll$capitalized_name$$}$(\n" " java.lang.Iterable values) {\n" @@ -676,7 +678,7 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -686,7 +688,8 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, LIST_ADDER, + true); printer->Print( variables_, "$deprecation$public Builder ${$add$capitalized_name$Bytes$}$(\n" From 5af81a442b1687fb5ad14921dc4a0c16fd9fef09 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Wed, 26 Jun 2019 20:38:49 +0200 Subject: [PATCH 3/4] Use parameter name comment --- .gitignore | 3 ++ .../compiler/java/java_doc_comment.cc | 4 +- .../protobuf/compiler/java/java_enum_field.cc | 39 +++++++++----- .../compiler/java/java_enum_field_lite.cc | 38 ++++++++----- .../compiler/java/java_primitive_field.cc | 24 ++++++--- .../java/java_primitive_field_lite.cc | 54 +++++++++++-------- .../compiler/java/java_string_field.cc | 32 +++++++---- .../compiler/java/java_string_field_lite.cc | 32 +++++++---- 8 files changed, 144 insertions(+), 82 deletions(-) diff --git a/.gitignore b/.gitignore index a7ca0e2438..76f6403ea7 100644 --- a/.gitignore +++ b/.gitignore @@ -197,6 +197,9 @@ cmake/cmake-build-debug/ # Visual Studio 2017 .vs +# Visual Studio Code +/.vscode/ + # IntelliJ .idea *.iml diff --git a/src/google/protobuf/compiler/java/java_doc_comment.cc b/src/google/protobuf/compiler/java/java_doc_comment.cc index 7926f10f84..cc92b7aa8d 100644 --- a/src/google/protobuf/compiler/java/java_doc_comment.cc +++ b/src/google/protobuf/compiler/java/java_doc_comment.cc @@ -280,7 +280,7 @@ void WriteFieldEnumValueAccessorDocComment(io::Printer* printer, "name", field->camelcase_name()); break; case LIST_INDEXED_SETTER: - printer->Print(" * @param index The index of the value to return.\n"); + printer->Print(" * @param index The index to set the value at.\n"); printer->Print(" * @param value The enum value of the $name$ to set.\n", "name", field->camelcase_name()); break; @@ -336,7 +336,7 @@ void WriteFieldStringBytesAccessorDocComment(io::Printer* printer, "name", field->camelcase_name()); break; case LIST_INDEXED_SETTER: - printer->Print(" * @param index The index of the value to return.\n"); + printer->Print(" * @param index The index to set the value at.\n"); printer->Print(" * @param value The bytes of the $name$ to set.\n", "name", field->camelcase_name()); break; diff --git a/src/google/protobuf/compiler/java/java_enum_field.cc b/src/google/protobuf/compiler/java/java_enum_field.cc index c6e0905fdc..5ae51ffe67 100644 --- a/src/google/protobuf/compiler/java/java_enum_field.cc +++ b/src/google/protobuf/compiler/java/java_enum_field.cc @@ -220,7 +220,8 @@ void ImmutableEnumFieldGenerator::GenerateBuilderMembers( " return $name$_;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldEnumValueAccessorDocComment(printer, descriptor_, SETTER); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$Value$}$(int value) {\n" @@ -238,7 +239,8 @@ void ImmutableEnumFieldGenerator::GenerateBuilderMembers( " return result == null ? $unknown$ : result;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$$}$($type$ value) {\n" @@ -251,7 +253,8 @@ void ImmutableEnumFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -441,7 +444,8 @@ void ImmutableEnumOneofFieldGenerator::GenerateBuilderMembers( " return $default_number$;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldEnumValueAccessorDocComment(printer, descriptor_, SETTER, true); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$Value$}$(int value) {\n" @@ -464,7 +468,8 @@ void ImmutableEnumOneofFieldGenerator::GenerateBuilderMembers( " return $default$;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$$}$($type$ value) {\n" @@ -477,7 +482,8 @@ void ImmutableEnumOneofFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -738,7 +744,8 @@ void RepeatedImmutableEnumFieldGenerator::GenerateBuilderMembers( " return $name$_converter_.convert($name$_.get(index));\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER, true); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " int index, $type$ value) {\n" @@ -751,7 +758,8 @@ void RepeatedImmutableEnumFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER, true); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder " "${$add$capitalized_name$$}$($type$ value) {\n" @@ -764,7 +772,8 @@ void RepeatedImmutableEnumFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER, true); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder ${$addAll$capitalized_name$$}$(\n" " java.lang.Iterable values) {\n" @@ -776,7 +785,8 @@ void RepeatedImmutableEnumFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -804,7 +814,8 @@ void RepeatedImmutableEnumFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); WriteFieldEnumValueAccessorDocComment(printer, descriptor_, - LIST_INDEXED_GETTER, true); + LIST_INDEXED_GETTER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$set$capitalized_name$Value$}$(\n" @@ -816,7 +827,7 @@ void RepeatedImmutableEnumFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); WriteFieldEnumValueAccessorDocComment(printer, descriptor_, LIST_ADDER, - true); + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder " "${$add$capitalized_name$Value$}$(int value) {\n" @@ -826,8 +837,8 @@ void RepeatedImmutableEnumFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldEnumValueAccessorDocComment(printer, descriptor_, LIST_ADDER, - true); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, + LIST_MULTI_ADDER, /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$addAll$capitalized_name$Value$}$(\n" diff --git a/src/google/protobuf/compiler/java/java_enum_field_lite.cc b/src/google/protobuf/compiler/java/java_enum_field_lite.cc index e93a22bc0c..b3b4c3c842 100644 --- a/src/google/protobuf/compiler/java/java_enum_field_lite.cc +++ b/src/google/protobuf/compiler/java/java_enum_field_lite.cc @@ -236,7 +236,8 @@ void ImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " return instance.get$capitalized_name$Value();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$Value$}$(int value) {\n" @@ -253,7 +254,8 @@ void ImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " return instance.get$capitalized_name$();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldEnumValueAccessorDocComment(printer, descriptor_, SETTER, true); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$$}$($type$ value) {\n" @@ -262,7 +264,8 @@ void ImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -415,7 +418,8 @@ void ImmutableEnumOneofFieldLiteGenerator::GenerateBuilderMembers( " return instance.get$capitalized_name$Value();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldEnumValueAccessorDocComment(printer, descriptor_, SETTER, true); + WriteFieldEnumValueAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$Value$}$(int value) {\n" @@ -432,7 +436,8 @@ void ImmutableEnumOneofFieldLiteGenerator::GenerateBuilderMembers( " return instance.get$capitalized_name$();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$$}$($type$ value) {\n" @@ -441,7 +446,8 @@ void ImmutableEnumOneofFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -675,7 +681,8 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " return instance.get$capitalized_name$(index);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER, true); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " int index, $type$ value) {\n" @@ -684,7 +691,8 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER, true); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder " "${$add$capitalized_name$$}$($type$ value) {\n" @@ -693,7 +701,8 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER, true); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder ${$addAll$capitalized_name$$}$(\n" " java.lang.Iterable values) {\n" @@ -702,7 +711,8 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -732,7 +742,8 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); WriteFieldEnumValueAccessorDocComment(printer, descriptor_, - LIST_INDEXED_SETTER, true); + LIST_INDEXED_SETTER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$set$capitalized_name$Value$}$(\n" @@ -743,7 +754,7 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); WriteFieldEnumValueAccessorDocComment(printer, descriptor_, LIST_ADDER, - true); + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder " "${$add$capitalized_name$Value$}$(int value) {\n" @@ -752,7 +763,8 @@ void RepeatedImmutableEnumFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); WriteFieldEnumValueAccessorDocComment(printer, descriptor_, - LIST_MULTI_ADDER, true); + LIST_MULTI_ADDER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$addAll$capitalized_name$Value$}$(\n" diff --git a/src/google/protobuf/compiler/java/java_primitive_field.cc b/src/google/protobuf/compiler/java/java_primitive_field.cc index feee062597..8b51e792df 100644 --- a/src/google/protobuf/compiler/java/java_primitive_field.cc +++ b/src/google/protobuf/compiler/java/java_primitive_field.cc @@ -257,7 +257,8 @@ void ImmutablePrimitiveFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$$}$($type$ value) {\n" @@ -269,7 +270,8 @@ void ImmutablePrimitiveFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -534,7 +536,8 @@ void ImmutablePrimitiveOneofFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$$}$($type$ value) {\n" @@ -546,7 +549,8 @@ void ImmutablePrimitiveOneofFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -735,7 +739,8 @@ void RepeatedImmutablePrimitiveFieldGenerator::GenerateBuilderMembers( " return $repeated_get$(index);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER, true); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " int index, $type$ value) {\n" @@ -746,7 +751,8 @@ void RepeatedImmutablePrimitiveFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER, true); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder " "${$add$capitalized_name$$}$($type$ value) {\n" @@ -757,7 +763,8 @@ void RepeatedImmutablePrimitiveFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER, true); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder ${$addAll$capitalized_name$$}$(\n" " java.lang.Iterable values) {\n" @@ -768,7 +775,8 @@ void RepeatedImmutablePrimitiveFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" diff --git a/src/google/protobuf/compiler/java/java_primitive_field_lite.cc b/src/google/protobuf/compiler/java/java_primitive_field_lite.cc index 22a6ede14b..833be233bc 100644 --- a/src/google/protobuf/compiler/java/java_primitive_field_lite.cc +++ b/src/google/protobuf/compiler/java/java_primitive_field_lite.cc @@ -282,7 +282,8 @@ void ImmutablePrimitiveFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$$}$($type$ value) {\n" @@ -292,7 +293,8 @@ void ImmutablePrimitiveFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -368,7 +370,7 @@ void ImmutablePrimitiveOneofFieldLiteGenerator::GenerateMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER); printer->Print(variables_, "private void set$capitalized_name$($type$ value) {\n" "$null_check$" @@ -376,7 +378,7 @@ void ImmutablePrimitiveOneofFieldLiteGenerator::GenerateMembers( " $oneof_name$_ = value;\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER); printer->Print(variables_, "private void clear$capitalized_name$() {\n" " if ($has_oneof_case_message$) {\n" @@ -415,7 +417,8 @@ void ImmutablePrimitiveOneofFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder " "${$set$capitalized_name$$}$($type$ value) {\n" @@ -425,7 +428,8 @@ void ImmutablePrimitiveOneofFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -459,14 +463,14 @@ int RepeatedImmutablePrimitiveFieldLiteGenerator::GetNumBitsForMessage() const { void RepeatedImmutablePrimitiveFieldLiteGenerator::GenerateInterfaceMembers( io::Printer* printer) const { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print(variables_, "$deprecation$java.util.List<$boxed_type$> " "get$capitalized_name$List();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); printer->Print(variables_, "$deprecation$int get$capitalized_name$Count();\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print(variables_, "$deprecation$$type$ get$capitalized_name$(int index);\n"); } @@ -475,7 +479,7 @@ void RepeatedImmutablePrimitiveFieldLiteGenerator::GenerateMembers( io::Printer* printer) const { printer->Print(variables_, "private $field_list_type$ $name$_;\n"); PrintExtraFieldInfo(variables_, printer); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public java.util.List<$boxed_type$>\n" @@ -483,7 +487,7 @@ void RepeatedImmutablePrimitiveFieldLiteGenerator::GenerateMembers( " return $name$_;\n" // note: unmodifiable list "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); printer->Print( variables_, "@java.lang.Override\n" @@ -491,7 +495,7 @@ void RepeatedImmutablePrimitiveFieldLiteGenerator::GenerateMembers( " return $name$_.size();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print( variables_, "@java.lang.Override\n" @@ -515,7 +519,7 @@ void RepeatedImmutablePrimitiveFieldLiteGenerator::GenerateMembers( " }\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER); printer->Print(variables_, "private void set$capitalized_name$(\n" " int index, $type$ value) {\n" @@ -523,14 +527,14 @@ void RepeatedImmutablePrimitiveFieldLiteGenerator::GenerateMembers( " ensure$capitalized_name$IsMutable();\n" " $repeated_set$(index, value);\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER); printer->Print(variables_, "private void add$capitalized_name$($type$ value) {\n" "$null_check$" " ensure$capitalized_name$IsMutable();\n" " $repeated_add$(value);\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER); printer->Print(variables_, "private void addAll$capitalized_name$(\n" " java.lang.Iterable values) {\n" @@ -538,7 +542,7 @@ void RepeatedImmutablePrimitiveFieldLiteGenerator::GenerateMembers( " com.google.protobuf.AbstractMessageLite.addAll(\n" " values, $name$_);\n" "}\n"); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER); printer->Print(variables_, "private void clear$capitalized_name$() {\n" " $name$_ = $empty_list$;\n" @@ -547,7 +551,7 @@ void RepeatedImmutablePrimitiveFieldLiteGenerator::GenerateMembers( void RepeatedImmutablePrimitiveFieldLiteGenerator::GenerateBuilderMembers( io::Printer* printer) const { - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_GETTER); printer->Print(variables_, "@java.lang.Override\n" "$deprecation$public java.util.List<$boxed_type$>\n" @@ -556,7 +560,7 @@ void RepeatedImmutablePrimitiveFieldLiteGenerator::GenerateBuilderMembers( " instance.get$capitalized_name$List());\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_COUNT); printer->Print( variables_, "@java.lang.Override\n" @@ -564,7 +568,7 @@ void RepeatedImmutablePrimitiveFieldLiteGenerator::GenerateBuilderMembers( " return instance.get$capitalized_name$Count();\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_GETTER); printer->Print( variables_, "@java.lang.Override\n" @@ -572,7 +576,8 @@ void RepeatedImmutablePrimitiveFieldLiteGenerator::GenerateBuilderMembers( " return instance.get$capitalized_name$(index);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " int index, $type$ value) {\n" @@ -581,7 +586,8 @@ void RepeatedImmutablePrimitiveFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder " "${$add$capitalized_name$$}$($type$ value) {\n" @@ -590,7 +596,8 @@ void RepeatedImmutablePrimitiveFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder ${$addAll$capitalized_name$$}$(\n" " java.lang.Iterable values) {\n" @@ -599,7 +606,8 @@ void RepeatedImmutablePrimitiveFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldDocComment(printer, descriptor_); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" diff --git a/src/google/protobuf/compiler/java/java_string_field.cc b/src/google/protobuf/compiler/java/java_string_field.cc index bf5fbc053f..2a828816cd 100644 --- a/src/google/protobuf/compiler/java/java_string_field.cc +++ b/src/google/protobuf/compiler/java/java_string_field.cc @@ -316,7 +316,8 @@ void ImmutableStringFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " java.lang.String value) {\n" @@ -327,7 +328,8 @@ void ImmutableStringFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, CLEARER); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -342,7 +344,8 @@ void ImmutableStringFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); - WriteFieldStringBytesAccessorDocComment(printer, descriptor_, SETTER); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$set$capitalized_name$Bytes$}$(\n" @@ -608,7 +611,8 @@ void ImmutableStringOneofFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " java.lang.String value) {\n" @@ -619,7 +623,8 @@ void ImmutableStringOneofFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -632,7 +637,8 @@ void ImmutableStringOneofFieldGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldStringBytesAccessorDocComment(printer, descriptor_, SETTER, true); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$set$capitalized_name$Bytes$}$(\n" @@ -840,7 +846,8 @@ void RepeatedImmutableStringFieldGenerator::GenerateBuilderMembers( " return $name$_.getByteString(index);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER, true); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " int index, java.lang.String value) {\n" @@ -851,7 +858,8 @@ void RepeatedImmutableStringFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER, true); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder ${$add$capitalized_name$$}$(\n" " java.lang.String value) {\n" @@ -862,7 +870,8 @@ void RepeatedImmutableStringFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER, true); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder ${$addAll$capitalized_name$$}$(\n" " java.lang.Iterable values) {\n" @@ -873,7 +882,8 @@ void RepeatedImmutableStringFieldGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -885,7 +895,7 @@ void RepeatedImmutableStringFieldGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); WriteFieldStringBytesAccessorDocComment(printer, descriptor_, LIST_ADDER, - true); + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$add$capitalized_name$Bytes$}$(\n" diff --git a/src/google/protobuf/compiler/java/java_string_field_lite.cc b/src/google/protobuf/compiler/java/java_string_field_lite.cc index 710a615b31..1e856f253d 100644 --- a/src/google/protobuf/compiler/java/java_string_field_lite.cc +++ b/src/google/protobuf/compiler/java/java_string_field_lite.cc @@ -273,7 +273,8 @@ void ImmutableStringFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " java.lang.String value) {\n" @@ -282,7 +283,8 @@ void ImmutableStringFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -292,7 +294,8 @@ void ImmutableStringFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldStringBytesAccessorDocComment(printer, descriptor_, SETTER, true); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$set$capitalized_name$Bytes$}$(\n" @@ -451,7 +454,8 @@ void ImmutableStringOneofFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, SETTER, true); + WriteFieldAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " java.lang.String value) {\n" @@ -460,7 +464,8 @@ void ImmutableStringOneofFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -470,7 +475,8 @@ void ImmutableStringOneofFieldLiteGenerator::GenerateBuilderMembers( "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldStringBytesAccessorDocComment(printer, descriptor_, SETTER); + WriteFieldStringBytesAccessorDocComment(printer, descriptor_, SETTER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$set$capitalized_name$Bytes$}$(\n" @@ -651,7 +657,8 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateBuilderMembers( " return instance.get$capitalized_name$Bytes(index);\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER, true); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_INDEXED_SETTER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder ${$set$capitalized_name$$}$(\n" " int index, java.lang.String value) {\n" @@ -660,7 +667,8 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_ADDER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder ${$add$capitalized_name$$}$(\n" " java.lang.String value) {\n" @@ -669,7 +677,8 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER, true); + WriteFieldAccessorDocComment(printer, descriptor_, LIST_MULTI_ADDER, + /* builder */ true); printer->Print(variables_, "$deprecation$public Builder ${$addAll$capitalized_name$$}$(\n" " java.lang.Iterable values) {\n" @@ -678,7 +687,8 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateBuilderMembers( " return this;\n" "}\n"); printer->Annotate("{", "}", descriptor_); - WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, true); + WriteFieldAccessorDocComment(printer, descriptor_, CLEARER, + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$clear$capitalized_name$$}$() {\n" @@ -689,7 +699,7 @@ void RepeatedImmutableStringFieldLiteGenerator::GenerateBuilderMembers( printer->Annotate("{", "}", descriptor_); WriteFieldStringBytesAccessorDocComment(printer, descriptor_, LIST_ADDER, - true); + /* builder */ true); printer->Print( variables_, "$deprecation$public Builder ${$add$capitalized_name$Bytes$}$(\n" From 351a7cdf7353d1dddac9a0fc18a87153dc8ad041 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Wed, 26 Jun 2019 20:43:34 +0200 Subject: [PATCH 4/4] Follow line length guidelines --- .../protobuf/compiler/java/java_doc_comment.cc | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/google/protobuf/compiler/java/java_doc_comment.cc b/src/google/protobuf/compiler/java/java_doc_comment.cc index cc92b7aa8d..2aee232354 100644 --- a/src/google/protobuf/compiler/java/java_doc_comment.cc +++ b/src/google/protobuf/compiler/java/java_doc_comment.cc @@ -271,13 +271,13 @@ void WriteFieldEnumValueAccessorDocComment(io::Printer* printer, // Should never happen break; case LIST_GETTER: - printer->Print(" * @return A list containing the enum values for $name$(s).\n", - "name", field->camelcase_name()); + printer->Print(" * @return A list containing the enum values for " + "$name$(s).\n", "name", field->camelcase_name()); break; case LIST_INDEXED_GETTER: printer->Print(" * @param index The index of the value to return.\n"); - printer->Print(" * @return The enum value of the $name$ at the given index.\n", - "name", field->camelcase_name()); + printer->Print(" * @return The enum value of the $name$ at the given " + "index.\n", "name", field->camelcase_name()); break; case LIST_INDEXED_SETTER: printer->Print(" * @param index The index to set the value at.\n"); @@ -289,8 +289,8 @@ void WriteFieldEnumValueAccessorDocComment(io::Printer* printer, "name", field->camelcase_name()); break; case LIST_MULTI_ADDER: - printer->Print(" * @param values The enum values of the $name$(s) to add.\n", - "name", field->camelcase_name()); + printer->Print(" * @param values The enum values of the $name$(s) to " + "add.\n", "name", field->camelcase_name()); break; } if (builder) {