Improved documentation

openactive · Jun 20, 2021 · 3fe60bf · 3fe60bf
1 parent 2feb2d9
commit 3fe60bf
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 12 deletions.
diff --git a/OpenActive.NET/DateTimeValue.cs b/OpenActive.NET/DateTimeValue.cs
@@ -46,18 +46,18 @@ public DateTimeValue(string value)
         }
 
 
-    /// <summary>
-    /// Gets the value of the current DateTimeValue object if it has been assigned an underlying value.
-    /// </summary>
-    public DateTimeOffset Value { get => NullableValue.Value; }
+        /// <summary>
+        /// Gets the value of the current DateTimeValue object if it has been assigned an underlying value.
+        /// </summary>
+        public DateTimeOffset Value { get => NullableValue.Value; }
 
         /// <summary>
-        /// Gets the value of the current DateTimeValue object as a Nullable<> type.
+        /// Gets the value of the underlying DateTimeOffset? object as a Nullable<> type.
         /// </summary>
         public DateTimeOffset? NullableValue { get; private set; }
 
         /// <summary>
-        /// Gets the value indicating whether the DateTimeValue object has a valid value of its underlying type
+        /// Gets the value indicating whether the DateTimeValue object has a valid value
         /// </summary>
         public bool HasValue { get => NullableValue.HasValue; }
 
@@ -78,7 +78,7 @@ object IValue.Value
         }
 
         /// <summary>
-        /// Gets a value indicating whether this instance has a value.
+        /// Indicating whether the value represents only a date (true) or a date with time (false).
         /// </summary>
         public bool IsDateOnly { get; set; }
 
@@ -135,7 +135,7 @@ object IValue.Value
         public override bool Equals(object obj) => obj is DateTimeValue ? this.Equals((DateTimeValue)obj) : false;
 
         /// <summary>
-        /// Implements ToString
+        /// Returns the value in "yyyy-MM-dd" format (if IsDateOnly) or "yyyy-MM-ddTHH:mm:sszzz" format otherwise
         /// </summary>
         /// <returns>
         /// A string representing the relevant value

diff --git a/OpenActive.NET/DateValue.cs b/OpenActive.NET/DateValue.cs
@@ -47,7 +47,7 @@ public DateValue(string value)
         public DateTimeOffset Value { get => NullableValue.Value; }
 
         /// <summary>
-        /// Gets the value of the current DateValue object as a Nullable<> type.
+        /// Gets the value of the underlying DateTimeOffset? object as a Nullable<> type.
         /// </summary>
         public DateTimeOffset? NullableValue { get; private set; }
 
@@ -125,7 +125,7 @@ object IValue.Value
         public override bool Equals(object obj) => obj is DateValue ? this.Equals((DateValue)obj) : false;
 
         /// <summary>
-        /// Implements ToString
+        /// Returns the value in "yyyy-MM-dd" format
         /// </summary>
         /// <returns>
         /// A string representing the relevant value

diff --git a/OpenActive.NET/TimeValue.cs b/OpenActive.NET/TimeValue.cs
@@ -56,7 +56,7 @@ public TimeValue(string value)
         public DateTimeOffset Value { get => NullableValue.Value; }
 
         /// <summary>
-        /// Gets the value of the current TimeValue object as a Nullable<> type.
+        /// Gets the value of the underlying DateTimeOffset? object as a Nullable<> type.
         /// </summary>
         public DateTimeOffset? NullableValue { get; private set; }
 
@@ -134,7 +134,7 @@ object IValue.Value
         public override bool Equals(object obj) => obj is TimeValue ? this.Equals((TimeValue)obj) : false;
 
         /// <summary>
-        /// Implements ToString
+        /// Returns the value in "HH:mm" format
         /// </summary>
         /// <returns>
         /// A string representing the relevant value