diff options
author | Jon Skeet <jonskeet@google.com> | 2015-08-04 15:58:39 +0100 |
---|---|---|
committer | Jon Skeet <jonskeet@google.com> | 2015-08-04 15:58:39 +0100 |
commit | 811fc89f0eb036d95653f5fed4b0ffea292ce791 (patch) | |
tree | e1e724bda1b599c036f7326974829d1bf79a6951 /csharp/src/Google.Protobuf/WellKnownTypes/TimestampPartial.cs | |
parent | dc80689af3951d078cb556588eece89dd6860c91 (diff) | |
download | protobuf-811fc89f0eb036d95653f5fed4b0ffea292ce791.tar.gz protobuf-811fc89f0eb036d95653f5fed4b0ffea292ce791.tar.bz2 protobuf-811fc89f0eb036d95653f5fed4b0ffea292ce791.zip |
Document everything, and turn on errors if we fail to document anything in the future.
Diffstat (limited to 'csharp/src/Google.Protobuf/WellKnownTypes/TimestampPartial.cs')
-rw-r--r-- | csharp/src/Google.Protobuf/WellKnownTypes/TimestampPartial.cs | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/csharp/src/Google.Protobuf/WellKnownTypes/TimestampPartial.cs b/csharp/src/Google.Protobuf/WellKnownTypes/TimestampPartial.cs index 1aa392c7..68584358 100644 --- a/csharp/src/Google.Protobuf/WellKnownTypes/TimestampPartial.cs +++ b/csharp/src/Google.Protobuf/WellKnownTypes/TimestampPartial.cs @@ -136,9 +136,12 @@ namespace Google.Protobuf.WellKnownTypes } /// <summary> - /// Converts the specified <see cref="DateTimeOffset"/> to a <see cref="Timestamp"/>. + /// Converts the given <see cref="DateTimeOffset"/> to a <see cref="Timestamp"/> /// </summary> - /// <param name="dateTime"></param> + /// <remarks>The offset is taken into consideration when converting the value (so the same instant in time + /// is represented) but is not a separate part of the resulting value. In other words, there is no + /// roundtrip operation to retrieve the original <c>DateTimeOffset</c>.</remarks> + /// <param name="dateTimeOffset">The date and time (with UTC offset) to convert to a timestamp.</param> /// <returns>The converted timestamp.</returns> public static Timestamp FromDateTimeOffset(DateTimeOffset dateTimeOffset) { |