Detextive.xml

<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly><name>Detextive</name></assembly>
<members>
<member name="M:Detextive.RegexExtensions.RemoveMatches(System.Text.RegularExpressions.Regex,System.String)">
<summary>
 Removes matching patterns from the input string.
</summary>
</member>
<member name="M:Detextive.RegexExtensions.GetMatchValue(System.Text.RegularExpressions.Regex,System.String)">
<summary>
 Returns the portion of the string that matches the pattern.
</summary>
</member>
<member name="T:Detextive.RegexExtensions">
<summary>
 Convenience methods for Regex objects.
</summary>
</member>
<member name="M:Detextive.PSCmdletExtensions.GetItems(System.Management.Automation.PSCmdlet,System.String)">
<summary>
 Returns all matching PSProvider items.
</summary>
</member>
<member name="M:Detextive.PSCmdletExtensions.GetItem(System.Management.Automation.PSCmdlet,System.String)">
<summary>
 Returns the first matching PSProvider item.
</summary>
</member>
<member name="M:Detextive.PSCmdletExtensions.Exists(System.Management.Automation.PSCmdlet,System.String)">
<summary>
 Returns true if the item exists.
</summary>
</member>
<member name="T:Detextive.PSCmdletExtensions">
<summary>
 Convenience methods for PSCmdlet objects.
</summary>
</member>
<member name="F:Detextive.OptimizeUnicodeCommand.InputObject@">
<summary>
 The Unicode string to normalize.
</summary>
</member>
<member name="F:Detextive.OptimizeUnicodeCommand.NormalizationForm@">
<summary>
 The type of normalization to perform.
</summary>
</member>
<member name="P:Detextive.OptimizeUnicodeCommand.NormalizationForm(System.Text.NormalizationForm)">
<summary>
 The type of normalization to perform.
</summary>
</member>
<member name="P:Detextive.OptimizeUnicodeCommand.InputObject(System.String)">
<summary>
 The Unicode string to normalize.
</summary>
</member>
<member name="P:Detextive.OptimizeUnicodeCommand.NormalizationForm">
<summary>
 The type of normalization to perform.
</summary>
</member>
<member name="P:Detextive.OptimizeUnicodeCommand.InputObject">
<summary>
 The Unicode string to normalize.
</summary>
</member>
<member name="T:Detextive.OptimizeUnicodeCommand">
<summary>
 Normalizes Unicode text.
</summary>
</member>
<member name="F:Detextive.RepairEncodingCommand.Path@">
<summary>
 A mis-encoded file to fix.
</summary>
</member>
<member name="F:Detextive.RepairEncodingCommand.InputObject@">
<summary>
 The string containing encoding failures to fix.
</summary>
</member>
<member name="P:Detextive.RepairEncodingCommand.Path(System.String)">
<summary>
 A mis-encoded file to fix.
</summary>
</member>
<member name="P:Detextive.RepairEncodingCommand.InputObject(System.String)">
<summary>
 The string containing encoding failures to fix.
</summary>
</member>
<member name="P:Detextive.RepairEncodingCommand.Path">
<summary>
 A mis-encoded file to fix.
</summary>
</member>
<member name="P:Detextive.RepairEncodingCommand.InputObject">
<summary>
 The string containing encoding failures to fix.
</summary>
</member>
<member name="M:Detextive.RepairEncodingCommand.ProcessItem(System.String)">
<summary>
 Process an individual item.
</summary>
</member>
<member name="T:Detextive.RepairEncodingCommand">
<summary>
 Re-encodes commonly mis-encoded text.
</summary>
</member>
<member name="F:Detextive.TestUtf8SignatureCommand.Path@">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.TestUtf8SignatureCommand.Path(System.String)">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.TestUtf8SignatureCommand.Path">
<summary>
 A file to test.
</summary>
</member>
<member name="M:Detextive.TestUtf8SignatureCommand.HasUtf8Signature(System.IO.FileStream)">
<summary>
 Returns true if a file starts with EF BB BF.
</summary>
</member>
<member name="T:Detextive.TestUtf8SignatureCommand">
<summary>
 Returns true if a file starts with the optional UTF-8 BOM/signature.
</summary>
</member>
<member name="F:Detextive.AddUtf8SignatureCommand.Path@">
<summary>
 A file to add the utf-8 signature to.
</summary>
</member>
<member name="P:Detextive.AddUtf8SignatureCommand.Path(System.String)">
<summary>
 A file to add the utf-8 signature to.
</summary>
</member>
<member name="P:Detextive.AddUtf8SignatureCommand.Path">
<summary>
 A file to add the utf-8 signature to.
</summary>
</member>
<member name="M:Detextive.AddUtf8SignatureCommand.ProcessItem(System.String)">
<summary>
 Process an individual item.
</summary>
</member>
<member name="M:Detextive.AddUtf8SignatureCommand.AddUtf8Signature(System.String,System.IO.FileStream,System.Byte[])">
<summary>
 Adds the UTF-8 signature (BOM)
</summary>
</member>
<member name="T:Detextive.AddUtf8SignatureCommand">
<summary>
 Adds the utf-8 signature (BOM) to a file.
</summary>
</member>
<member name="F:Detextive.RemoveUtf8SignatureCommand.Path@">
<summary>
 A file to remove the utf-8 signature from.
</summary>
</member>
<member name="P:Detextive.RemoveUtf8SignatureCommand.Path(System.String)">
<summary>
 A file to remove the utf-8 signature from.
</summary>
</member>
<member name="P:Detextive.RemoveUtf8SignatureCommand.Path">
<summary>
 A file to remove the utf-8 signature from.
</summary>
</member>
<member name="M:Detextive.RemoveUtf8SignatureCommand.ProcessItem(System.String)">
<summary>
 Process an individual item.
</summary>
</member>
<member name="T:Detextive.RemoveUtf8SignatureCommand">
<summary>
 Removes the utf-8 signature (BOM) from a file.
</summary>
</member>
<member name="F:Detextive.TestUtf8EncodingCommand.Path@">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.TestUtf8EncodingCommand.Path(System.String)">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.TestUtf8EncodingCommand.Path">
<summary>
 A file to test.
</summary>
</member>
<member name="M:Detextive.TestUtf8EncodingCommand.IsUtf8Readable(System.Management.Automation.PSCmdlet,System.IO.FileStream)">
<summary>
 Returns true if a file is parseable as UTF-8.
</summary>
</member>
<member name="T:Detextive.TestUtf8EncodingCommand">
<summary>
 Returns true if a file is parseable as UTF-8.
</summary>
</member>
<member name="F:Detextive.TestBrokenEncodingCommand.Path@">
<summary>
 A file to test.
</summary>
</member>
<member name="F:Detextive.TestBrokenEncodingCommand.InputObject@">
<summary>
 A string to test.
</summary>
</member>
<member name="P:Detextive.TestBrokenEncodingCommand.Path(System.String)">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.TestBrokenEncodingCommand.InputObject(System.String)">
<summary>
 A string to test.
</summary>
</member>
<member name="P:Detextive.TestBrokenEncodingCommand.Path">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.TestBrokenEncodingCommand.InputObject">
<summary>
 A string to test.
</summary>
</member>
<member name="M:Detextive.TestBrokenEncodingCommand.ProcessItem(System.String)">
<summary>
 Process an individual item.
</summary>
</member>
<member name="M:Detextive.TestBrokenEncodingCommand.HasBrokenEncodingSequence(System.String)">
<summary>
 True for a range of byte values more likely to be used by Windows-1252.
</summary>
</member>
<member name="T:Detextive.TestBrokenEncodingCommand">
<summary>
 Returns true if text contains a nonsense sequence of characters resulting from parsing text with the wrong encoding.
</summary>
</member>
<member name="F:Detextive.GetFileEncodingCommand.Path@">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.GetFileEncodingCommand.Path(System.String)">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.GetFileEncodingCommand.Path">
<summary>
 A file to test.
</summary>
</member>
<member name="M:Detextive.GetFileEncodingCommand.TryEncodingParse(System.Text.Encoding,System.Byte[])">
<summary>
 Attempt parsing bytes using encoding, returned encoding option indicates success.
</summary>
</member>
<member name="M:Detextive.GetFileEncodingCommand.DetectFileEncoding(System.IO.FileStream)">
<summary>
 Returns the detected encoding of a file.
</summary>
</member>
<member name="M:Detextive.GetFileEncodingCommand.ByteFrequencyEncodingAnalysis(System.Byte[])">
<summary>
 Judge the encoding based on counts of byte values.
</summary>
</member>
<member name="T:Detextive.GetFileEncodingCommand">
<summary>
 Returns the detected encoding of a file.
</summary>
</member>
<member name="F:Detextive.TestFinalNewlineCommand.Strict@">
<summary>
 Indicates that only a trailing newline is recognized, no other line endings.
</summary>
</member>
<member name="F:Detextive.TestFinalNewlineCommand.Path@">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.TestFinalNewlineCommand.Strict(System.Management.Automation.SwitchParameter)">
<summary>
 Indicates that only a trailing newline is recognized, no other line endings.
</summary>
</member>
<member name="P:Detextive.TestFinalNewlineCommand.Path(System.String)">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.TestFinalNewlineCommand.Strict">
<summary>
 Indicates that only a trailing newline is recognized, no other line endings.
</summary>
</member>
<member name="P:Detextive.TestFinalNewlineCommand.Path">
<summary>
 A file to test.
</summary>
</member>
<member name="M:Detextive.TestFinalNewlineCommand.HasFinalNewline(System.IO.FileStream,System.Boolean)">
<summary>
 Returns true if a file ends with a newline character.
</summary>
</member>
<member name="T:Detextive.TestFinalNewlineCommand">
<summary>
 Returns true if a file ends with a newline as required by the POSIX standard for text files.
</summary>
</member>
<member name="F:Detextive.TestTextFileCommand.Path@">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.TestTextFileCommand.Path(System.String)">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.TestTextFileCommand.Path">
<summary>
 A file to test.
</summary>
</member>
<member name="M:Detextive.TestTextFileCommand.IsTextFile(System.IO.FileStream)">
<summary>
 Returns true if a file is determined to contain text.
</summary>
</member>
<member name="M:Detextive.TestTextFileCommand.ByteFrequencyTextAnalysis(System.Byte[])">
<summary>
 Judge the encoding based on counts of byte values.
</summary>
</member>
<member name="T:Detextive.TestTextFileCommand">
<summary>
 Returns true if a file contains text.
</summary>
</member>
<member name="F:Detextive.TestBinaryFileCommand.Path@">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.TestBinaryFileCommand.Path(System.String)">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.TestBinaryFileCommand.Path">
<summary>
 A file to test.
</summary>
</member>
<member name="T:Detextive.TestBinaryFileCommand">
<summary>
 Returns true if a file does not appear to contain parseable text, and presumably contains binary data.
</summary>
</member>
<member name="F:Detextive.GetFileIndentsCommand.Path@">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.GetFileIndentsCommand.Path(System.String)">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.GetFileIndentsCommand.VerbatimStrings">
<summary>
 C# and F# support verbatim strings that may be multiline and shouldn&apos;t count in code indentation.
</summary>
</member>
<member name="P:Detextive.GetFileIndentsCommand.TripleQuotedStrings">
<summary>
 F# and Python allow triple-quoted multiline strings that shouldn&apos;t count in code indentation.
</summary>
</member>
<member name="P:Detextive.GetFileIndentsCommand.PowerShellHereStrings">
<summary>
 PowerShell here-strings are multiline strings that shouldn&apos;t count in code indendation.
</summary>
</member>
<member name="P:Detextive.GetFileIndentsCommand.Path">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.GetFileIndentsCommand.IndentPattern">
<summary>
 The regular expression for matching indents.
</summary>
</member>
<member name="M:Detextive.GetFileIndentsCommand.SplitIntoLines(System.String)">
<summary>
 Splits a string into lines, using any supported line endings, and ignoring empty lines.
</summary>
</member>
<member name="M:Detextive.GetFileIndentsCommand.ProcessItem(System.String)">
<summary>
 Process an individual item.
</summary>
</member>
<member name="M:Detextive.GetFileIndentsCommand.LineToIndent(System.String)">
<summary>
 Converts a line of text to an Indent enum.
</summary>
</member>
<member name="M:Detextive.GetFileIndentsCommand.DetectIndents(System.Management.Automation.PSCmdlet,System.String,System.IO.FileStream)">
<summary>
 Returns the indent details detected.
</summary>
</member>
<member name="M:Detextive.GetFileIndentsCommand.CountIndents(System.IO.FileStream)">
<summary>
 Counts the indent characters.
</summary>
</member>
<member name="T:Detextive.GetFileIndentsCommand">
<summary>
 Returns details about a file&apos;s indentation characters.
</summary>
</member>
<member name="T:Detextive.IndentsResult">
<summary>
 The details returned by the Get-FileIndents cmdlet.
</summary>
</member>
<member name="T:Detextive.IndentType">
<summary>
 End of line digraph or character.
</summary>
</member>
<member name="F:Detextive.GetFileLineEndingsCommand.Path@">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.GetFileLineEndingsCommand.Path(System.String)">
<summary>
 A file to test.
</summary>
</member>
<member name="P:Detextive.GetFileLineEndingsCommand.Path">
<summary>
 A file to test.
</summary>
</member>
<member name="M:Detextive.GetFileLineEndingsCommand.ProcessItem(System.String)">
<summary>
 Process an individual item.
</summary>
</member>
<member name="M:Detextive.GetFileLineEndingsCommand.DetectLineEndings(System.Management.Automation.PSCmdlet,System.String,System.IO.FileStream)">
<summary>
 Returns the line ending details detected.
</summary>
</member>
<member name="M:Detextive.GetFileLineEndingsCommand.CountLineEndings(System.IO.FileStream)">
<summary>
 Counts the line ending digraph or characters.
</summary>
</member>
<member name="T:Detextive.GetFileLineEndingsCommand">
<summary>
 Returns details about a file&apos;s line endings.
</summary>
</member>
<member name="T:Detextive.LineEndingsResult">
<summary>
 The details returned by the Get-FileLineEndings cmdlet.
</summary>
</member>
<member name="T:Detextive.LineEndingType">
<summary>
 End of line digraph or character.
</summary>
</member>
<member name="F:Detextive.GetFileContentsInfoCommand.Path@">
<summary>
 A file to examine.
</summary>
</member>
<member name="P:Detextive.GetFileContentsInfoCommand.Path(System.String)">
<summary>
 A file to examine.
</summary>
</member>
<member name="P:Detextive.GetFileContentsInfoCommand.Path">
<summary>
 A file to examine.
</summary>
</member>
<member name="M:Detextive.GetFileContentsInfoCommand.GetFileContentsInfo(System.Management.Automation.PSCmdlet,System.String)">
<summary>
 Process an individual item.
</summary>
</member>
<member name="T:Detextive.GetFileContentsInfoCommand">
<summary>
 Returns whether the file is binary or text, and what encoding, line endings, and indents text files contain.
</summary>
</member>
<member name="T:Detextive.TextContentsResult">
<summary>
 The details returned by the Get-FileContentsInfo cmdlet.
</summary>
</member>
<member name="F:Detextive.GetFileEditorConfigCommand.Path@">
<summary>
 A file to retrieve the editorconfig values for.
</summary>
</member>
<member name="P:Detextive.GetFileEditorConfigCommand.Path(System.String)">
<summary>
 A file to retrieve the editorconfig values for.
</summary>
</member>
<member name="P:Detextive.GetFileEditorConfigCommand.Path">
<summary>
 A file to retrieve the editorconfig values for.
</summary>
</member>
<member name="M:Detextive.GetFileEditorConfigCommand.GetFileEditorConfig(System.Management.Automation.PSCmdlet,System.String,EditorConfig.Core.FileConfiguration)">
<summary>
 Process an individual item.
</summary>
</member>
<member name="T:Detextive.GetFileEditorConfigCommand">
<summary>
 Looks up the editorconfig values set for a file.
</summary>
</member>
<member name="T:Detextive.FileEditorConfigResult">
<summary>
 The details returned by the Get-FileEditorConfig cmdlet.
</summary>
</member>
<member name="F:Detextive.TestFileEditorConfigCommand.Path@">
<summary>
 A file to test the editorconfig values for.
</summary>
</member>
<member name="P:Detextive.TestFileEditorConfigCommand.Path(System.String)">
<summary>
 A file to test the editorconfig values for.
</summary>
</member>
<member name="P:Detextive.TestFileEditorConfigCommand.Path">
<summary>
 A file to test the editorconfig values for.
</summary>
</member>
<member name="M:Detextive.TestFileEditorConfigCommand.ProcessItem(System.String,EditorConfig.Core.FileConfiguration)">
<summary>
 Process an individual item.
</summary>
</member>
<member name="T:Detextive.TestFileEditorConfigCommand">
<summary>
 Validates a file&apos;s editorconfig settings against the actual formatting found.
</summary>
</member>
<member name="F:Detextive.RepairFileEditorConfigCommand.Path@">
<summary>
 A file to fix the editorconfig values for.
</summary>
</member>
<member name="P:Detextive.RepairFileEditorConfigCommand.Path(System.String)">
<summary>
 A file to fix the editorconfig values for.
</summary>
</member>
<member name="P:Detextive.RepairFileEditorConfigCommand.Path">
<summary>
 A file to fix the editorconfig values for.
</summary>
</member>
<member name="M:Detextive.RepairFileEditorConfigCommand.ProcessItem(System.String,EditorConfig.Core.FileConfiguration)">
<summary>
 Process an individual item.
</summary>
</member>
<member name="T:Detextive.RepairFileEditorConfigCommand">
<summary>
 Corrects a file&apos;s editorconfig settings when they differ from the actual formatting found.
</summary>
</member>
<member name="P:Detextive.Ratio.MinFourByteZeros">
<summary>
 The minimum ratio of zeros in UTF-32LE or UTF-32BE encoding,
 assuming a preponderance of ASCII-range chars in the data.
</summary>
</member>
<member name="P:Detextive.Ratio.MinDoubleByteZeros">
<summary>
 The minimum ratio of zeros in UTF-16LE or UTF-16BE encoding,
 assuming a preponderance of ASCII-range chars in the data.
</summary>
</member>
<member name="P:Detextive.Ratio.MinCommonEbcdic">
<summary>
 The minimum ratio of common EBCDIC character byte values (space, tab)
 or unlikely non-EBCDIC value (7F is quote, but delete in most other encodings)
 in a probably EBCDIC file.
</summary>
</member>
<member name="P:Detextive.Ratio.MinBinaryLowControls">
<summary>
 The minimum ratio of low control char byte values in a probably binary file,
 assuming Benford&apos;s Law applies to some degree.
</summary>
</member>
<member name="T:Detextive.Ratio">
<summary>
 Constants used for ratios in byte value data analysis.
</summary>
</member>
<member name="M:Detextive.Collection.toSeq``1(System.Collections.ObjectModel.Collection{``0})">
<summary>
 Converts a collection into a sequence.
</summary>
</member>
<member name="M:Detextive.Collection.toList``1(System.Collections.ObjectModel.Collection{``0})">
<summary>
 Converts a collection into a sequence.
</summary>
</member>
<member name="T:Detextive.Collection">
<summary>
 Functions for working with collections.
</summary>
</member>
<member name="M:Detextive.FilePosition.GetBufferSize(System.IO.FileStream)">
<summary>
 Returns a buffer size based on the file size.
</summary>
</member>
<member name="M:Detextive.FilePosition.Rewind(System.IO.FileStream)">
<summary>
 Seeks the current position to the beginning of the file.
</summary>
</member>
<member name="P:Detextive.FilePosition.MaxBufferSize">
<summary>
 The maximum buffer size to use when reading files.
</summary>
</member>
</members>
</doc>