aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJon Skeet <jonskeet@google.com>2018-09-19 09:22:25 +0100
committerJon Skeet <skeet@pobox.com>2018-09-22 09:09:15 +0100
commit6e39eaad3ce12330ae2cff306f6bc88767513f75 (patch)
treec3f490f12be790529dd9d47d88fb637243eddf4c
parent0b314d745b82aa758eb7b9d117361d4cc24117f6 (diff)
downloadprotobuf-6e39eaad3ce12330ae2cff306f6bc88767513f75.tar.gz
protobuf-6e39eaad3ce12330ae2cff306f6bc88767513f75.tar.bz2
protobuf-6e39eaad3ce12330ae2cff306f6bc88767513f75.zip
Add more detailed comments for declaration properties
-rw-r--r--csharp/src/Google.Protobuf/Reflection/DescriptorDeclaration.cs16
1 files changed, 11 insertions, 5 deletions
diff --git a/csharp/src/Google.Protobuf/Reflection/DescriptorDeclaration.cs b/csharp/src/Google.Protobuf/Reflection/DescriptorDeclaration.cs
index 613d6545..b22048f0 100644
--- a/csharp/src/Google.Protobuf/Reflection/DescriptorDeclaration.cs
+++ b/csharp/src/Google.Protobuf/Reflection/DescriptorDeclaration.cs
@@ -64,24 +64,30 @@ namespace Google.Protobuf.Reflection
/// </summary>
public int EndLine { get; }
/// <summary>
- /// The end column of the declaration within the source file. This value is 1-based.
+ /// The end column of the declaration within the source file. This value is 1-based, and
+ /// exclusive. (The final character of the declaration is on the column before this value.)
/// </summary>
public int EndColumn { get; }
/// <summary>
- /// Comments appearing before the declaration. Never null, but may be empty.
+ /// Comments appearing before the declaration. Never null, but may be empty. Multi-line comments
+ /// are represented as a newline-separated string. Leading whitespace and the comment marker ("//")
+ /// are removed from each line.
/// </summary>
public string LeadingComments { get; }
/// <summary>
- /// Comments appearing after the declaration. Never null, but may be empty.
+ /// Comments appearing after the declaration. Never null, but may be empty. Multi-line comments
+ /// are represented as a newline-separated string. Leading whitespace and the comment marker ("//")
+ /// are removed from each line.
/// </summary>
public string TrailingComments { get; }
/// <summary>
/// Comments appearing before the declaration, but separated from it by blank
- /// lines. Each string represents a paragraph of comments. The list is never null,
- /// but may be empty. Likewise each element is never null, but may be empty.
+ /// lines. Each string represents a newline-separated paragraph of comments.
+ /// Leading whitespace and the comment marker ("//") are removed from each line.
+ /// The list is never null, but may be empty. Likewise each element is never null, but may be empty.
/// </summary>
public IReadOnlyList<string> LeadingDetachedComments { get; }