deprecate optional parameters in BlobExtensions

Author: shiftkey

LibGit2Sharp/BlobExtensions.cs

@@ -9,21 +9,43 @@ namespace LibGit2Sharp
     /// </summary>
     public static class BlobExtensions
     {
+        /// <summary>
+        /// Gets the blob content, decoded with UTF8 encoding if the encoding cannot be detected
+        /// </summary>
+        /// <param name="blob">The blob for which the content will be returned.</param>
+        /// <returns>Blob content as text.</returns>
+        public static string GetContentText(this Blob blob)
+        {
+            Ensure.ArgumentNotNull(blob, "blob");
+
+            return ReadToEnd(blob.GetContentStream(), Encoding.UTF8);
+        }
+
         /// <summary>
         /// Gets the blob content decoded with the specified encoding,
-        /// or according to byte order marks, with UTF8 as fallback,
-        /// if <paramref name="encoding"/> is null.
+        /// or according to byte order marks, or the specified encoding as a fallback
         /// </summary>
         /// <param name="blob">The blob for which the content will be returned.</param>
-        /// <param name="encoding">The encoding of the text. (default: detected or UTF8)</param>
+        /// <param name="encoding">The encoding of the text to use, if it cannot be detected</param>
         /// <returns>Blob content as text.</returns>
-        public static string GetContentText(this Blob blob, Encoding encoding = null)
+        public static string GetContentText(this Blob blob, Encoding encoding)
         {
             Ensure.ArgumentNotNull(blob, "blob");
 
             return ReadToEnd(blob.GetContentStream(), encoding);
         }
 
+        /// <summary>
+        /// Gets the blob content, decoded with UTF8 encoding if the encoding cannot be detected
+        /// </summary>
+        /// <param name="blob">The blob for which the content will be returned.</param>
+        /// <param name="filteringOptions">Parameter controlling content filtering behavior</param>
+        /// <returns>Blob content as text.</returns>
+        public static string GetContentText(this Blob blob, FilteringOptions filteringOptions)
+        {
+            return blob.GetContentText(filteringOptions, Encoding.UTF8);
+        }
+
         /// <summary>
         /// Gets the blob content as it would be checked out to the
         /// working directory, decoded with the specified encoding,
@@ -34,7 +56,7 @@ public static string GetContentText(this Blob blob, Encoding encoding = null)
         /// <param name="filteringOptions">Parameter controlling content filtering behavior</param>
         /// <param name="encoding">The encoding of the text. (default: detected or UTF8)</param>
         /// <returns>Blob content as text.</returns>
-        public static string GetContentText(this Blob blob, FilteringOptions filteringOptions, Encoding encoding = null)
+        public static string GetContentText(this Blob blob, FilteringOptions filteringOptions, Encoding encoding)
         {
             Ensure.ArgumentNotNull(blob, "blob");
             Ensure.ArgumentNotNull(filteringOptions, "filteringOptions");