organicmaps/protobuf
13
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity Actions

Added documentation to generated code.

Browse source 
There are now summaries for:
- The Types nested class (which holds nested types)
- The file descriptor class for each proto
- The enum generated for each oneof

(Also fixed two typos.)

Generated code in next commit.
This commit is contained in:
Jon Skeet 2015-09-29 13:37:15 +01:00
parent 0e5686a707
commit 2212f56bcd
4 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
csharp/src/Google.Protobuf/CodedInputStream.cs
View file

@ -38,7 +38,7 @@ using System.IO;
namespace Google.Protobuf
{
/// <summary>
/// Readings and decodes protocol message fields.
/// Reads and decodes protocol message fields.
/// </summary>
/// <remarks>
/// <para>

2
csharp/src/Google.Protobuf/Reflection/FieldDescriptor.cs
View file

@ -252,7 +252,7 @@ namespace Google.Protobuf.Reflection
{
if (fieldType != FieldType.Message)
{
throw new InvalidOperationException("MessageType is only valid for enum fields.");
throw new InvalidOperationException("MessageType is only valid for message fields.");
}
return messageType;
}

6
src/google/protobuf/compiler/csharp/csharp_message.cc
View file

@ -169,6 +169,7 @@ void MessageGenerator::Generate(io::Printer* printer) {
printer->Print(
vars,
"private object $name$_;\n"
"/// <summary>Enum of possibly cases for the \"$original_name$\" oneof.</summary>\n"
"public enum $property_name$OneofCase {\n");
printer->Indent();
printer->Print("None = 0,\n");
@ -202,7 +203,10 @@ void MessageGenerator::Generate(io::Printer* printer) {
printer->Print("#region Nested types\n"
"[global::System.Diagnostics.DebuggerNonUserCodeAttribute()]\n");
WriteGeneratedCodeAttributes(printer);
printer->Print("public static partial class Types {\n");
printer->Print(
vars,
"/// <summary>Container for nested types declared in the $class_name$ message type.</summary>\n"
"public static partial class Types {\n");
printer->Indent();
for (int i = 0; i < descriptor_->enum_type_count(); i++) {
EnumGenerator enumGenerator(descriptor_->enum_type(i));

4
src/google/protobuf/compiler/csharp/csharp_umbrella_class.cc
View file

@ -138,8 +138,10 @@ void UmbrellaClassGenerator::WriteIntroduction(io::Printer* printer) {
"[global::System.Diagnostics.DebuggerNonUserCodeAttribute()]\n");
WriteGeneratedCodeAttributes(printer);
printer->Print(
"/// <summary>Holder for reflection information generated from $file_name$</summary>\n"
"$access_level$ static partial class $umbrella_class_name$ {\n"
"\n",
"file_name", file_->name(),
"access_level", class_access_level(),
"umbrella_class_name", umbrellaClassname_);
printer->Indent();
@ -148,12 +150,14 @@ void UmbrellaClassGenerator::WriteIntroduction(io::Printer* printer) {
void UmbrellaClassGenerator::WriteDescriptor(io::Printer* printer) {
printer->Print(
"#region Descriptor\n"
"/// <summary>File descriptor for $file_name$</summary>\n"
"public static pbr::FileDescriptor Descriptor {\n"
" get { return descriptor; }\n"
"}\n"
"private static pbr::FileDescriptor descriptor;\n"
"\n"
"static $umbrella_class_name$() {\n",
"file_name", file_->name(),
"umbrella_class_name", umbrellaClassname_);
printer->Indent();
printer->Print(