diff --git a/SabreTools.Library/Tools/Style.cs b/SabreTools.Library/Tools/Style.cs index 00f809ea..4dbf6dfa 100644 --- a/SabreTools.Library/Tools/Style.cs +++ b/SabreTools.Library/Tools/Style.cs @@ -530,7 +530,7 @@ namespace SabreTools.Library.Tools #region Externally sourced methods /// - /// Returns the human-readable file size for an arbitrary, 64-bit file size + /// Returns the human-readable file size for an arbitrary, 64-bit file size /// The default format is "0.### XB", e.g. "4.2 KB" or "1.434 GB" /// /// @@ -584,8 +584,11 @@ namespace SabreTools.Library.Tools } /// - /// http://stackoverflow.com/questions/311165/how-do-you-convert-byte-array-to-hexadecimal-string-and-vice-versa + /// Convert a byte array to a hex string /// + /// Byte array to convert + /// Hex string representing the byte array + /// http://stackoverflow.com/questions/311165/how-do-you-convert-byte-array-to-hexadecimal-string-and-vice-versa public static string ByteArrayToString(byte[] bytes) { try @@ -600,8 +603,11 @@ namespace SabreTools.Library.Tools } /// - /// http://stackoverflow.com/questions/311165/how-do-you-convert-byte-array-to-hexadecimal-string-and-vice-versa + /// Convert a hex string to a byte array /// + /// Hex string to convert + /// Byte array represenging the hex string + /// http://stackoverflow.com/questions/311165/how-do-you-convert-byte-array-to-hexadecimal-string-and-vice-versa public static byte[] StringToByteArray(string hex) { try @@ -619,8 +625,11 @@ namespace SabreTools.Library.Tools } /// - /// http://stackoverflow.com/questions/5613279/c-sharp-hex-to-ascii + /// Convert a hex string to an ASCII one /// + /// Hex string to convert + /// ASCII string representing the hex string + /// http://stackoverflow.com/questions/5613279/c-sharp-hex-to-ascii public static string ConvertHexToAscii(string hexString) { if (hexString.Contains("-")) @@ -640,8 +649,11 @@ namespace SabreTools.Library.Tools } /// - /// http://stackoverflow.com/questions/15920741/convert-from-string-ascii-to-string-hex + /// Convert an ASCII string to a hex one /// + /// ASCII string to convert + /// Hex string representing the ASCII string + /// http://stackoverflow.com/questions/15920741/convert-from-string-ascii-to-string-hex public static string ConvertAsciiToHex(string asciiString) { string hexOutput = ""; @@ -659,8 +671,13 @@ namespace SabreTools.Library.Tools } /// - /// Adapted from 7-zip Source Code: CPP/Windows/TimeUtils.cpp:FileTimeToDosTime + /// Convert .NET DateTime to MS-DOS date format /// + /// .NET DateTime object to convert + /// UInt32 representing the MS-DOS date + /// + /// Adapted from 7-zip Source Code: CPP/Windows/TimeUtils.cpp:FileTimeToDosTime + /// public static uint ConvertDateTimeToMsDosTimeFormat(DateTime dateTime) { uint year = (uint)((dateTime.Year - 1980) % 128); @@ -674,8 +691,13 @@ namespace SabreTools.Library.Tools } /// - /// Adapted from 7-zip Source Code: CPP/Windows/TimeUtils.cpp:DosTimeToFileTime + /// Convert MS-DOS date format to .NET DateTime /// + /// UInt32 representing the MS-DOS date to convert + /// .NET DateTime object representing the converted date + /// + /// Adapted from 7-zip Source Code: CPP/Windows/TimeUtils.cpp:DosTimeToFileTime + /// public static DateTime ConvertMsDosTimeFormatToDateTime(uint msDosDateTime) { return new DateTime((int)(1980 + (msDosDateTime >> 25)), (int)((msDosDateTime >> 21) & 0xF), (int)((msDosDateTime >> 16) & 0x1F), @@ -685,10 +707,10 @@ namespace SabreTools.Library.Tools /// /// Determines a text file's encoding by analyzing its byte order mark (BOM). /// Defaults to ASCII when detection of the text file's endianness fails. - /// http://stackoverflow.com/questions/3825390/effective-way-to-find-any-files-encoding /// /// The text file to analyze. /// The detected encoding. + /// http://stackoverflow.com/questions/3825390/effective-way-to-find-any-files-encoding public static Encoding GetEncoding(string filename) { // Read the BOM @@ -707,8 +729,12 @@ namespace SabreTools.Library.Tools } /// - /// http://stackoverflow.com/questions/1600962/displaying-the-build-date + /// Extension method to get the DateTime that an assembly was linked /// + /// Assembly to get linker time from + /// Target timezone to convert the time to (default null) + /// DateTime that the assembly was linked + /// http://stackoverflow.com/questions/1600962/displaying-the-build-date public static DateTime GetLinkerTime(this Assembly assembly, TimeZoneInfo target = null) { var filePath = assembly.Location; @@ -733,11 +759,11 @@ namespace SabreTools.Library.Tools } /// - /// Indicates whether the specified array is null or has a length of zero. - /// https://stackoverflow.com/questions/8560106/isnullorempty-equivalent-for-array-c-sharp + /// Indicates whether the specified array is null or has a length of zero /// - /// The array to test. + /// The array to test /// true if the array parameter is null or has a length of zero; otherwise, false. + /// https://stackoverflow.com/questions/8560106/isnullorempty-equivalent-for-array-c-sharp public static bool IsNullOrEmpty(this Array array) { return (array == null || array.Length == 0);