diff options
author | Jon Skeet <skeet@pobox.com> | 2015-09-30 09:58:07 +0100 |
---|---|---|
committer | Jon Skeet <skeet@pobox.com> | 2015-09-30 09:58:07 +0100 |
commit | aa7ea3b698ed0ca4ae7e9bf2b1996db00063de32 (patch) | |
tree | f0283ea0d6ad799dcf1e66e96774c4f6298905e0 /csharp/src/Google.Protobuf | |
parent | 5ebac49f1ed26b9c71bab6b47c92542be367f278 (diff) | |
parent | 6bbbdfa24c51c9aae1c58f25c84ad9759f05eab9 (diff) | |
download | protobuf-aa7ea3b698ed0ca4ae7e9bf2b1996db00063de32.tar.gz protobuf-aa7ea3b698ed0ca4ae7e9bf2b1996db00063de32.tar.bz2 protobuf-aa7ea3b698ed0ca4ae7e9bf2b1996db00063de32.zip |
Merge pull request #834 from jskeet/docfixes
Add (some) XML documentation to generated code
Diffstat (limited to 'csharp/src/Google.Protobuf')
13 files changed, 32 insertions, 2 deletions
diff --git a/csharp/src/Google.Protobuf/CodedInputStream.cs b/csharp/src/Google.Protobuf/CodedInputStream.cs index 82c6ceab..65d0e710 100644 --- a/csharp/src/Google.Protobuf/CodedInputStream.cs +++ b/csharp/src/Google.Protobuf/CodedInputStream.cs @@ -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>
diff --git a/csharp/src/Google.Protobuf/Reflection/DescriptorProtoFile.cs b/csharp/src/Google.Protobuf/Reflection/DescriptorProtoFile.cs index 5072abe2..410df3c5 100644 --- a/csharp/src/Google.Protobuf/Reflection/DescriptorProtoFile.cs +++ b/csharp/src/Google.Protobuf/Reflection/DescriptorProtoFile.cs @@ -9,10 +9,12 @@ using pbr = global::Google.Protobuf.Reflection; using scg = global::System.Collections.Generic; namespace Google.Protobuf.Reflection { + /// <summary>Holder for reflection information generated from google/protobuf/descriptor.proto</summary> [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] internal static partial class DescriptorProtoFile { #region Descriptor + /// <summary>File descriptor for google/protobuf/descriptor.proto</summary> public static pbr::FileDescriptor Descriptor { get { return descriptor; } } @@ -877,6 +879,7 @@ namespace Google.Protobuf.Reflection { } #region Nested types + /// <summary>Container for nested types declared in the DescriptorProto message type.</summary> [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] public static partial class Types { [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] @@ -1455,6 +1458,7 @@ namespace Google.Protobuf.Reflection { } #region Nested types + /// <summary>Container for nested types declared in the FieldDescriptorProto message type.</summary> [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] public static partial class Types { internal enum Type { @@ -2776,6 +2780,7 @@ namespace Google.Protobuf.Reflection { } #region Nested types + /// <summary>Container for nested types declared in the FileOptions message type.</summary> [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] public static partial class Types { internal enum OptimizeMode { @@ -3236,6 +3241,7 @@ namespace Google.Protobuf.Reflection { } #region Nested types + /// <summary>Container for nested types declared in the FieldOptions message type.</summary> [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] public static partial class Types { internal enum CType { @@ -4010,6 +4016,7 @@ namespace Google.Protobuf.Reflection { } #region Nested types + /// <summary>Container for nested types declared in the UninterpretedOption message type.</summary> [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] public static partial class Types { [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] @@ -4238,6 +4245,7 @@ namespace Google.Protobuf.Reflection { } #region Nested types + /// <summary>Container for nested types declared in the SourceCodeInfo message type.</summary> [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] public static partial class Types { [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] diff --git a/csharp/src/Google.Protobuf/Reflection/FieldDescriptor.cs b/csharp/src/Google.Protobuf/Reflection/FieldDescriptor.cs index 901cbf47..619a6ac8 100644 --- a/csharp/src/Google.Protobuf/Reflection/FieldDescriptor.cs +++ b/csharp/src/Google.Protobuf/Reflection/FieldDescriptor.cs @@ -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; } diff --git a/csharp/src/Google.Protobuf/WellKnownTypes/Any.cs b/csharp/src/Google.Protobuf/WellKnownTypes/Any.cs index 51ff2d4e..6bcdfdef 100644 --- a/csharp/src/Google.Protobuf/WellKnownTypes/Any.cs +++ b/csharp/src/Google.Protobuf/WellKnownTypes/Any.cs @@ -11,10 +11,12 @@ namespace Google.Protobuf.WellKnownTypes { namespace Proto { + /// <summary>Holder for reflection information generated from google/protobuf/any.proto</summary> [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] public static partial class Any { #region Descriptor + /// <summary>File descriptor for google/protobuf/any.proto</summary> public static pbr::FileDescriptor Descriptor { get { return descriptor; } } diff --git a/csharp/src/Google.Protobuf/WellKnownTypes/Api.cs b/csharp/src/Google.Protobuf/WellKnownTypes/Api.cs index 4d06ff35..f2166ca5 100644 --- a/csharp/src/Google.Protobuf/WellKnownTypes/Api.cs +++ b/csharp/src/Google.Protobuf/WellKnownTypes/Api.cs @@ -11,10 +11,12 @@ namespace Google.Protobuf.WellKnownTypes { namespace Proto { + /// <summary>Holder for reflection information generated from google/protobuf/api.proto</summary> [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] public static partial class Api { #region Descriptor + /// <summary>File descriptor for google/protobuf/api.proto</summary> public static pbr::FileDescriptor Descriptor { get { return descriptor; } } diff --git a/csharp/src/Google.Protobuf/WellKnownTypes/Duration.cs b/csharp/src/Google.Protobuf/WellKnownTypes/Duration.cs index fce1de0b..e671eac8 100644 --- a/csharp/src/Google.Protobuf/WellKnownTypes/Duration.cs +++ b/csharp/src/Google.Protobuf/WellKnownTypes/Duration.cs @@ -11,10 +11,12 @@ namespace Google.Protobuf.WellKnownTypes { namespace Proto { + /// <summary>Holder for reflection information generated from google/protobuf/duration.proto</summary> [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] public static partial class Duration { #region Descriptor + /// <summary>File descriptor for google/protobuf/duration.proto</summary> public static pbr::FileDescriptor Descriptor { get { return descriptor; } } diff --git a/csharp/src/Google.Protobuf/WellKnownTypes/Empty.cs b/csharp/src/Google.Protobuf/WellKnownTypes/Empty.cs index 2d87aaaa..050f7476 100644 --- a/csharp/src/Google.Protobuf/WellKnownTypes/Empty.cs +++ b/csharp/src/Google.Protobuf/WellKnownTypes/Empty.cs @@ -11,10 +11,12 @@ namespace Google.Protobuf.WellKnownTypes { namespace Proto { + /// <summary>Holder for reflection information generated from google/protobuf/empty.proto</summary> [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] public static partial class Empty { #region Descriptor + /// <summary>File descriptor for google/protobuf/empty.proto</summary> public static pbr::FileDescriptor Descriptor { get { return descriptor; } } diff --git a/csharp/src/Google.Protobuf/WellKnownTypes/FieldMask.cs b/csharp/src/Google.Protobuf/WellKnownTypes/FieldMask.cs index a73a6360..14acf394 100644 --- a/csharp/src/Google.Protobuf/WellKnownTypes/FieldMask.cs +++ b/csharp/src/Google.Protobuf/WellKnownTypes/FieldMask.cs @@ -11,10 +11,12 @@ namespace Google.Protobuf.WellKnownTypes { namespace Proto { + /// <summary>Holder for reflection information generated from google/protobuf/field_mask.proto</summary> [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] public static partial class FieldMask { #region Descriptor + /// <summary>File descriptor for google/protobuf/field_mask.proto</summary> public static pbr::FileDescriptor Descriptor { get { return descriptor; } } diff --git a/csharp/src/Google.Protobuf/WellKnownTypes/SourceContext.cs b/csharp/src/Google.Protobuf/WellKnownTypes/SourceContext.cs index d80c50f3..e4d063b0 100644 --- a/csharp/src/Google.Protobuf/WellKnownTypes/SourceContext.cs +++ b/csharp/src/Google.Protobuf/WellKnownTypes/SourceContext.cs @@ -11,10 +11,12 @@ namespace Google.Protobuf.WellKnownTypes { namespace Proto { + /// <summary>Holder for reflection information generated from google/protobuf/source_context.proto</summary> [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] public static partial class SourceContext { #region Descriptor + /// <summary>File descriptor for google/protobuf/source_context.proto</summary> public static pbr::FileDescriptor Descriptor { get { return descriptor; } } diff --git a/csharp/src/Google.Protobuf/WellKnownTypes/Struct.cs b/csharp/src/Google.Protobuf/WellKnownTypes/Struct.cs index cab771c0..257d52d8 100644 --- a/csharp/src/Google.Protobuf/WellKnownTypes/Struct.cs +++ b/csharp/src/Google.Protobuf/WellKnownTypes/Struct.cs @@ -11,10 +11,12 @@ namespace Google.Protobuf.WellKnownTypes { namespace Proto { + /// <summary>Holder for reflection information generated from google/protobuf/struct.proto</summary> [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] public static partial class Struct { #region Descriptor + /// <summary>File descriptor for google/protobuf/struct.proto</summary> public static pbr::FileDescriptor Descriptor { get { return descriptor; } } @@ -253,6 +255,7 @@ namespace Google.Protobuf.WellKnownTypes { } private object kind_; + /// <summary>Enum of possible cases for the "kind" oneof.</summary> public enum KindOneofCase { None = 0, NullValue = 1, diff --git a/csharp/src/Google.Protobuf/WellKnownTypes/Timestamp.cs b/csharp/src/Google.Protobuf/WellKnownTypes/Timestamp.cs index 5c652dc2..6b186b37 100644 --- a/csharp/src/Google.Protobuf/WellKnownTypes/Timestamp.cs +++ b/csharp/src/Google.Protobuf/WellKnownTypes/Timestamp.cs @@ -11,10 +11,12 @@ namespace Google.Protobuf.WellKnownTypes { namespace Proto { + /// <summary>Holder for reflection information generated from google/protobuf/timestamp.proto</summary> [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] public static partial class Timestamp { #region Descriptor + /// <summary>File descriptor for google/protobuf/timestamp.proto</summary> public static pbr::FileDescriptor Descriptor { get { return descriptor; } } diff --git a/csharp/src/Google.Protobuf/WellKnownTypes/Type.cs b/csharp/src/Google.Protobuf/WellKnownTypes/Type.cs index eb676945..48039d66 100644 --- a/csharp/src/Google.Protobuf/WellKnownTypes/Type.cs +++ b/csharp/src/Google.Protobuf/WellKnownTypes/Type.cs @@ -11,10 +11,12 @@ namespace Google.Protobuf.WellKnownTypes { namespace Proto { + /// <summary>Holder for reflection information generated from google/protobuf/type.proto</summary> [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] public static partial class Type { #region Descriptor + /// <summary>File descriptor for google/protobuf/type.proto</summary> public static pbr::FileDescriptor Descriptor { get { return descriptor; } } @@ -595,6 +597,7 @@ namespace Google.Protobuf.WellKnownTypes { } #region Nested types + /// <summary>Container for nested types declared in the Field message type.</summary> [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] public static partial class Types { public enum Kind { diff --git a/csharp/src/Google.Protobuf/WellKnownTypes/Wrappers.cs b/csharp/src/Google.Protobuf/WellKnownTypes/Wrappers.cs index 7e63d805..e5d9e7d4 100644 --- a/csharp/src/Google.Protobuf/WellKnownTypes/Wrappers.cs +++ b/csharp/src/Google.Protobuf/WellKnownTypes/Wrappers.cs @@ -9,10 +9,12 @@ using pbr = global::Google.Protobuf.Reflection; using scg = global::System.Collections.Generic; namespace Google.Protobuf.WellKnownTypes { + /// <summary>Holder for reflection information generated from google/protobuf/wrappers.proto</summary> [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] public static partial class Wrappers { #region Descriptor + /// <summary>File descriptor for google/protobuf/wrappers.proto</summary> public static pbr::FileDescriptor Descriptor { get { return descriptor; } } |