Fix updated Doxygen errors. (microsoft#6588)

shaoboyan091 · Feb 6, 2021 · dda5a62 · dda5a62
1 parent 115e16b
commit dda5a62
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/csharp/src/Microsoft.ML.OnnxRuntime/Tensors/Tensor.cs b/csharp/src/Microsoft.ML.OnnxRuntime/Tensors/Tensor.cs
@@ -922,6 +922,12 @@ public Tensor<T> GetUpperTriangle(int offset)
             return GetTriangle(offset, upper: true);
         }
 
+        /// <summary>
+        /// Implementation method for GetTriangle, GetLowerTriangle, GetUpperTriangle
+        /// </summary>
+        /// <param name="offset">Offset of diagonal to set in returned tensor.</param>
+        /// <param name="upper">true for upper triangular and false otherwise</param>
+        /// <returns></returns>
         public Tensor<T> GetTriangle(int offset, bool upper)
         {
             if (Rank < 2)
@@ -1158,8 +1164,16 @@ object IList.this[int index]
             }
         }
 
+        /// <summary>
+        /// Always fixed size Tensor
+        /// </summary>
+        /// <value>always true</value>
         public bool IsFixedSize => true;
 
+        /// <summary>
+        /// Tensor is not readonly
+        /// </summary>
+        /// <value>always false</value>
         public bool IsReadOnly => false;
 
         int IList.Add(object value)
@@ -1566,6 +1580,11 @@ public virtual DenseTensor<T> ToDenseTensor()
 
         #endregion
 
+        /// <summary>
+        /// Get a string representation of Tensor
+        /// </summary>
+        /// <param name="includeWhitespace"></param>
+        /// <returns></returns>
         public string GetArrayString(bool includeWhitespace = true)
         {
             var builder = new StringBuilder();