From 0e5d128c561a736d0ba62d23c1ce3a83d55bdcda Mon Sep 17 00:00:00 2001 From: Jeffrey Stedfast Date: Sat, 11 Jan 2025 11:36:42 -0500 Subject: [PATCH] Use instead of x * Use instead of null * Use instead of true * Use instead of false --- MimeKit/AttachmentCollection.cs | 14 +++---- MimeKit/ContentDisposition.cs | 24 +++++------ MimeKit/ContentType.cs | 24 +++++------ MimeKit/Cryptography/AuthenticationResults.cs | 6 +-- .../BouncyCastleCertificateExtensions.cs | 8 ++-- .../BouncyCastleSecureMimeContext.cs | 6 +-- .../Cryptography/CmsRecipientCollection.cs | 8 ++-- MimeKit/Cryptography/CryptographyContext.cs | 22 +++++----- .../Cryptography/DefaultSecureMimeContext.cs | 20 ++++----- MimeKit/Cryptography/DkimHashStream.cs | 12 +++--- MimeKit/Cryptography/DkimRelaxedBodyFilter.cs | 2 +- MimeKit/Cryptography/DkimSignatureStream.cs | 14 +++---- MimeKit/Cryptography/DkimSimpleBodyFilter.cs | 2 +- MimeKit/Cryptography/DkimVerifier.cs | 8 ++-- MimeKit/Cryptography/DkimVerifierBase.cs | 6 +-- MimeKit/Cryptography/GnuPGContext.cs | 8 ++-- MimeKit/Cryptography/ICryptographyContext.cs | 16 +++---- MimeKit/Cryptography/IDigitalSignature.cs | 6 +-- .../Cryptography/IX509CertificateDatabase.cs | 4 +- MimeKit/Cryptography/OpenPgpBlockFilter.cs | 2 +- MimeKit/Cryptography/OpenPgpContext.cs | 24 +++++------ .../Cryptography/OpenPgpDetectionFilter.cs | 2 +- .../Cryptography/OpenPgpDigitalSignature.cs | 4 +- MimeKit/Cryptography/RsaEncryptionPadding.cs | 10 ++--- MimeKit/Cryptography/RsaSignaturePadding.cs | 10 ++--- MimeKit/Cryptography/SecureMimeContext.cs | 2 +- .../SecureMimeDigitalSignature.cs | 6 +-- .../Cryptography/SqlCertificateDatabase.cs | 8 ++-- .../TemporarySecureMimeContext.cs | 4 +- .../Cryptography/WindowsSecureMimeContext.cs | 6 +-- .../WindowsSecureMimeDigitalSignature.cs | 6 +-- .../X509Certificate2Extensions.cs | 2 +- MimeKit/Cryptography/X509CertificateChain.cs | 8 ++-- .../Cryptography/X509CertificateDatabase.cs | 14 +++---- MimeKit/Cryptography/X509CertificateRecord.cs | 4 +- MimeKit/Cryptography/X509CrlRecord.cs | 2 +- MimeKit/DomainList.cs | 16 +++---- MimeKit/Encodings/Base64Encoder.cs | 2 +- MimeKit/Encodings/QuotedPrintableDecoder.cs | 2 +- MimeKit/Encodings/UUDecoder.cs | 2 +- MimeKit/Encodings/YDecoder.cs | 2 +- MimeKit/ExperimentalMimeParser.cs | 24 +++++------ MimeKit/FormatOptions.cs | 10 ++--- MimeKit/GroupAddress.cs | 24 +++++------ MimeKit/Header.cs | 22 +++++----- MimeKit/HeaderList.cs | 26 ++++++------ MimeKit/HeaderListCollection.cs | 10 ++--- MimeKit/IMimeEntity.cs | 20 ++++----- MimeKit/IMimeMessage.cs | 8 ++-- MimeKit/IMimeParser.cs | 12 +++--- MimeKit/IMimePart.cs | 4 +- MimeKit/IMultipartRelated.cs | 2 +- MimeKit/IO/BoundStream.cs | 22 +++++----- MimeKit/IO/ChainedStream.cs | 16 +++---- MimeKit/IO/FilteredStream.cs | 18 ++++---- MimeKit/IO/Filters/ArmoredFromFilter.cs | 2 +- MimeKit/IO/Filters/CharsetFilter.cs | 2 +- MimeKit/IO/Filters/DecoderFilter.cs | 2 +- MimeKit/IO/Filters/Dos2UnixFilter.cs | 2 +- MimeKit/IO/Filters/EncoderFilter.cs | 2 +- MimeKit/IO/Filters/MboxFromFilter.cs | 2 +- MimeKit/IO/Filters/MimeFilterBase.cs | 4 +- .../IO/Filters/TrailingWhitespaceFilter.cs | 2 +- MimeKit/IO/Filters/Unix2DosFilter.cs | 2 +- MimeKit/IO/MeasuringStream.cs | 12 +++--- MimeKit/IO/MemoryBlockStream.cs | 12 +++--- MimeKit/ITextPart.cs | 12 +++--- MimeKit/InternetAddress.cs | 34 +++++++-------- MimeKit/InternetAddressList.cs | 38 ++++++++--------- MimeKit/MailboxAddress.cs | 30 ++++++------- MimeKit/MessageIdList.cs | 10 ++--- MimeKit/MessagePart.cs | 8 ++-- MimeKit/MimeContent.cs | 4 +- MimeKit/MimeEntity.cs | 42 +++++++++---------- MimeKit/MimeIterator.cs | 8 ++-- MimeKit/MimeMessage.cs | 30 ++++++------- MimeKit/MimeParser.cs | 36 ++++++++-------- MimeKit/MimePart.cs | 12 +++--- MimeKit/MimeReader.cs | 4 +- MimeKit/MimeTypes.cs | 2 +- MimeKit/Multipart.cs | 22 +++++----- MimeKit/MultipartAlternative.cs | 2 +- MimeKit/MultipartRelated.cs | 4 +- MimeKit/Parameter.cs | 2 +- MimeKit/ParameterList.cs | 22 +++++----- MimeKit/ParserOptions.cs | 12 +++--- MimeKit/Text/FlowedToHtml.cs | 8 ++-- MimeKit/Text/FlowedToText.cs | 6 +-- MimeKit/Text/HtmlAttributeCollection.cs | 12 +++--- MimeKit/Text/HtmlEntityDecoder.cs | 2 +- MimeKit/Text/HtmlTagContext.cs | 14 +++---- MimeKit/Text/HtmlTagId.cs | 4 +- MimeKit/Text/HtmlToHtml.cs | 8 ++-- MimeKit/Text/HtmlToken.cs | 14 +++---- MimeKit/Text/HtmlTokenizer.cs | 16 +++---- MimeKit/Text/HtmlWriter.cs | 4 +- MimeKit/Text/TextConverter.cs | 2 +- MimeKit/Text/TextToHtml.cs | 2 +- MimeKit/Text/Trie.cs | 2 +- MimeKit/TextPart.cs | 14 +++---- MimeKit/Tnef/RtfCompressedToRtf.cs | 6 +-- MimeKit/Tnef/TnefNameId.cs | 12 +++--- MimeKit/Tnef/TnefPropertyReader.cs | 22 +++++----- MimeKit/Tnef/TnefPropertyTag.cs | 14 +++---- MimeKit/Tnef/TnefReader.cs | 6 +-- MimeKit/Tnef/TnefReaderStream.cs | 10 ++--- MimeKit/Utils/BufferPool.cs | 2 +- MimeKit/Utils/DateUtils.cs | 8 ++-- MimeKit/Utils/MimeUtils.cs | 8 ++-- MimeKit/Utils/OptimizedOrdinalComparer.cs | 4 +- 110 files changed, 572 insertions(+), 572 deletions(-) diff --git a/MimeKit/AttachmentCollection.cs b/MimeKit/AttachmentCollection.cs index 31ea3e1a04..2c1b04ad6c 100644 --- a/MimeKit/AttachmentCollection.cs +++ b/MimeKit/AttachmentCollection.cs @@ -57,10 +57,10 @@ public class AttachmentCollection : IList /// /// /// Creates a new . - /// If is true, then the attachments + /// If is , then the attachments /// are treated as if they are linked to another . /// - /// If set to true; the attachments are treated as linked resources. + /// If set to ; the attachments are treated as linked resources. public AttachmentCollection (bool linkedResources) { attachments = new List (); @@ -96,7 +96,7 @@ public int Count { /// /// A is never read-only. /// - /// true if the collection is read only; otherwise, false. + /// if the collection is read only; otherwise, . public bool IsReadOnly { get { return false; } } @@ -848,7 +848,7 @@ public void Clear () /// /// Removes all attachments from the collection, optionally disposing them in the process. /// - /// true if all the attachments should be disposed; otherwise, false. + /// if all the attachments should be disposed; otherwise, . public void Clear (bool dispose) { if (dispose) { @@ -865,8 +865,8 @@ public void Clear (bool dispose) /// /// Determines whether the collection contains the specified attachment. /// - /// true if the specified attachment exists; - /// otherwise false. + /// if the specified attachment exists; + /// otherwise, . /// The attachment. /// /// is . @@ -955,7 +955,7 @@ public void Insert (int index, MimeEntity attachment) /// /// Removes the specified attachment. /// - /// true if the attachment was removed; otherwise false. + /// if the attachment was removed; otherwise, . /// The attachment. /// /// is . diff --git a/MimeKit/ContentDisposition.cs b/MimeKit/ContentDisposition.cs index e6f8ce0110..8f4b427eea 100644 --- a/MimeKit/ContentDisposition.cs +++ b/MimeKit/ContentDisposition.cs @@ -145,7 +145,7 @@ public string Disposition { /// /// A convenience property to determine if the entity should be considered an attachment or not. /// - /// true if the is an attachment; otherwise, false. + /// if the is an attachment; otherwise, . public bool IsAttachment { get { return disposition.Equals (Attachment, StringComparison.OrdinalIgnoreCase); } set { disposition = value ? Attachment : Inline; } @@ -356,7 +356,7 @@ internal string Encode (FormatOptions options, Encoding charset) /// The serialized string. /// The formatting options. /// The charset to be used when encoding the parameter values. - /// If set to true, the parameter values will be encoded. + /// If set to , the parameter values will be encoded. /// /// is . /// -or- @@ -394,7 +394,7 @@ public string ToString (FormatOptions options, Encoding charset, bool encode) /// /// The serialized string. /// The charset to be used when encoding the parameter values. - /// If set to true, the parameter values will be encoded. + /// If set to , the parameter values will be encoded. /// /// is . /// @@ -411,7 +411,7 @@ public string ToString (Encoding charset, bool encode) /// optionally encoding the parameters as they would be encoded for transport. /// /// The serialized string. - /// If set to true, the parameter values will be encoded. + /// If set to , the parameter values will be encoded. public string ToString (bool encode) { return ToString (FormatOptions.Default, Encoding.UTF8, encode); @@ -532,7 +532,7 @@ internal static bool TryParse (ParserOptions options, byte[] text, ref int index /// Parses a Content-Disposition value from the supplied buffer starting at the given index /// and spanning across the specified number of bytes. /// - /// true if the disposition was successfully parsed; otherwise, false. + /// if the disposition was successfully parsed; otherwise, . /// The parser options. /// The input buffer. /// The starting index of the input buffer. @@ -563,7 +563,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde /// Parses a Content-Disposition value from the supplied buffer starting at the given index /// and spanning across the specified number of bytes. /// - /// true if the disposition was successfully parsed; otherwise, false. + /// if the disposition was successfully parsed; otherwise, . /// The input buffer. /// The starting index of the input buffer. /// The number of bytes in the input buffer to parse. @@ -586,7 +586,7 @@ public static bool TryParse (byte[] buffer, int startIndex, int length, out Cont /// /// Parses a Content-Disposition value from the supplied buffer starting at the specified index. /// - /// true if the disposition was successfully parsed; otherwise, false. + /// if the disposition was successfully parsed; otherwise, . /// The parser options. /// The input buffer. /// The starting index of the input buffer. @@ -614,7 +614,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde /// /// Parses a Content-Disposition value from the supplied buffer starting at the specified index. /// - /// true if the disposition was successfully parsed; otherwise, false. + /// if the disposition was successfully parsed; otherwise, . /// The input buffer. /// The starting index of the input buffer. /// The parsed disposition. @@ -635,7 +635,7 @@ public static bool TryParse (byte[] buffer, int startIndex, out ContentDispositi /// /// Parses a Content-Disposition value from the specified buffer. /// - /// true if the disposition was successfully parsed; otherwise, false. + /// if the disposition was successfully parsed; otherwise, . /// The parser options. /// The input buffer. /// The parsed disposition. @@ -659,7 +659,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, out ContentDi /// /// Parses a Content-Disposition value from the specified buffer. /// - /// true if the disposition was successfully parsed; otherwise, false. + /// if the disposition was successfully parsed; otherwise, . /// The input buffer. /// The parsed disposition. /// @@ -676,7 +676,7 @@ public static bool TryParse (byte[] buffer, out ContentDisposition disposition) /// /// Parses a Content-Disposition value from the supplied text. /// - /// true if the disposition was successfully parsed; otherwise, false. + /// if the disposition was successfully parsed; otherwise, . /// The parser options. /// The text to parse. /// The parsed disposition. @@ -701,7 +701,7 @@ public static bool TryParse (ParserOptions options, string text, out ContentDisp /// /// Parses a Content-Disposition value from the supplied text. /// - /// true if the disposition was successfully parsed; otherwise, false. + /// if the disposition was successfully parsed; otherwise, . /// The text to parse. /// The parsed disposition. /// diff --git a/MimeKit/ContentType.cs b/MimeKit/ContentType.cs index c34d7476c5..9e9364af8d 100644 --- a/MimeKit/ContentType.cs +++ b/MimeKit/ContentType.cs @@ -280,7 +280,7 @@ public ContentType Clone () /// If the specified or /// are "*", they match anything. /// - /// true if the matches the + /// if the matches the /// provided media type and subtype. /// The media type. /// The media subtype. @@ -331,7 +331,7 @@ internal string Encode (FormatOptions options, Encoding charset) /// The serialized string. /// The formatting options. /// The charset to be used when encoding the parameter values. - /// If set to true, the parameter values will be encoded. + /// If set to , the parameter values will be encoded. /// /// is . /// -or- @@ -371,7 +371,7 @@ public string ToString (FormatOptions options, Encoding charset, bool encode) /// /// The serialized string. /// The charset to be used when encoding the parameter values. - /// If set to true, the parameter values will be encoded. + /// If set to , the parameter values will be encoded. /// /// is . /// @@ -388,7 +388,7 @@ public string ToString (Encoding charset, bool encode) /// the parameters as they would be encoded for transport. /// /// The serialized string. - /// If set to true, the parameter values will be encoded. + /// If set to , the parameter values will be encoded. public string ToString (bool encode) { return ToString (FormatOptions.Default, Encoding.UTF8, encode); @@ -523,7 +523,7 @@ internal static bool TryParse (ParserOptions options, byte[] text, ref int index /// Parses a Content-Type value from the supplied buffer starting at the given index /// and spanning across the specified number of bytes. /// - /// true if the content type was successfully parsed; otherwise, false. + /// if the content type was successfully parsed; otherwise, . /// The parser options. /// The input buffer. /// The starting index of the input buffer. @@ -554,7 +554,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde /// Parses a Content-Type value from the supplied buffer starting at the given index /// and spanning across the specified number of bytes. /// - /// true if the content type was successfully parsed; otherwise, false. + /// if the content type was successfully parsed; otherwise, . /// The input buffer. /// The starting index of the input buffer. /// The number of bytes in the input buffer to parse. @@ -577,7 +577,7 @@ public static bool TryParse (byte[] buffer, int startIndex, int length, out Cont /// /// Parses a Content-Type value from the supplied buffer starting at the specified index. /// - /// true if the content type was successfully parsed; otherwise, false. + /// if the content type was successfully parsed; otherwise, . /// The parser options. /// The input buffer. /// The starting index of the input buffer. @@ -605,7 +605,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde /// /// Parses a Content-Type value from the supplied buffer starting at the specified index. /// - /// true if the content type was successfully parsed; otherwise, false. + /// if the content type was successfully parsed; otherwise, . /// The input buffer. /// The starting index of the input buffer. /// The parsed content type. @@ -626,7 +626,7 @@ public static bool TryParse (byte[] buffer, int startIndex, out ContentType type /// /// Parses a Content-Type value from the specified buffer. /// - /// true if the content type was successfully parsed; otherwise, false. + /// if the content type was successfully parsed; otherwise, . /// The parser options. /// The input buffer. /// The parsed content type. @@ -650,7 +650,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, out ContentTy /// /// Parses a Content-Type value from the specified buffer. /// - /// true if the content type was successfully parsed; otherwise, false. + /// if the content type was successfully parsed; otherwise, . /// The input buffer. /// The parsed content type. /// @@ -667,7 +667,7 @@ public static bool TryParse (byte[] buffer, out ContentType type) /// /// Parses a Content-Type value from the specified text. /// - /// true if the content type was successfully parsed; otherwise, false. + /// if the content type was successfully parsed; otherwise, . /// The parser options. /// The text to parse. /// The parsed content type. @@ -692,7 +692,7 @@ public static bool TryParse (ParserOptions options, string text, out ContentType /// /// Parses a Content-Type value from the specified text. /// - /// true if the content type was successfully parsed; otherwise, false. + /// if the content type was successfully parsed; otherwise, . /// The text to parse. /// The parsed content type. /// diff --git a/MimeKit/Cryptography/AuthenticationResults.cs b/MimeKit/Cryptography/AuthenticationResults.cs index 6912593725..edfd2511d9 100644 --- a/MimeKit/Cryptography/AuthenticationResults.cs +++ b/MimeKit/Cryptography/AuthenticationResults.cs @@ -816,7 +816,7 @@ static bool TryParse (byte[] text, ref int index, int endIndex, bool throwOnErro /// Parses an Authentication-Results header value from the supplied buffer starting at the given index /// and spanning across the specified number of bytes. /// - /// true if the authentication results were successfully parsed; otherwise, false. + /// if the authentication results were successfully parsed; otherwise, . /// The input buffer. /// The starting index of the input buffer. /// The number of bytes in the input buffer to parse. @@ -843,7 +843,7 @@ public static bool TryParse (byte[] buffer, int startIndex, int length, out Auth /// /// Parses an Authentication-Results header value from the supplied buffer. /// - /// true if the authentication results were successfully parsed; otherwise, false. + /// if the authentication results were successfully parsed; otherwise, . /// The input buffer. /// The parsed authentication results. /// @@ -1228,7 +1228,7 @@ public class AuthenticationMethodProperty /// The property type. /// The name of the property. /// The value of the property. - /// true if the property value was originally quoted; otherwise, false. + /// if the property value was originally quoted; otherwise, . /// /// is . /// -or- diff --git a/MimeKit/Cryptography/BouncyCastleCertificateExtensions.cs b/MimeKit/Cryptography/BouncyCastleCertificateExtensions.cs index 1ada5670d0..e1eff4f759 100644 --- a/MimeKit/Cryptography/BouncyCastleCertificateExtensions.cs +++ b/MimeKit/Cryptography/BouncyCastleCertificateExtensions.cs @@ -74,7 +74,7 @@ public static X509Certificate2 AsX509Certificate2 (this X509Certificate certific /// A certificate is considered self-signed if the subject and issuer names are the same. /// /// The certificate to check. - /// true if the certificate is self-signed; otherwise, false. + /// if the certificate is self-signed; otherwise, . public static bool IsSelfSigned (this X509Certificate certificate) { return certificate.SubjectDN.Equivalent (certificate.IssuerDN); @@ -196,7 +196,7 @@ static string[] GetSubjectAlternativeNames (X509Certificate certificate, int tag /// /// The subject email address. /// The certificate. - /// If set to true, international edomain names will be IDN encoded. + /// If set to , international edomain names will be IDN encoded. /// /// is . /// @@ -230,7 +230,7 @@ public static string GetSubjectEmailAddress (this X509Certificate certificate, b /// /// The subject DNS names. /// The certificate. - /// If set to true, international domain names will be IDN encoded. + /// If set to , international domain names will be IDN encoded. /// /// is . /// @@ -442,7 +442,7 @@ public static EncryptionAlgorithm[] GetEncryptionAlgorithms (this X509Certificat /// The X.509 delta CRL indicator extension must be marked critical to be found. /// /// The X.509 CRL to check. - /// true if the specified CRL is a delta CRL; otherwise, false. + /// if the specified CRL is a delta CRL; otherwise, . public static bool IsDelta (this X509Crl crl) { var critical = crl.GetCriticalExtensionOids (); diff --git a/MimeKit/Cryptography/BouncyCastleSecureMimeContext.cs b/MimeKit/Cryptography/BouncyCastleSecureMimeContext.cs index a7836de1f4..4905d68b39 100644 --- a/MimeKit/Cryptography/BouncyCastleSecureMimeContext.cs +++ b/MimeKit/Cryptography/BouncyCastleSecureMimeContext.cs @@ -124,7 +124,7 @@ protected SecureRandom RandomNumberGenerator { /// attacker-controlled server, thereby getting a notification when the user decrypts the message or verifies /// its digital signature. /// - /// true if CRLs should be downloaded automatically; otherwise, false. + /// if CRLs should be downloaded automatically; otherwise, . public bool CheckCertificateRevocation { get; set; } @@ -774,7 +774,7 @@ PkixCertPath BuildCertPath (ISet anchors, IStore c /// Attempts to map a /// to a . /// - /// true if the algorithm identifier was successfully mapped; otherwise, false. + /// if the algorithm identifier was successfully mapped; otherwise, . /// The algorithm identifier. /// The encryption algorithm. /// @@ -796,7 +796,7 @@ internal protected static bool TryGetDigestAlgorithm (AlgorithmIdentifier identi /// Attempts to map a /// to a . /// - /// true if the algorithm identifier was successfully mapped; otherwise, false. + /// if the algorithm identifier was successfully mapped; otherwise, . /// The algorithm identifier. /// The encryption algorithm. /// diff --git a/MimeKit/Cryptography/CmsRecipientCollection.cs b/MimeKit/Cryptography/CmsRecipientCollection.cs index e0005e7ccd..a9b628315b 100644 --- a/MimeKit/Cryptography/CmsRecipientCollection.cs +++ b/MimeKit/Cryptography/CmsRecipientCollection.cs @@ -72,7 +72,7 @@ public int Count { /// /// A is never read-only. /// - /// true if this instance is read only; otherwise, false. + /// if this instance is read only; otherwise, . public bool IsReadOnly { get { return false; } } @@ -112,8 +112,8 @@ public void Clear () /// /// Determines whether the collection contains the specified recipient. /// - /// true if the specified recipient exists; - /// otherwise false. + /// if the specified recipient exists; + /// otherwise, . /// The recipient. /// /// is . @@ -158,7 +158,7 @@ public void CopyTo (CmsRecipient[] array, int arrayIndex) /// /// Removes the specified recipient. /// - /// true if the recipient was removed; otherwise false. + /// if the recipient was removed; otherwise, . /// The recipient. /// /// is . diff --git a/MimeKit/Cryptography/CryptographyContext.cs b/MimeKit/Cryptography/CryptographyContext.cs index e0701c7cef..a957b60cef 100644 --- a/MimeKit/Cryptography/CryptographyContext.cs +++ b/MimeKit/Cryptography/CryptographyContext.cs @@ -84,7 +84,7 @@ protected CryptographyContext () /// /// Gets or sets whether a should be prepared before signing. /// - /// true if a MimeEntity should be prepared before signing; otherwise, false. + /// if a MimeEntity should be prepared before signing; otherwise, . public bool PrepareBeforeSigning { get; set; } @@ -125,7 +125,7 @@ public bool PrepareBeforeSigning { /// Gets or sets a value indicating whether this allows online /// certificate retrieval. /// - /// true if online certificate retrieval should be allowed; otherwise, false. + /// if online certificate retrieval should be allowed; otherwise, . public bool AllowOnlineCertificateRetrieval { get; set; } /// @@ -205,7 +205,7 @@ public void Disable (EncryptionAlgorithm algorithm) /// /// Determines whether the specified encryption algorithm is enabled. /// - /// true if the specified encryption algorithm is enabled; otherwise, false. + /// if the specified encryption algorithm is enabled; otherwise, . /// The encryption algorithm. public bool IsEnabled (EncryptionAlgorithm algorithm) { @@ -282,7 +282,7 @@ public void Disable (DigestAlgorithm algorithm) /// /// Determines whether the specified digest algorithm is enabled. /// - /// true if the specified digest algorithm is enabled; otherwise, false. + /// if the specified digest algorithm is enabled; otherwise, . /// The digest algorithm. public bool IsEnabled (DigestAlgorithm algorithm) { @@ -296,7 +296,7 @@ public bool IsEnabled (DigestAlgorithm algorithm) /// Used in order to make sure that the protocol parameter value specified in either a multipart/signed /// or multipart/encrypted part is supported by the supplied cryptography context. /// - /// true if the protocol is supported; otherwise false + /// if the protocol is supported; otherwise, /// The protocol. /// /// is . @@ -337,7 +337,7 @@ public bool IsEnabled (DigestAlgorithm algorithm) /// /// Checks whether as particular mailbocx address can be used for signing. /// - /// true if the mailbox address can be used for signing; otherwise, false. + /// if the mailbox address can be used for signing; otherwise, . /// The signer. /// The cancellation token. /// @@ -354,7 +354,7 @@ public bool IsEnabled (DigestAlgorithm algorithm) /// /// Checks whether as particular mailbocx address can be used for signing. /// - /// true if the mailbox address can be used for signing; otherwise, false. + /// if the mailbox address can be used for signing; otherwise, . /// The signer. /// The cancellation token. /// @@ -374,7 +374,7 @@ public virtual Task CanSignAsync (MailboxAddress signer, CancellationToken /// /// Checks whether the cryptography context can be used to encrypt to a particular recipient. /// - /// true if the cryptography context can be used to encrypt to the designated recipient; otherwise, false. + /// if the cryptography context can be used to encrypt to the designated recipient; otherwise, . /// The recipient's mailbox address. /// The cancellation token. /// @@ -391,7 +391,7 @@ public virtual Task CanSignAsync (MailboxAddress signer, CancellationToken /// /// Checks whether the cryptography context can be used to encrypt to a particular recipient. /// - /// true if the cryptography context can be used to encrypt to the designated recipient; otherwise, false. + /// if the cryptography context can be used to encrypt to the designated recipient; otherwise, . /// The recipient's mailbox address. /// The cancellation token. /// @@ -680,8 +680,8 @@ public virtual Task CanEncryptAsync (MailboxAddress mailbox, CancellationT /// Releases the unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected virtual void Dispose (bool disposing) { } diff --git a/MimeKit/Cryptography/DefaultSecureMimeContext.cs b/MimeKit/Cryptography/DefaultSecureMimeContext.cs index caca450c85..3b90e0b855 100644 --- a/MimeKit/Cryptography/DefaultSecureMimeContext.cs +++ b/MimeKit/Cryptography/DefaultSecureMimeContext.cs @@ -316,7 +316,7 @@ public DefaultSecureMimeContext (IX509CertificateDatabase database, SecureRandom /// /// Checks whether as particular mailbocx address can be used for signing. /// - /// true if the mailbox address can be used for signing; otherwise, false. + /// if the mailbox address can be used for signing; otherwise, . /// The signer. /// The cancellation token. /// @@ -346,7 +346,7 @@ public override bool CanSign (MailboxAddress signer, CancellationToken cancellat /// /// Checks whether the cryptography context can be used to encrypt to a particular recipient. /// - /// true if the cryptography context can be used to encrypt to the designated recipient; otherwise, false. + /// if the cryptography context can be used to encrypt to the designated recipient; otherwise, . /// The recipient's mailbox address. /// The cancellation token. /// @@ -836,12 +836,12 @@ public override Task ImportAsync (Stream stream, string password, CancellationTo /// /// /// Imports the certificate. - /// If the certificate already exists in the database and is true, + /// If the certificate already exists in the database and is , /// then the IsTrusted state is updated otherwise the certificate is added to the database with the /// specified trust. /// /// The certificate. - /// true if the certificate is trusted; otherwise, false. + /// if the certificate is trusted; otherwise, . /// The cancellation token. /// /// is . @@ -876,13 +876,13 @@ public void Import (X509Certificate certificate, bool trusted, CancellationToken /// /// /// Asynchronously imports the certificate. - /// If the certificate already exists in the database and is true, + /// If the certificate already exists in the database and is , /// then the IsTrusted state is updated otherwise the certificate is added to the database with the /// specified trust. /// /// An asynchronous task context. /// The certificate. - /// true if the certificate is trusted; otherwise, false. + /// if the certificate is trusted; otherwise, . /// The cancellation token. /// /// is . @@ -904,7 +904,7 @@ public Task ImportAsync (X509Certificate certificate, bool trusted, Cancellation /// Imports the certificate(s). /// /// The raw certificate(s). - /// true if the certificates are trusted; othewrwise, false. + /// if the certificates are trusted; othewrwise, . /// The cancellation token. /// /// is . @@ -933,7 +933,7 @@ public void Import (Stream stream, bool trusted, CancellationToken cancellationT /// /// An asynchronous task context. /// The raw certificate(s). - /// true if the certificates are trusted; othewrwise, false. + /// if the certificates are trusted; othewrwise, . /// The cancellation token. /// /// is . @@ -956,8 +956,8 @@ public Task ImportAsync (Stream stream, bool trusted, CancellationToken cancella /// Releases the unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected override void Dispose (bool disposing) { dbase.Dispose (); diff --git a/MimeKit/Cryptography/DkimHashStream.cs b/MimeKit/Cryptography/DkimHashStream.cs index d94e263086..9b01e1eb51 100644 --- a/MimeKit/Cryptography/DkimHashStream.cs +++ b/MimeKit/Cryptography/DkimHashStream.cs @@ -121,7 +121,7 @@ void CheckDisposed () /// /// A is not readable. /// - /// true if the stream supports reading; otherwise, false. + /// if the stream supports reading; otherwise, . public override bool CanRead { get { return false; } } @@ -132,7 +132,7 @@ public override bool CanRead { /// /// A is always writable. /// - /// true if the stream supports writing; otherwise, false. + /// if the stream supports writing; otherwise, . public override bool CanWrite { get { return true; } } @@ -143,7 +143,7 @@ public override bool CanWrite { /// /// A is not seekable. /// - /// true if the stream supports seeking; otherwise, false. + /// if the stream supports seeking; otherwise, . public override bool CanSeek { get { return false; } } @@ -154,7 +154,7 @@ public override bool CanSeek { /// /// Writing to a cannot timeout. /// - /// true if reading and writing to the stream can time out; otherwise, false. + /// if reading and writing to the stream can time out; otherwise, . public override bool CanTimeout { get { return false; } } @@ -352,8 +352,8 @@ public override void SetLength (long value) /// Releases the unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected override void Dispose (bool disposing) { if (disposing && !disposed) { diff --git a/MimeKit/Cryptography/DkimRelaxedBodyFilter.cs b/MimeKit/Cryptography/DkimRelaxedBodyFilter.cs index d5320e4456..942751e2b0 100644 --- a/MimeKit/Cryptography/DkimRelaxedBodyFilter.cs +++ b/MimeKit/Cryptography/DkimRelaxedBodyFilter.cs @@ -129,7 +129,7 @@ int Filter (ReadOnlySpan input, Span output) /// The length of the input buffer, starting at . /// The output index. /// The output length. - /// If set to true, all internally buffered data should be flushed to the output buffer. + /// If set to , all internally buffered data should be flushed to the output buffer. protected override byte[] Filter (byte[] input, int startIndex, int length, out int outputIndex, out int outputLength, bool flush) { EnsureOutputSize (length + (lwsp ? 1 : 0) + (EmptyLines * 2) + (cr ? 1 : 0) + 1, false); diff --git a/MimeKit/Cryptography/DkimSignatureStream.cs b/MimeKit/Cryptography/DkimSignatureStream.cs index a44c9e49a5..3949de04cd 100644 --- a/MimeKit/Cryptography/DkimSignatureStream.cs +++ b/MimeKit/Cryptography/DkimSignatureStream.cs @@ -88,7 +88,7 @@ public byte[] GenerateSignature () /// /// Verifies the DKIM signature. /// - /// true if signature is valid; otherwise, false. + /// if signature is valid; otherwise, . /// The base64 encoded DKIM signature from the b= parameter. /// /// is . @@ -115,7 +115,7 @@ void CheckDisposed () /// /// A is not readable. /// - /// true if the stream supports reading; otherwise, false. + /// if the stream supports reading; otherwise, . public override bool CanRead { get { return false; } } @@ -126,7 +126,7 @@ public override bool CanRead { /// /// A is always writable. /// - /// true if the stream supports writing; otherwise, false. + /// if the stream supports writing; otherwise, . public override bool CanWrite { get { return true; } } @@ -137,7 +137,7 @@ public override bool CanWrite { /// /// A is not seekable. /// - /// true if the stream supports seeking; otherwise, false. + /// if the stream supports seeking; otherwise, . public override bool CanSeek { get { return false; } } @@ -148,7 +148,7 @@ public override bool CanSeek { /// /// Writing to a cannot time out. /// - /// true if reading and writing to the stream can time out; otherwise, false. + /// if reading and writing to the stream can time out; otherwise, . public override bool CanTimeout { get { return false; } } @@ -340,8 +340,8 @@ public override void SetLength (long value) /// Releases the unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected override void Dispose (bool disposing) { if (disposing && !disposed) { diff --git a/MimeKit/Cryptography/DkimSimpleBodyFilter.cs b/MimeKit/Cryptography/DkimSimpleBodyFilter.cs index d1319844aa..5487f93ca4 100644 --- a/MimeKit/Cryptography/DkimSimpleBodyFilter.cs +++ b/MimeKit/Cryptography/DkimSimpleBodyFilter.cs @@ -104,7 +104,7 @@ int Filter (ReadOnlySpan input, Span output) /// The length of the input buffer, starting at . /// The output index. /// The output length. - /// If set to true, all internally buffered data should be flushed to the output buffer. + /// If set to , all internally buffered data should be flushed to the output buffer. protected override byte[] Filter (byte[] input, int startIndex, int length, out int outputIndex, out int outputLength, bool flush) { EnsureOutputSize (length + EmptyLines * 2 + 1, false); diff --git a/MimeKit/Cryptography/DkimVerifier.cs b/MimeKit/Cryptography/DkimVerifier.cs index c0d92cffc1..622ad05a2a 100644 --- a/MimeKit/Cryptography/DkimVerifier.cs +++ b/MimeKit/Cryptography/DkimVerifier.cs @@ -152,7 +152,7 @@ async Task VerifyAsync (FormatOptions options, MimeMessage message, Header /// /// /// - /// true if the DKIM-Signature is valid; otherwise, false. + /// if the DKIM-Signature is valid; otherwise, . /// The formatting options. /// The message to verify. /// The DKIM-Signature header. @@ -187,7 +187,7 @@ public bool Verify (FormatOptions options, MimeMessage message, Header dkimSigna /// /// /// - /// true if the DKIM-Signature is valid; otherwise, false. + /// if the DKIM-Signature is valid; otherwise, . /// The formatting options. /// The message to verify. /// The DKIM-Signature header. @@ -222,7 +222,7 @@ public Task VerifyAsync (FormatOptions options, MimeMessage message, Heade /// /// /// - /// true if the DKIM-Signature is valid; otherwise, false. + /// if the DKIM-Signature is valid; otherwise, . /// The message to verify. /// The DKIM-Signature header. /// The cancellation token. @@ -254,7 +254,7 @@ public bool Verify (MimeMessage message, Header dkimSignature, CancellationToken /// /// /// - /// true if the DKIM-Signature is valid; otherwise, false. + /// if the DKIM-Signature is valid; otherwise, . /// The message to verify. /// The DKIM-Signature header. /// The cancellation token. diff --git a/MimeKit/Cryptography/DkimVerifierBase.cs b/MimeKit/Cryptography/DkimVerifierBase.cs index 21d0ebde16..5bc74bc5fe 100644 --- a/MimeKit/Cryptography/DkimVerifierBase.cs +++ b/MimeKit/Cryptography/DkimVerifierBase.cs @@ -143,7 +143,7 @@ public void Disable (DkimSignatureAlgorithm algorithm) /// part of DKIM since it was originally standardized in 2007), it is recommended /// that NOT be enabled. /// - /// true if the specified DKIM signature algorithm is enabled; otherwise, false. + /// if the specified DKIM signature algorithm is enabled; otherwise, . /// The DKIM signature algorithm. public bool IsEnabled (DkimSignatureAlgorithm algorithm) { @@ -506,7 +506,7 @@ internal static Header GetSignedSignatureHeader (Header header) /// The algorithm used to canonicalize the message body. /// The max length of the message body to hash or -1 to hash the entire message body. /// The expected message body hash encoded in base64. - /// true if the calculated body hash matches ; otherwise, false. + /// if the calculated body hash matches ; otherwise, . protected static bool VerifyBodyHash (FormatOptions options, MimeMessage message, DkimSignatureAlgorithm signatureAlgorithm, DkimCanonicalizationAlgorithm canonicalizationAlgorithm, int maxLength, string bodyHash) { var hash = Convert.ToBase64String (message.HashBody (options, signatureAlgorithm, canonicalizationAlgorithm, maxLength)); @@ -528,7 +528,7 @@ protected static bool VerifyBodyHash (FormatOptions options, MimeMessage message /// The list of headers that were signed. /// The algorithm used to canonicalize the headers. /// The expected signature of the headers encoded in base64. - /// true if the calculated signature matches ; otherwise, false. + /// if the calculated signature matches ; otherwise, . protected bool VerifySignature (FormatOptions options, MimeMessage message, Header dkimSignature, DkimSignatureAlgorithm signatureAlgorithm, AsymmetricKeyParameter key, string[] headers, DkimCanonicalizationAlgorithm canonicalizationAlgorithm, string signature) { using (var stream = new DkimSignatureStream (CreateVerifyContext (signatureAlgorithm, key))) { diff --git a/MimeKit/Cryptography/GnuPGContext.cs b/MimeKit/Cryptography/GnuPGContext.cs index 4a15afe692..d7977c92d2 100644 --- a/MimeKit/Cryptography/GnuPGContext.cs +++ b/MimeKit/Cryptography/GnuPGContext.cs @@ -559,7 +559,7 @@ public override PgpSecretKey GetSigningKey (MailboxAddress mailbox, Cancellation /// /// Checks whether as particular mailbocx address can be used for signing. /// - /// true if the mailbox address can be used for signing; otherwise, false. + /// if the mailbox address can be used for signing; otherwise, . /// The signer. /// The cancellation token. /// @@ -593,7 +593,7 @@ public override bool CanSign (MailboxAddress signer, CancellationToken cancellat /// /// Checks whether the cryptography context can be used to encrypt to a particular recipient. /// - /// true if the cryptography context can be used to encrypt to the designated recipient; otherwise, false. + /// if the cryptography context can be used to encrypt to the designated recipient; otherwise, . /// The recipient's mailbox address. /// The cancellation token. /// @@ -1231,7 +1231,7 @@ public override Task ExportAsync (IEnumerable mailboxe /// /// The mailboxes. /// The output stream. - /// true if the output should be armored; otherwise, false. + /// if the output should be armored; otherwise, . /// The cancellation token. /// /// is . @@ -1276,7 +1276,7 @@ public override void Export (IEnumerable mailboxes, Stream strea /// An asynchronous task context. /// The mailboxes. /// The output stream. - /// true if the output should be armored; otherwise, false. + /// if the output should be armored; otherwise, . /// The cancellation token. /// /// is . diff --git a/MimeKit/Cryptography/ICryptographyContext.cs b/MimeKit/Cryptography/ICryptographyContext.cs index c6a6a4b936..6caa104c76 100644 --- a/MimeKit/Cryptography/ICryptographyContext.cs +++ b/MimeKit/Cryptography/ICryptographyContext.cs @@ -47,7 +47,7 @@ public interface ICryptographyContext : IDisposable /// /// Gets or sets whether a should be prepared before signing. /// - /// true if a MimeEntity should be prepared before signing; otherwise, false. + /// if a MimeEntity should be prepared before signing; otherwise, . bool PrepareBeforeSigning { get; set; } /// @@ -88,7 +88,7 @@ public interface ICryptographyContext : IDisposable /// Used in order to make sure that the protocol parameter value specified in either a multipart/signed /// or multipart/encrypted part is supported by the supplied cryptography context. /// - /// true if the protocol is supported; otherwise false + /// if the protocol is supported; otherwise, /// The protocol. /// /// is . @@ -156,7 +156,7 @@ public interface ICryptographyContext : IDisposable /// /// Determines whether the specified digest algorithm is enabled. /// - /// true if the specified digest algorithm is enabled; otherwise, false. + /// if the specified digest algorithm is enabled; otherwise, . /// The digest algorithm. bool IsEnabled (DigestAlgorithm algorithm); @@ -193,7 +193,7 @@ public interface ICryptographyContext : IDisposable /// /// Determines whether the specified encryption algorithm is enabled. /// - /// true if the specified encryption algorithm is enabled; otherwise, false. + /// if the specified encryption algorithm is enabled; otherwise, . /// The encryption algorithm. bool IsEnabled (EncryptionAlgorithm algorithm); @@ -203,7 +203,7 @@ public interface ICryptographyContext : IDisposable /// /// Checks whether the cryptography context can be used to encrypt to a particular recipient. /// - /// true if the cryptography context can be used to encrypt to the designated recipient; otherwise, false. + /// if the cryptography context can be used to encrypt to the designated recipient; otherwise, . /// The recipient's mailbox address. /// The cancellation token. /// @@ -220,7 +220,7 @@ public interface ICryptographyContext : IDisposable /// /// Checks whether the cryptography context can be used to encrypt to a particular recipient. /// - /// true if the cryptography context can be used to encrypt to the designated recipient; otherwise, false. + /// if the cryptography context can be used to encrypt to the designated recipient; otherwise, . /// The recipient's mailbox address. /// The cancellation token. /// @@ -317,7 +317,7 @@ public interface ICryptographyContext : IDisposable /// /// Checks whether as particular mailbocx address can be used for signing. /// - /// true if the mailbox address can be used for signing; otherwise, false. + /// if the mailbox address can be used for signing; otherwise, . /// The signer. /// The cancellation token. /// @@ -334,7 +334,7 @@ public interface ICryptographyContext : IDisposable /// /// Checks whether as particular mailbocx address can be used for signing. /// - /// true if the mailbox address can be used for signing; otherwise, false. + /// if the mailbox address can be used for signing; otherwise, . /// The signer. /// The cancellation token. /// diff --git a/MimeKit/Cryptography/IDigitalSignature.cs b/MimeKit/Cryptography/IDigitalSignature.cs index aa82bc7723..12b71419db 100644 --- a/MimeKit/Cryptography/IDigitalSignature.cs +++ b/MimeKit/Cryptography/IDigitalSignature.cs @@ -77,7 +77,7 @@ public interface IDigitalSignature /// /// Verifies the digital signature. /// - /// true if the signature is valid; otherwise, false. + /// if the signature is valid; otherwise, . /// /// An error verifying the signature has occurred. /// @@ -89,8 +89,8 @@ public interface IDigitalSignature /// /// Verifies the digital signature. /// - /// true if only the signature itself should be verified; otherwise, both the signature and the certificate chain are validated. - /// true if the signature is valid; otherwise, false. + /// if only the signature itself should be verified; otherwise, both the signature and the certificate chain are validated. + /// if the signature is valid; otherwise, . /// /// An error verifying the signature has occurred. /// diff --git a/MimeKit/Cryptography/IX509CertificateDatabase.cs b/MimeKit/Cryptography/IX509CertificateDatabase.cs index 8759fdf127..041a8e8521 100644 --- a/MimeKit/Cryptography/IX509CertificateDatabase.cs +++ b/MimeKit/Cryptography/IX509CertificateDatabase.cs @@ -89,7 +89,7 @@ public interface IX509CertificateDatabase : IStore, IDisposable /// The matching certificate records populated with the desired fields. /// The mailbox. /// The date and time. - /// true if a private key is required. + /// if a private key is required. /// The desired fields. IEnumerable Find (MailboxAddress mailbox, DateTime now, bool requirePrivateKey, X509CertificateRecordFields fields); @@ -102,7 +102,7 @@ public interface IX509CertificateDatabase : IStore, IDisposable /// /// The matching certificate records populated with the desired fields. /// The match selector or to match all certificates. - /// true if only trusted anchor certificates should be returned. + /// if only trusted anchor certificates should be returned. /// The desired fields. IEnumerable Find (ISelector selector, bool trustedAnchorsOnly, X509CertificateRecordFields fields); diff --git a/MimeKit/Cryptography/OpenPgpBlockFilter.cs b/MimeKit/Cryptography/OpenPgpBlockFilter.cs index 18d38d80f9..9071ca6089 100644 --- a/MimeKit/Cryptography/OpenPgpBlockFilter.cs +++ b/MimeKit/Cryptography/OpenPgpBlockFilter.cs @@ -99,7 +99,7 @@ static bool IsPartialMatch (byte[] input, int startIndex, int endIndex, byte[] m /// The length of the input buffer, starting at . /// The output index. /// The output length. - /// If set to true, all internally buffered data should be flushed to the output buffer. + /// If set to , all internally buffered data should be flushed to the output buffer. protected override byte[] Filter (byte[] input, int startIndex, int length, out int outputIndex, out int outputLength, bool flush) { int endIndex = startIndex + length; diff --git a/MimeKit/Cryptography/OpenPgpContext.cs b/MimeKit/Cryptography/OpenPgpContext.cs index 55888fddce..ce8f23a26d 100644 --- a/MimeKit/Cryptography/OpenPgpContext.cs +++ b/MimeKit/Cryptography/OpenPgpContext.cs @@ -340,7 +340,7 @@ public Uri KeyServer { /// fetch keys as needed from the keyserver when verifying signatures. /// Requires a valid to be set. /// - /// true if unknown PGP keys should automatically be retrieved; otherwise, false. + /// if unknown PGP keys should automatically be retrieved; otherwise, . public bool AutoKeyRetrieve { get; set; } @@ -389,7 +389,7 @@ public override string KeyExchangeProtocol { /// Used in order to make sure that the protocol parameter value specified in either a multipart/signed /// or multipart/encrypted part is supported by the supplied cryptography context. /// - /// true if the protocol is supported; otherwise false + /// if the protocol is supported; otherwise, /// The protocol. /// /// is . @@ -522,7 +522,7 @@ static string HexEncode (byte[] data) /// /// The public key. /// The mailbox address. - /// true if the key is a match for the specified mailbox; otherwise, false. + /// if the key is a match for the specified mailbox; otherwise, . /// /// is . /// -or- @@ -571,7 +571,7 @@ protected static bool IsMatch (PgpPublicKey key, MailboxAddress mailbox) /// /// The secret key. /// The mailbox address. - /// true if the key is a match for the specified mailbox; otherwise, false. + /// if the key is a match for the specified mailbox; otherwise, . /// /// is . /// -or- @@ -615,7 +615,7 @@ protected static bool IsMatch (PgpSecretKey key, MailboxAddress mailbox) /// Checks if a public key is expired. /// /// The public key. - /// true if the public key is expired; otherwise, false. + /// if the public key is expired; otherwise, . /// /// is . /// @@ -639,7 +639,7 @@ protected static bool IsExpired (PgpPublicKey key) /// Retrieves the public keyring, using the preferred key server, automatically importing it afterward. /// /// The identifier of the key to be retrieved. - /// true if this operation should be done asynchronously; otherwise, false. + /// if this operation should be done asynchronously; otherwise, . /// The cancellation token. /// The public key ring. async Task RetrievePublicKeyRingAsync (long keyId, bool doAsync, CancellationToken cancellationToken) @@ -2786,7 +2786,7 @@ public async Task ExportAsync (PgpPublicKeyRingBundle keys, Cancellati /// /// The public keys to export. /// The output stream. - /// true if the output should be armored; otherwise, false. + /// if the output should be armored; otherwise, . /// The cancellation token. /// /// is . @@ -2822,7 +2822,7 @@ public void Export (IEnumerable keys, Stream stream, bool armor, C /// An asynchronous task context. /// The public keys to export. /// The output stream. - /// true if the output should be armored; otherwise, false. + /// if the output should be armored; otherwise, . /// The cancellation token. /// /// is . @@ -2857,7 +2857,7 @@ public Task ExportAsync (IEnumerable keys, Stream stream, bool arm /// /// The public keyring bundle to export. /// The output stream. - /// true if the output should be armored; otherwise, false. + /// if the output should be armored; otherwise, . /// The cancellation token. /// /// is . @@ -2899,7 +2899,7 @@ public void Export (PgpPublicKeyRingBundle keys, Stream stream, bool armor, Canc /// An asynchronous task context. /// The public keyring bundle to export. /// The output stream. - /// true if the output should be armored; otherwise, false. + /// if the output should be armored; otherwise, . /// The cancellation token. /// /// is . @@ -2942,7 +2942,7 @@ public async Task ExportAsync (PgpPublicKeyRingBundle keys, Stream stream, bool /// /// The mailboxes. /// The output stream. - /// true if the output should be armored; otherwise, false. + /// if the output should be armored; otherwise, . /// The cancellation token. /// /// is . @@ -2972,7 +2972,7 @@ public async Task ExportAsync (PgpPublicKeyRingBundle keys, Stream stream, bool /// An asynchronous task context. /// The mailboxes. /// The output stream. - /// true if the output should be armored; otherwise, false. + /// if the output should be armored; otherwise, . /// The cancellation token. /// /// is . diff --git a/MimeKit/Cryptography/OpenPgpDetectionFilter.cs b/MimeKit/Cryptography/OpenPgpDetectionFilter.cs index c9cf2539ff..062804f96f 100644 --- a/MimeKit/Cryptography/OpenPgpDetectionFilter.cs +++ b/MimeKit/Cryptography/OpenPgpDetectionFilter.cs @@ -201,7 +201,7 @@ void SetPosition (int offset, int marker, bool cr) /// The length of the input buffer, starting at . /// The output index. /// The output length. - /// If set to true, all internally buffered data should be flushed to the output buffer. + /// If set to , all internally buffered data should be flushed to the output buffer. protected override byte[] Filter (byte[] input, int startIndex, int length, out int outputIndex, out int outputLength, bool flush) { int endIndex = startIndex + length; diff --git a/MimeKit/Cryptography/OpenPgpDigitalSignature.cs b/MimeKit/Cryptography/OpenPgpDigitalSignature.cs index 0121a0440c..b0ddd7f941 100644 --- a/MimeKit/Cryptography/OpenPgpDigitalSignature.cs +++ b/MimeKit/Cryptography/OpenPgpDigitalSignature.cs @@ -113,7 +113,7 @@ public DateTime CreationDate { /// /// Verifies the digital signature. /// - /// true if the signature is valid; otherwise, false. + /// if the signature is valid; otherwise, . /// /// An error verifying the signature has occurred. /// @@ -151,7 +151,7 @@ public bool Verify () /// Verifies the digital signature. /// /// This option is ignored for OpenPGP digital signatures. - /// true if the signature is valid; otherwise, false. + /// if the signature is valid; otherwise, . /// /// An error verifying the signature has occurred. /// diff --git a/MimeKit/Cryptography/RsaEncryptionPadding.cs b/MimeKit/Cryptography/RsaEncryptionPadding.cs index f1fd41cf9d..bc51f69868 100644 --- a/MimeKit/Cryptography/RsaEncryptionPadding.cs +++ b/MimeKit/Cryptography/RsaEncryptionPadding.cs @@ -119,8 +119,8 @@ public DigestAlgorithm OaepHashAlgorithm { /// Compares two RSA encryption paddings to determine if they are identical or not. /// /// The to compare with the current . - /// true if the specified is equal to the current - /// ; otherwise, false. + /// if the specified is equal to the current + /// ; otherwise, . public bool Equals (RsaEncryptionPadding other) { if (other is null) @@ -137,7 +137,7 @@ public bool Equals (RsaEncryptionPadding other) /// the current instance is a reference type or a value type. /// /// The object to compare with the current object. - /// true if the specified object is equal to the current object; otherwise, false. + /// if the specified object is equal to the current object; otherwise, . public override bool Equals (object obj) { return Equals (obj as RsaEncryptionPadding); @@ -179,7 +179,7 @@ public override string ToString () /// /// The first object to compare. /// The second object to compare. - /// true if and are equal; otherwise, false. + /// if and are equal; otherwise, . public static bool operator == (RsaEncryptionPadding left, RsaEncryptionPadding right) { if (left is null) @@ -196,7 +196,7 @@ public override string ToString () /// /// The first object to compare. /// The second object to compare. - /// true if and are unequal; otherwise, false. + /// if and are unequal; otherwise, . public static bool operator != (RsaEncryptionPadding left, RsaEncryptionPadding right) { return !(left == right); diff --git a/MimeKit/Cryptography/RsaSignaturePadding.cs b/MimeKit/Cryptography/RsaSignaturePadding.cs index a9c47e651b..ec48fe16f6 100644 --- a/MimeKit/Cryptography/RsaSignaturePadding.cs +++ b/MimeKit/Cryptography/RsaSignaturePadding.cs @@ -75,8 +75,8 @@ public RsaSignaturePaddingScheme Scheme { /// Compares two RSA Signature paddings to determine if they are identical or not. /// /// The to compare with the current . - /// true if the specified is equal to the current - /// ; otherwise, false. + /// if the specified is equal to the current + /// ; otherwise, . public bool Equals (RsaSignaturePadding other) { if (other is null) @@ -93,7 +93,7 @@ public bool Equals (RsaSignaturePadding other) /// the current instance is a reference type or a value type. /// /// The object to compare with the current object. - /// true if the specified object is equal to the current object; otherwise, false. + /// if the specified object is equal to the current object; otherwise, . public override bool Equals (object obj) { return Equals (obj as RsaSignaturePadding); @@ -133,7 +133,7 @@ public override string ToString () /// /// The first object to compare. /// The second object to compare. - /// true if and are equal; otherwise, false. + /// if and are equal; otherwise, . public static bool operator == (RsaSignaturePadding left, RsaSignaturePadding right) { if (left is null) @@ -150,7 +150,7 @@ public override string ToString () /// /// The first object to compare. /// The second object to compare. - /// true if and are unequal; otherwise, false. + /// if and are unequal; otherwise, . public static bool operator != (RsaSignaturePadding left, RsaSignaturePadding right) { return !(left == right); diff --git a/MimeKit/Cryptography/SecureMimeContext.cs b/MimeKit/Cryptography/SecureMimeContext.cs index 4dab00c0e8..11c8dc622a 100644 --- a/MimeKit/Cryptography/SecureMimeContext.cs +++ b/MimeKit/Cryptography/SecureMimeContext.cs @@ -160,7 +160,7 @@ public override string KeyExchangeProtocol { /// Used in order to make sure that the protocol parameter value specified in either a multipart/signed /// or multipart/encrypted part is supported by the supplied cryptography context. /// - /// true if the protocol is supported; otherwise false + /// if the protocol is supported; otherwise, /// The protocol. /// /// is . diff --git a/MimeKit/Cryptography/SecureMimeDigitalSignature.cs b/MimeKit/Cryptography/SecureMimeDigitalSignature.cs index b0078acac9..7b1df13802 100644 --- a/MimeKit/Cryptography/SecureMimeDigitalSignature.cs +++ b/MimeKit/Cryptography/SecureMimeDigitalSignature.cs @@ -197,7 +197,7 @@ public DateTime CreationDate { /// /// Verifies the digital signature. /// - /// true if the signature is valid; otherwise, false. + /// if the signature is valid; otherwise, . /// /// An error verifying the signature has occurred. /// @@ -212,8 +212,8 @@ public bool Verify () /// /// Verifies the digital signature. /// - /// true if only the signature itself should be verified; otherwise, both the signature and the certificate chain are validated. - /// true if the signature is valid; otherwise, false. + /// if only the signature itself should be verified; otherwise, both the signature and the certificate chain are validated. + /// if the signature is valid; otherwise, . /// /// An error verifying the signature has occurred. /// diff --git a/MimeKit/Cryptography/SqlCertificateDatabase.cs b/MimeKit/Cryptography/SqlCertificateDatabase.cs index 4e94baa676..2704b3c2ae 100644 --- a/MimeKit/Cryptography/SqlCertificateDatabase.cs +++ b/MimeKit/Cryptography/SqlCertificateDatabase.cs @@ -516,8 +516,8 @@ protected override DbCommand GetSelectCommand (DbConnection connection, MailboxA /// The database command. /// The database connection. /// The certificate selector. - /// true if only trusted anchor certificates should be matched; otherwise, false. - /// true if the certificate must have a private key; otherwise, false. + /// if only trusted anchor certificates should be matched; otherwise, . + /// if the certificate must have a private key; otherwise, . /// The fields to return. protected override DbCommand GetSelectCommand (DbConnection connection, ISelector selector, bool trustedAnchorsOnly, bool requirePrivateKey, X509CertificateRecordFields fields) { @@ -914,8 +914,8 @@ protected override DbCommand GetUpdateCommand (DbConnection connection, X509CrlR /// Releases the unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected override void Dispose (bool disposing) { if (disposing && !disposed) { diff --git a/MimeKit/Cryptography/TemporarySecureMimeContext.cs b/MimeKit/Cryptography/TemporarySecureMimeContext.cs index 31f74583e2..1c7dfbd5a2 100644 --- a/MimeKit/Cryptography/TemporarySecureMimeContext.cs +++ b/MimeKit/Cryptography/TemporarySecureMimeContext.cs @@ -89,7 +89,7 @@ public TemporarySecureMimeContext (SecureRandom random) : base (random) /// /// Checks whether as particular mailbocx address can be used for signing. /// - /// true if the mailbox address can be used for signing; otherwise, false. + /// if the mailbox address can be used for signing; otherwise, . /// The signer. /// The cancellation token. /// @@ -112,7 +112,7 @@ public override bool CanSign (MailboxAddress signer, CancellationToken cancellat /// /// Checks whether the cryptography context can be used to encrypt to a particular recipient. /// - /// true if the cryptography context can be used to encrypt to the designated recipient; otherwise, false. + /// if the cryptography context can be used to encrypt to the designated recipient; otherwise, . /// The recipient's mailbox address. /// The cancellation token. /// diff --git a/MimeKit/Cryptography/WindowsSecureMimeContext.cs b/MimeKit/Cryptography/WindowsSecureMimeContext.cs index 0eca2aa4d1..12e0b6fa50 100644 --- a/MimeKit/Cryptography/WindowsSecureMimeContext.cs +++ b/MimeKit/Cryptography/WindowsSecureMimeContext.cs @@ -119,7 +119,7 @@ public StoreLocation StoreLocation { /// /// Checks whether as particular mailbocx address can be used for signing. /// - /// true if the mailbox address can be used for signing; otherwise, false. + /// if the mailbox address can be used for signing; otherwise, . /// The signer. /// The cancellation token. /// @@ -142,7 +142,7 @@ public override bool CanSign (MailboxAddress signer, CancellationToken cancellat /// /// Checks whether the cryptography context can be used to encrypt to a particular recipient. /// - /// true if the cryptography context can be used to encrypt to the designated recipient; otherwise, false. + /// if the cryptography context can be used to encrypt to the designated recipient; otherwise, . /// The recipient's mailbox address. /// The cancellation token. /// @@ -890,7 +890,7 @@ public override async Task SignAsync (MailboxAddress signer, DigestAlg /// Attempts to map a /// to a . /// - /// true if the algorithm identifier was successfully mapped; otherwise, false. + /// if the algorithm identifier was successfully mapped; otherwise, . /// The algorithm identifier. /// The encryption algorithm. /// diff --git a/MimeKit/Cryptography/WindowsSecureMimeDigitalSignature.cs b/MimeKit/Cryptography/WindowsSecureMimeDigitalSignature.cs index 65cca0b3a9..ea17fe5827 100644 --- a/MimeKit/Cryptography/WindowsSecureMimeDigitalSignature.cs +++ b/MimeKit/Cryptography/WindowsSecureMimeDigitalSignature.cs @@ -169,7 +169,7 @@ public DateTime CreationDate { /// /// Verifies the digital signature. /// - /// true if the signature is valid; otherwise false. + /// if the signature is valid; otherwise, . /// /// An error verifying the signature has occurred. /// @@ -184,8 +184,8 @@ public bool Verify () /// /// Verifies the digital signature. /// - /// true if only the signature itself should be verified; otherwise, both the signature and the certificate chain are validated. - /// true if the signature is valid; otherwise, false. + /// if only the signature itself should be verified; otherwise, both the signature and the certificate chain are validated. + /// if the signature is valid; otherwise, . /// /// An error verifying the signature has occurred. /// diff --git a/MimeKit/Cryptography/X509Certificate2Extensions.cs b/MimeKit/Cryptography/X509Certificate2Extensions.cs index a07c42b7a9..cc8d313507 100644 --- a/MimeKit/Cryptography/X509Certificate2Extensions.cs +++ b/MimeKit/Cryptography/X509Certificate2Extensions.cs @@ -147,7 +147,7 @@ static string[] GetSubjectAlternativeNames (X509Certificate2 certificate, int ta /// /// The subject DNS names. /// The certificate. - /// If set to true, international domain names will be IDN encoded. + /// If set to , international domain names will be IDN encoded. /// /// is . /// diff --git a/MimeKit/Cryptography/X509CertificateChain.cs b/MimeKit/Cryptography/X509CertificateChain.cs index 344829aa55..b113ab4825 100644 --- a/MimeKit/Cryptography/X509CertificateChain.cs +++ b/MimeKit/Cryptography/X509CertificateChain.cs @@ -174,7 +174,7 @@ public int Count { /// /// A is never read-only. /// - /// true if this instance is read only; otherwise, false. + /// if this instance is read only; otherwise, . public bool IsReadOnly { get { return false; } } @@ -233,8 +233,8 @@ public void Clear () /// /// Determines whether the certificate chain contains the specified certificate. /// - /// true if the specified certificate exists; - /// otherwise false. + /// if the specified certificate exists; + /// otherwise, . /// The certificate. /// /// is . @@ -273,7 +273,7 @@ public void CopyTo (X509Certificate[] array, int arrayIndex) /// /// Removes the specified certificate from the chain. /// - /// true if the certificate was removed; otherwise false. + /// if the certificate was removed; otherwise, . /// The certificate. /// /// is . diff --git a/MimeKit/Cryptography/X509CertificateDatabase.cs b/MimeKit/Cryptography/X509CertificateDatabase.cs index 489b10e927..ec44b4744c 100644 --- a/MimeKit/Cryptography/X509CertificateDatabase.cs +++ b/MimeKit/Cryptography/X509CertificateDatabase.cs @@ -683,7 +683,7 @@ protected static string[] GetColumnNames (X509CertificateRecordFields fields) /// The database connection. /// The mailbox. /// The date and time for which the certificate should be valid. - /// true if the certificate must have a private key; otherwise, false. + /// if the certificate must have a private key; otherwise, . /// The fields to return. protected abstract DbCommand GetSelectCommand (DbConnection connection, MailboxAddress mailbox, DateTime now, bool requirePrivateKey, X509CertificateRecordFields fields); @@ -696,8 +696,8 @@ protected static string[] GetColumnNames (X509CertificateRecordFields fields) /// The database command. /// The database connection. /// The certificate selector. - /// true if only trusted anchor certificates should be matched; otherwise, false. - /// true if the certificate must have a private key; otherwise, false. + /// if only trusted anchor certificates should be matched; otherwise, . + /// if the certificate must have a private key; otherwise, . /// The fields to return. protected abstract DbCommand GetSelectCommand (DbConnection connection, ISelector selector, bool trustedAnchorsOnly, bool requirePrivateKey, X509CertificateRecordFields fields); @@ -991,7 +991,7 @@ public IEnumerable FindPrivateKeys (ISelectorThe matching certificate records populated with the desired fields. /// The mailbox. /// The date and time. - /// true if a private key is required. + /// if a private key is required. /// The desired fields. /// /// is . @@ -1024,7 +1024,7 @@ public IEnumerable Find (MailboxAddress mailbox, DateTime /// /// The matching certificate records populated with the desired fields. /// The match selector or to match all certificates. - /// true if only trusted anchor certificates should be returned. + /// if only trusted anchor certificates should be returned. /// The desired fields. public IEnumerable Find (ISelector selector, bool trustedAnchorsOnly, X509CertificateRecordFields fields) { @@ -1278,8 +1278,8 @@ IEnumerable IStore.EnumerateMatches (ISelector /// Releases the unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected virtual void Dispose (bool disposing) { if (!disposing) diff --git a/MimeKit/Cryptography/X509CertificateRecord.cs b/MimeKit/Cryptography/X509CertificateRecord.cs index 8af75ef0b1..42ef630b13 100644 --- a/MimeKit/Cryptography/X509CertificateRecord.cs +++ b/MimeKit/Cryptography/X509CertificateRecord.cs @@ -111,7 +111,7 @@ public class X509CertificateRecord /// /// Indicates whether the certificate is trusted. /// - /// true if the certificate is trusted; otherwise, false. + /// if the certificate is trusted; otherwise, . public bool IsTrusted { get; set; } /// @@ -120,7 +120,7 @@ public class X509CertificateRecord /// /// Gets whether the certificate is an anchor. /// - /// true if the certificate is an anchor; otherwise, false. + /// if the certificate is an anchor; otherwise, . public bool IsAnchor { get { return Certificate.IsSelfSigned (); } } /// diff --git a/MimeKit/Cryptography/X509CrlRecord.cs b/MimeKit/Cryptography/X509CrlRecord.cs index a99837d62e..8cf490b1cd 100644 --- a/MimeKit/Cryptography/X509CrlRecord.cs +++ b/MimeKit/Cryptography/X509CrlRecord.cs @@ -95,7 +95,7 @@ public class X509CrlRecord /// /// Indicates whether this certificate revocation list is a delta. /// - /// true if th crl is delta; otherwise, false. + /// if th crl is delta; otherwise, . public bool IsDelta { get; internal set; } /// diff --git a/MimeKit/DomainList.cs b/MimeKit/DomainList.cs index 2e8fe5420a..50e6d3cc99 100644 --- a/MimeKit/DomainList.cs +++ b/MimeKit/DomainList.cs @@ -210,8 +210,8 @@ public void Clear () /// /// Determines whether the domain list contains the specified domain. /// - /// true if the specified domain is contained; - /// otherwise false. + /// if the specified domain is contained; + /// otherwise, . /// The domain. /// /// is . @@ -250,7 +250,7 @@ public void CopyTo (string[] array, int arrayIndex) /// /// Removes the first instance of the specified domain from the list if it exists. /// - /// true if the domain was removed; otherwise false. + /// if the domain was removed; otherwise, . /// The domain. /// /// is . @@ -285,7 +285,7 @@ public int Count { /// /// A is never read-only. /// - /// true if this instance is read only; otherwise, false. + /// if this instance is read only; otherwise, . public bool IsReadOnly { get { return false; } } @@ -391,8 +391,8 @@ void OnChanged () /// specified index. The index will only be updated if a was /// successfully parsed. /// - /// true if a was successfully parsed; - /// false otherwise. + /// if a was successfully parsed; + /// otherwise, . /// The buffer to parse. /// The index to start parsing. /// An index of the end of the input. @@ -449,8 +449,8 @@ internal static bool TryParse (byte[] buffer, ref int index, int endIndex, bool /// Attempts to parse a from the supplied text. The index /// will only be updated if a was successfully parsed. /// - /// true if a was successfully parsed; - /// false otherwise. + /// if a was successfully parsed; + /// otherwise, . /// The text to parse. /// The parsed DomainList. /// diff --git a/MimeKit/Encodings/Base64Encoder.cs b/MimeKit/Encodings/Base64Encoder.cs index 3b9014f355..d365a4ced3 100644 --- a/MimeKit/Encodings/Base64Encoder.cs +++ b/MimeKit/Encodings/Base64Encoder.cs @@ -52,7 +52,7 @@ public class Base64Encoder : IMimeEncoder /// /// Creates a new base64 encoder. /// - /// true if this encoder will be used to encode rfc2047 encoded-word payloads; false otherwise. + /// if this encoder will be used to encode rfc2047 encoded-word payloads; otherwise, . /// The maximum number of octets allowed per line (not counting the CRLF). Must be between 60 and 998 (inclusive). /// /// is not between 60 and 998 (inclusive). diff --git a/MimeKit/Encodings/QuotedPrintableDecoder.cs b/MimeKit/Encodings/QuotedPrintableDecoder.cs index dfb87db8e3..426dfec167 100644 --- a/MimeKit/Encodings/QuotedPrintableDecoder.cs +++ b/MimeKit/Encodings/QuotedPrintableDecoder.cs @@ -56,7 +56,7 @@ enum QpDecoderState : byte { /// /// Creates a new quoted-printable decoder. /// - /// true if this decoder will be used to decode rfc2047 encoded-word tokens; otherwise, false. + /// if this decoder will be used to decode rfc2047 encoded-word tokens; otherwise, . public QuotedPrintableDecoder (bool rfc2047) { this.rfc2047 = rfc2047; diff --git a/MimeKit/Encodings/UUDecoder.cs b/MimeKit/Encodings/UUDecoder.cs index f5df5dd83a..76cc7d9c55 100644 --- a/MimeKit/Encodings/UUDecoder.cs +++ b/MimeKit/Encodings/UUDecoder.cs @@ -83,7 +83,7 @@ enum UUDecoderState : byte { /// Creates a new Unix-to-Unix decoder. /// /// - /// If true, decoding begins immediately rather than after finding a begin-line. + /// If , decoding begins immediately rather than after finding a begin-line. /// public UUDecoder (bool payloadOnly) { diff --git a/MimeKit/Encodings/YDecoder.cs b/MimeKit/Encodings/YDecoder.cs index 5e1944f72c..5442e24ba8 100644 --- a/MimeKit/Encodings/YDecoder.cs +++ b/MimeKit/Encodings/YDecoder.cs @@ -78,7 +78,7 @@ enum YDecoderState : byte { /// Creates a new yEnc decoder. /// /// - /// If true, decoding begins immediately rather than after finding an =ybegin line. + /// If , decoding begins immediately rather than after finding an =ybegin line. /// public YDecoder (bool payloadOnly) { diff --git a/MimeKit/ExperimentalMimeParser.cs b/MimeKit/ExperimentalMimeParser.cs index 9285c85144..ecd95a307d 100644 --- a/MimeKit/ExperimentalMimeParser.cs +++ b/MimeKit/ExperimentalMimeParser.cs @@ -70,7 +70,7 @@ public class ExperimentalMimeParser : MimeReader, IMimeParser /// /// /// Creates a new that will parse the specified stream. - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -80,7 +80,7 @@ public class ExperimentalMimeParser : MimeReader, IMimeParser /// /// The stream to parse. /// The format of the stream. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// /// is . /// @@ -93,7 +93,7 @@ public ExperimentalMimeParser (Stream stream, MimeFormat format, bool persistent /// /// /// Creates a new that will parse the specified stream. - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -102,7 +102,7 @@ public ExperimentalMimeParser (Stream stream, MimeFormat format, bool persistent /// for to read the content. /// /// The stream to parse. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// /// is . /// @@ -115,7 +115,7 @@ public ExperimentalMimeParser (Stream stream, bool persistent = false) : this (P /// /// /// Creates a new that will parse the specified stream. - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -125,7 +125,7 @@ public ExperimentalMimeParser (Stream stream, bool persistent = false) : this (P /// /// The parser options. /// The stream to parse. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// /// is . /// -or- @@ -140,7 +140,7 @@ public ExperimentalMimeParser (ParserOptions options, Stream stream, bool persis /// /// /// Creates a new that will parse the specified stream. - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -151,7 +151,7 @@ public ExperimentalMimeParser (ParserOptions options, Stream stream, bool persis /// The parser options. /// The stream to parse. /// The format of the stream. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// /// is . /// -or- @@ -189,7 +189,7 @@ public string MboxMarker { /// /// /// Sets the stream to parse. - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -199,7 +199,7 @@ public string MboxMarker { /// /// The stream to parse. /// The format of the stream. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// /// is . /// @@ -233,7 +233,7 @@ public override void SetStream (Stream stream, MimeFormat format = MimeFormat.De /// /// /// Sets the stream to parse. - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -242,7 +242,7 @@ public override void SetStream (Stream stream, MimeFormat format = MimeFormat.De /// for to read the content. /// /// The stream to parse. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// /// is . /// diff --git a/MimeKit/FormatOptions.cs b/MimeKit/FormatOptions.cs index 9bef5297e2..0ab43f2815 100644 --- a/MimeKit/FormatOptions.cs +++ b/MimeKit/FormatOptions.cs @@ -133,10 +133,10 @@ public NewLineFormat NewLineFormat { /// maintain byte-for-byte compatibility with the original stream that the message was parsed from. /// This means that if the ogirinal message stream did not end with a new-line sequence, then the /// output of writing the message back to a stream will also not end with a new-line sequence. - /// To override this behavior, you can set this property to true in order to ensure + /// To override this behavior, you can set this property to in order to ensure /// that writing the message back to a stream will always end with a new-line sequence. /// - /// true in order to ensure that the message will end with a new-line sequence; otherwise, false. + /// in order to ensure that the message will end with a new-line sequence; otherwise, . /// /// cannot be changed. /// @@ -200,7 +200,7 @@ public HashSet HiddenHeaders { /// or when appending messages to an IMAP folder via UTF8 APPEND /// (rfc6855). /// - /// true if the new internationalized formatting should be used; otherwise, false. + /// if the new internationalized formatting should be used; otherwise, . /// /// cannot be changed. /// @@ -229,7 +229,7 @@ public bool International { /// /// https://bugzilla.mozilla.org/show_bug.cgi?id=317263. /// - /// true if the formatter should be allowed to use us-ascii and/or iso-8859-1 when encoding headers; otherwise, false. + /// if the formatter should be allowed to use us-ascii and/or iso-8859-1 when encoding headers; otherwise, . public bool AllowMixedHeaderCharsets { get { return allowMixedHeaderCharsets; } set { @@ -284,7 +284,7 @@ public ParameterEncodingMethod ParameterEncodingMethod { /// adhere to the MIME specifications, this property can be used to force MimeKit to quote parameter values that would normally /// not require quoting. /// - /// true if Content-Type and Content-Disposition parameters should always be quoted; otherwise, false. + /// if Content-Type and Content-Disposition parameters should always be quoted; otherwise, . public bool AlwaysQuoteParameterValues { get { return alwaysQuoteParameterValues; } set { diff --git a/MimeKit/GroupAddress.cs b/MimeKit/GroupAddress.cs index 6e0065da61..a53dda8dc5 100644 --- a/MimeKit/GroupAddress.cs +++ b/MimeKit/GroupAddress.cs @@ -179,13 +179,13 @@ internal override void Encode (FormatOptions options, StringBuilder builder, boo /// /// /// Returns a string containing the formatted group of addresses. If the - /// parameter is true, then the name of the group and all member addresses will be encoded + /// parameter is , then the name of the group and all member addresses will be encoded /// according to the rules defined in rfc2047, otherwise the names will not be encoded at all and /// will therefor only be suitable for display purposes. /// /// A string representing the . /// The formatting options. - /// If set to true, the will be encoded. + /// If set to , the will be encoded. /// /// is . /// @@ -227,8 +227,8 @@ public override string ToString (FormatOptions options, bool encode) /// Compares two group addresses to determine if they are identical or not. /// /// The to compare with the current . - /// true if the specified is equal to the current - /// ; otherwise, false. + /// if the specified is equal to the current + /// ; otherwise, . public override bool Equals (InternetAddress other) { if (other is not GroupAddress group) @@ -268,7 +268,7 @@ static bool TryParse (ParserOptions options, byte[] text, ref int index, int end /// Parses a single . If the address is not a group address or /// there is more than a single group address, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The parser options to use. /// The input buffer. /// The starting index of the input buffer. @@ -308,7 +308,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde /// Parses a single . If the address is not a group address or /// there is more than a single group address, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The input buffer. /// The starting index of the input buffer. /// The number of bytes in the input buffer to parse. @@ -332,7 +332,7 @@ public static bool TryParse (byte[] buffer, int startIndex, int length, out Grou /// Parses a single . If the address is not a group address or /// there is more than a single group address, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The parser options to use. /// The input buffer. /// The starting index of the input buffer. @@ -370,7 +370,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde /// Parses a single . If the address is not a group address or /// there is more than a single group address, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The input buffer. /// The starting index of the input buffer. /// The parsed group address. @@ -392,7 +392,7 @@ public static bool TryParse (byte[] buffer, int startIndex, out GroupAddress gro /// Parses a single . If the address is not a group address or /// there is more than a single group address, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The parser options to use. /// The input buffer. /// The parsed group address. @@ -426,7 +426,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, out GroupAddr /// Parses a single . If the address is not a group address or /// there is more than a single group address, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The input buffer. /// The parsed group address. /// @@ -444,7 +444,7 @@ public static bool TryParse (byte[] buffer, out GroupAddress group) /// Parses a single . If the address is not a group address or /// there is more than a single group address, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The parser options to use. /// The text. /// The parsed group address. @@ -481,7 +481,7 @@ public static bool TryParse (ParserOptions options, string text, out GroupAddres /// Parses a single . If the address is not a group address or /// there is more than a single group address, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The text. /// The parsed group address. /// diff --git a/MimeKit/Header.cs b/MimeKit/Header.cs index 6a23a9b184..818a078d9c 100644 --- a/MimeKit/Header.cs +++ b/MimeKit/Header.cs @@ -309,7 +309,7 @@ protected Header (ParserOptions options, HeaderId id, string name, byte[] field, /// The raw header field. /// The length of the field name (not including trailing whitespace). /// The raw value of the header. - /// true if the header field is invalid; otherwise, false. + /// if the header field is invalid; otherwise, . #if NET5_0_OR_GREATER [System.Runtime.CompilerServices.SkipLocalsInit] #endif @@ -342,7 +342,7 @@ internal protected Header (ParserOptions options, byte[] field, int fieldNameLen /// The parser options used. /// The raw header field. /// The raw value of the header. - /// true if the header field is invalid; otherwise, false. + /// if the header field is invalid; otherwise, . #if NET5_0_OR_GREATER [System.Runtime.CompilerServices.SkipLocalsInit] #endif @@ -1307,7 +1307,7 @@ static byte[] EncodeUnstructuredHeader (ParserOptions options, FormatOptions for /// This method is called by the SetValue /// methods. /// This method should encode unicode characters according to the rules of rfc2047 (when - /// is false) as well as properly folding the + /// is ) as well as properly folding the /// value to conform with rfc5322. /// /// The formatting options. @@ -1734,7 +1734,7 @@ internal static unsafe bool TryParse (ParserOptions options, byte* input, int le /// Parses a header from the supplied buffer starting at the given index /// and spanning across the specified number of bytes. /// - /// true, if the header was successfully parsed, false otherwise. + /// if the header was successfully parsed; otherwise, . /// The parser options to use. /// The input buffer. /// The starting index of the input buffer. @@ -1767,7 +1767,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde /// Parses a header from the supplied buffer starting at the given index /// and spanning across the specified number of bytes. /// - /// true, if the header was successfully parsed, false otherwise. + /// if the header was successfully parsed; otherwise, . /// The input buffer. /// The starting index of the input buffer. /// The number of bytes in the input buffer to parse. @@ -1790,7 +1790,7 @@ public static bool TryParse (byte[] buffer, int startIndex, int length, out Head /// /// Parses a header from the supplied buffer starting at the specified index. /// - /// true, if the header was successfully parsed, false otherwise. + /// if the header was successfully parsed; otherwise, . /// The parser options to use. /// The input buffer. /// The starting index of the input buffer. @@ -1822,7 +1822,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde /// /// Parses a header from the supplied buffer starting at the specified index. /// - /// true, if the header was successfully parsed, false otherwise. + /// if the header was successfully parsed; otherwise, . /// The input buffer. /// The starting index of the input buffer. /// The parsed header. @@ -1843,7 +1843,7 @@ public static bool TryParse (byte[] buffer, int startIndex, out Header header) /// /// Parses a header from the specified buffer. /// - /// true, if the header was successfully parsed, false otherwise. + /// if the header was successfully parsed; otherwise, . /// The parser options to use. /// The input buffer. /// The parsed header. @@ -1863,7 +1863,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, out Header he /// /// Parses a header from the specified buffer. /// - /// true, if the header was successfully parsed, false otherwise. + /// if the header was successfully parsed; otherwise, . /// The input buffer. /// The parsed header. /// @@ -1880,7 +1880,7 @@ public static bool TryParse (byte[] buffer, out Header header) /// /// Parses a header from the specified text. /// - /// true, if the header was successfully parsed, false otherwise. + /// if the header was successfully parsed; otherwise, . /// The parser options to use. /// The text to parse. /// The parsed header. @@ -1908,7 +1908,7 @@ public static bool TryParse (ParserOptions options, string text, out Header head /// /// Parses a header from the specified text. /// - /// true, if the header was successfully parsed, false otherwise. + /// if the header was successfully parsed; otherwise, . /// The text to parse. /// The parsed header. /// diff --git a/MimeKit/HeaderList.cs b/MimeKit/HeaderList.cs index 0a831e062a..8185f0a2b2 100644 --- a/MimeKit/HeaderList.cs +++ b/MimeKit/HeaderList.cs @@ -160,8 +160,8 @@ public void Add (string field, Encoding encoding, string value) /// /// Determines whether the header list contains the specified header. /// - /// true if the requested header exists; - /// otherwise false. + /// if the requested header exists; + /// otherwise, . /// The header identifier. /// /// is not a valid . @@ -180,8 +180,8 @@ public bool Contains (HeaderId id) /// /// Determines whether the header list contains the specified header. /// - /// true if the requested header exists; - /// otherwise false. + /// if the requested header exists; + /// otherwise, . /// The name of the header field. /// /// is . @@ -396,8 +396,8 @@ public int LastIndexOf (string field) /// /// Removes the first occurrence of the specified header field, if any exist. /// - /// true if the first occurrence of the specified - /// header was removed; otherwise false. + /// if the first occurrence of the specified + /// header was removed; otherwise, . /// The header identifier. /// /// is is not a valid . @@ -419,8 +419,8 @@ public bool Remove (HeaderId id) /// /// Removes the first occurrence of the specified header field, if any exist. /// - /// true if the first occurrence of the specified - /// header was removed; otherwise false. + /// if the first occurrence of the specified + /// header was removed; otherwise, . /// The name of the header field. /// /// is . @@ -825,7 +825,7 @@ public int Count { /// /// A is never read-only. /// - /// true if this instance is read only; otherwise, false. + /// if this instance is read only; otherwise, . public bool IsReadOnly { get { return false; } } @@ -877,8 +877,8 @@ public void Clear () /// /// Determines whether the header list contains the specified header. /// - /// true if the specified header is contained; - /// otherwise, false. + /// if the specified header is contained; + /// otherwise, . /// The header. /// /// is . @@ -917,8 +917,8 @@ public void CopyTo (Header[] array, int arrayIndex) /// /// Removes the specified header from the list if it exists. /// - /// true if the specified header was removed; - /// otherwise false. + /// if the specified header was removed; + /// otherwise, . /// The header. /// /// is . diff --git a/MimeKit/HeaderListCollection.cs b/MimeKit/HeaderListCollection.cs index 420cb4d112..bb46f90154 100644 --- a/MimeKit/HeaderListCollection.cs +++ b/MimeKit/HeaderListCollection.cs @@ -69,7 +69,7 @@ public int Count { /// /// A is never read-only. /// - /// true if this instance is read only; otherwise, false. + /// if this instance is read only; otherwise, . public bool IsReadOnly { get { return false; } } @@ -152,8 +152,8 @@ public void Clear () /// /// Determines whether the collection contains the specified group of headers. /// - /// true if the specified group of headers is contained; - /// otherwise, false. + /// if the specified group of headers is contained; + /// otherwise, . /// The group of headers. /// /// is . @@ -192,8 +192,8 @@ public void CopyTo (HeaderList[] array, int arrayIndex) /// /// Removes the specified header group from the collection, if it exists. /// - /// true if the specified header group was removed; - /// otherwise false. + /// if the specified header group was removed; + /// otherwise, . /// The group of headers. /// /// is . diff --git a/MimeKit/IMimeEntity.cs b/MimeKit/IMimeEntity.cs index be78f5b96d..5c454f580a 100644 --- a/MimeKit/IMimeEntity.cs +++ b/MimeKit/IMimeEntity.cs @@ -150,10 +150,10 @@ string ContentId { /// /// /// If the Content-Disposition header is set and has a value of "attachment", - /// then this property returns true. Otherwise, it is assumed that the + /// then this property returns . Otherwise, it is assumed that the /// entity is not meant to be treated as an attachment. /// - /// true if this entity is an attachment; otherwise, false. + /// if this entity is an attachment; otherwise, . /// /// The has been disposed. /// @@ -203,7 +203,7 @@ bool IsAttachment { /// /// The formatting options. /// The output stream. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -231,7 +231,7 @@ bool IsAttachment { /// An awaitable task. /// The formatting options. /// The output stream. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -309,7 +309,7 @@ bool IsAttachment { /// Writes the entity to the output stream. /// /// The output stream. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -333,7 +333,7 @@ bool IsAttachment { /// /// An awaitable task. /// The output stream. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -402,7 +402,7 @@ bool IsAttachment { /// /// The formatting options. /// The file. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -442,7 +442,7 @@ bool IsAttachment { /// An awaitable task. /// The formatting options. /// The file. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -557,7 +557,7 @@ bool IsAttachment { /// Writes the entity to the specified file using the default formatting options. /// /// The file. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -594,7 +594,7 @@ bool IsAttachment { /// /// An awaitable task. /// The file. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . diff --git a/MimeKit/IMimeMessage.cs b/MimeKit/IMimeMessage.cs index 2d09de08fe..7ea3370846 100644 --- a/MimeKit/IMimeMessage.cs +++ b/MimeKit/IMimeMessage.cs @@ -500,7 +500,7 @@ IEnumerable Attachments { /// /// The formatting options. /// The output stream. - /// true if only the headers should be written; otherwise, false. + /// if only the headers should be written; otherwise, . /// The cancellation token. /// /// is . @@ -524,7 +524,7 @@ IEnumerable Attachments { /// An awaitable task. /// The formatting options. /// The output stream. - /// true if only the headers should be written; otherwise, false. + /// if only the headers should be written; otherwise, . /// The cancellation token. /// /// is . @@ -591,7 +591,7 @@ IEnumerable Attachments { /// Writes the message to the output stream using the default formatting options. /// /// The output stream. - /// true if only the headers should be written; otherwise, false. + /// if only the headers should be written; otherwise, . /// The cancellation token. /// /// is . @@ -612,7 +612,7 @@ IEnumerable Attachments { /// /// An awaitable task. /// The output stream. - /// true if only the headers should be written; otherwise, false. + /// if only the headers should be written; otherwise, . /// The cancellation token. /// /// is . diff --git a/MimeKit/IMimeParser.cs b/MimeKit/IMimeParser.cs index ff94991641..81f360da59 100644 --- a/MimeKit/IMimeParser.cs +++ b/MimeKit/IMimeParser.cs @@ -28,8 +28,8 @@ public interface IMimeParser /// /// Gets a value indicating whether the parser has reached the end of the input stream. /// - /// true if this parser has reached the end of the input stream; - /// otherwise, false. + /// if this parser has reached the end of the input stream; + /// otherwise, . bool IsEndOfStream { get; } /// @@ -64,7 +64,7 @@ public interface IMimeParser /// /// /// Sets the stream to parse. - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -74,7 +74,7 @@ public interface IMimeParser /// /// The stream to parse. /// The format of the stream. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// /// is . /// @@ -98,7 +98,7 @@ public interface IMimeParser /// /// /// Sets the stream to parse. - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -107,7 +107,7 @@ public interface IMimeParser /// for to read the content. /// /// The stream to parse. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// /// is . /// diff --git a/MimeKit/IMimePart.cs b/MimeKit/IMimePart.cs index 73bab3ab68..b3144fd502 100644 --- a/MimeKit/IMimePart.cs +++ b/MimeKit/IMimePart.cs @@ -216,10 +216,10 @@ IMimeContent Content { /// /// /// Computes the MD5 checksum of the MIME content and compares it with the - /// value in the Content-MD5 header, returning true if and only if + /// value in the Content-MD5 header, returning if and only if /// the values match. /// - /// true, if content MD5 checksum was verified, false otherwise. + /// if content MD5 checksum was verified; otherwise, . /// /// The has been disposed. /// diff --git a/MimeKit/IMultipartRelated.cs b/MimeKit/IMultipartRelated.cs index 2365427b09..8d9fef5b4b 100644 --- a/MimeKit/IMultipartRelated.cs +++ b/MimeKit/IMultipartRelated.cs @@ -71,7 +71,7 @@ MimeEntity Root { /// /// Determines whether the multipart/related entity contains a part matching the specified URI. /// - /// true if the specified part exists; otherwise false. + /// if the specified part exists; otherwise, . /// The URI of the MIME part. /// /// is . diff --git a/MimeKit/IO/BoundStream.cs b/MimeKit/IO/BoundStream.cs index 3c89c2ef5e..456b5c343d 100644 --- a/MimeKit/IO/BoundStream.cs +++ b/MimeKit/IO/BoundStream.cs @@ -55,8 +55,8 @@ public class BoundStream : Stream /// The underlying stream. /// The offset in the base stream that will mark the start of this substream. /// The offset in the base stream that will mark the end of this substream. - /// true to leave the baseStream open after the - /// is disposed; otherwise, false. + /// to leave the baseStream open after the + /// is disposed; otherwise, . /// /// is . /// @@ -129,8 +129,8 @@ public long EndBoundary { /// Checks whether the underlying stream will remain open after /// the is disposed. /// - /// true if the underlying stream should remain open after the - /// is disposed; otherwise, false. + /// if the underlying stream should remain open after the + /// is disposed; otherwise, . protected bool LeaveOpen { get; private set; } @@ -168,7 +168,7 @@ void CheckCanWrite () /// The will only support reading if the /// supports it. /// - /// true if the stream supports reading; otherwise, false. + /// if the stream supports reading; otherwise, . public override bool CanRead { get { return BaseStream.CanRead; } } @@ -180,7 +180,7 @@ public override bool CanRead { /// The will only support writing if the /// supports it. /// - /// true if the stream supports writing; otherwise, false. + /// if the stream supports writing; otherwise, . public override bool CanWrite { get { return BaseStream.CanWrite; } } @@ -192,7 +192,7 @@ public override bool CanWrite { /// The will only support seeking if the /// supports it. /// - /// true if the stream supports seeking; otherwise, false. + /// if the stream supports seeking; otherwise, . public override bool CanSeek { get { return BaseStream.CanSeek; } } @@ -204,7 +204,7 @@ public override bool CanSeek { /// The will only support timing out if the /// supports it. /// - /// true if I/O operations can time out; otherwise, false. + /// if I/O operations can time out; otherwise, . public override bool CanTimeout { get { return BaseStream.CanTimeout; } } @@ -699,11 +699,11 @@ public override void SetLength (long value) /// optionally releases the managed resources. /// /// - /// If the property is false, then + /// If the property is , then /// the is also disposed. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected override void Dispose (bool disposing) { if (disposing && !LeaveOpen) diff --git a/MimeKit/IO/ChainedStream.cs b/MimeKit/IO/ChainedStream.cs index d3d208b6a9..ec387b139f 100644 --- a/MimeKit/IO/ChainedStream.cs +++ b/MimeKit/IO/ChainedStream.cs @@ -67,9 +67,9 @@ public ChainedStream () /// Adds the stream to the end of the chain. /// /// The stream. - /// true if the + /// if the /// should remain open after the is disposed; - /// otherwise, false. + /// otherwise, . /// /// is . /// @@ -114,7 +114,7 @@ void CheckCanWrite () /// The only supports reading if all of its /// streams support it. /// - /// true if the stream supports reading; otherwise, false. + /// if the stream supports reading; otherwise, . public override bool CanRead { get { foreach (var stream in streams) { @@ -133,7 +133,7 @@ public override bool CanRead { /// The only supports writing if all of its /// streams support it. /// - /// true if the stream supports writing; otherwise, false. + /// if the stream supports writing; otherwise, . public override bool CanWrite { get { foreach (var stream in streams) { @@ -152,7 +152,7 @@ public override bool CanWrite { /// The only supports seeking if all of its /// streams support it. /// - /// true if the stream supports seeking; otherwise, false. + /// if the stream supports seeking; otherwise, . public override bool CanSeek { get { foreach (var stream in streams) { @@ -171,7 +171,7 @@ public override bool CanSeek { /// The only supports timeouts if all of its /// streams support them. /// - /// true if I/O operations can time out; otherwise, false. + /// if I/O operations can time out; otherwise, . public override bool CanTimeout { get { return false; } } @@ -686,8 +686,8 @@ public override void SetLength (long value) /// Releases the unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected override void Dispose (bool disposing) { if (disposing && !disposed) { diff --git a/MimeKit/IO/FilteredStream.cs b/MimeKit/IO/FilteredStream.cs index 0bdd686635..785671cb0b 100644 --- a/MimeKit/IO/FilteredStream.cs +++ b/MimeKit/IO/FilteredStream.cs @@ -115,8 +115,8 @@ public void Add (IMimeFilter filter) /// /// Determines whether the filtered stream contains the specified filter. /// - /// true if the specified filter exists; - /// otherwise false. + /// if the specified filter exists; + /// otherwise, . /// The filter. /// /// is . @@ -135,7 +135,7 @@ public bool Contains (IMimeFilter filter) /// /// Removes the specified filter from the list if it exists. /// - /// true if the filter was removed; otherwise false. + /// if the filter was removed; otherwise, . /// The filter. /// /// is . @@ -175,7 +175,7 @@ void CheckCanWrite () /// The will only support reading if the /// supports it. /// - /// true if the stream supports reading; otherwise, false. + /// if the stream supports reading; otherwise, . public override bool CanRead { get { return Source.CanRead; } } @@ -187,7 +187,7 @@ public override bool CanRead { /// The will only support writing if the /// supports it. /// - /// true if the stream supports writing; otherwise, false. + /// if the stream supports writing; otherwise, . public override bool CanWrite { get { return Source.CanWrite; } } @@ -198,7 +198,7 @@ public override bool CanWrite { /// /// Seeking is not supported by the . /// - /// true if the stream supports seeking; otherwise, false. + /// if the stream supports seeking; otherwise, . public override bool CanSeek { get { return false; } } @@ -210,7 +210,7 @@ public override bool CanSeek { /// The will only support timing out if the /// supports it. /// - /// true if I/O operations can time out; otherwise, false. + /// if I/O operations can time out; otherwise, . public override bool CanTimeout { get { return Source.CanTimeout; } } @@ -786,8 +786,8 @@ public override void SetLength (long value) /// Releases the unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected override void Dispose (bool disposing) { if (disposing) { diff --git a/MimeKit/IO/Filters/ArmoredFromFilter.cs b/MimeKit/IO/Filters/ArmoredFromFilter.cs index da426f2c39..f64900c01c 100644 --- a/MimeKit/IO/Filters/ArmoredFromFilter.cs +++ b/MimeKit/IO/Filters/ArmoredFromFilter.cs @@ -79,7 +79,7 @@ static bool StartsWithFrom (byte[] input, int startIndex, int endIndex) /// The length of the input buffer, starting at . /// The output index. /// The output length. - /// If set to true, all internally buffered data should be flushed to the output buffer. + /// If set to , all internally buffered data should be flushed to the output buffer. protected override byte[] Filter (byte[] input, int startIndex, int length, out int outputIndex, out int outputLength, bool flush) { var fromOffsets = new List (); diff --git a/MimeKit/IO/Filters/CharsetFilter.cs b/MimeKit/IO/Filters/CharsetFilter.cs index 9e76424fe7..604e654c86 100644 --- a/MimeKit/IO/Filters/CharsetFilter.cs +++ b/MimeKit/IO/Filters/CharsetFilter.cs @@ -164,7 +164,7 @@ public Encoding TargetEncoding { /// The length of the input buffer, starting at . /// The output index. /// The output length. - /// If set to true, all internally buffered data should be flushed to the output buffer. + /// If set to , all internally buffered data should be flushed to the output buffer. protected override byte[] Filter (byte[] input, int startIndex, int length, out int outputIndex, out int outputLength, bool flush) { int inputIndex = startIndex; diff --git a/MimeKit/IO/Filters/DecoderFilter.cs b/MimeKit/IO/Filters/DecoderFilter.cs index 69b504d16e..d6561bbc81 100644 --- a/MimeKit/IO/Filters/DecoderFilter.cs +++ b/MimeKit/IO/Filters/DecoderFilter.cs @@ -131,7 +131,7 @@ public static IMimeFilter Create (string name) /// The length of the input buffer, starting at . /// The output index. /// The output length. - /// If set to true, all internally buffered data should be flushed to the output buffer. + /// If set to , all internally buffered data should be flushed to the output buffer. protected override byte[] Filter (byte[] input, int startIndex, int length, out int outputIndex, out int outputLength, bool flush) { EnsureOutputSize (Decoder.EstimateOutputLength (length), false); diff --git a/MimeKit/IO/Filters/Dos2UnixFilter.cs b/MimeKit/IO/Filters/Dos2UnixFilter.cs index d0d722a6ff..aada5255d2 100644 --- a/MimeKit/IO/Filters/Dos2UnixFilter.cs +++ b/MimeKit/IO/Filters/Dos2UnixFilter.cs @@ -89,7 +89,7 @@ int Filter (ReadOnlySpan input, byte[] output, bool flush) /// The length of the input buffer, starting at . /// The output index. /// The output length. - /// If set to true, all internally buffered data should be flushed to the output buffer. + /// If set to , all internally buffered data should be flushed to the output buffer. protected override byte[] Filter (byte[] input, int startIndex, int length, out int outputIndex, out int outputLength, bool flush) { if (pc == (byte) '\r') diff --git a/MimeKit/IO/Filters/EncoderFilter.cs b/MimeKit/IO/Filters/EncoderFilter.cs index c4555d6270..381a05085f 100644 --- a/MimeKit/IO/Filters/EncoderFilter.cs +++ b/MimeKit/IO/Filters/EncoderFilter.cs @@ -139,7 +139,7 @@ public static IMimeFilter Create (string name, int maxLineLength = 78) /// The length of the input buffer, starting at . /// The output index. /// The output length. - /// If set to true, all internally buffered data should be flushed to the output buffer. + /// If set to , all internally buffered data should be flushed to the output buffer. protected override byte[] Filter (byte[] input, int startIndex, int length, out int outputIndex, out int outputLength, bool flush) { EnsureOutputSize (Encoder.EstimateOutputLength (length), false); diff --git a/MimeKit/IO/Filters/MboxFromFilter.cs b/MimeKit/IO/Filters/MboxFromFilter.cs index 63fa5fadab..938d2ab237 100644 --- a/MimeKit/IO/Filters/MboxFromFilter.cs +++ b/MimeKit/IO/Filters/MboxFromFilter.cs @@ -74,7 +74,7 @@ static bool StartsWithFrom (byte[] input, int startIndex, int endIndex) /// The length of the input buffer, starting at . /// The output index. /// The output length. - /// If set to true, all internally buffered data should be flushed to the output buffer. + /// If set to , all internally buffered data should be flushed to the output buffer. protected override byte[] Filter (byte[] input, int startIndex, int length, out int outputIndex, out int outputLength, bool flush) { var fromOffsets = new List (); diff --git a/MimeKit/IO/Filters/MimeFilterBase.cs b/MimeKit/IO/Filters/MimeFilterBase.cs index 768da844b6..a852b6bb22 100644 --- a/MimeKit/IO/Filters/MimeFilterBase.cs +++ b/MimeKit/IO/Filters/MimeFilterBase.cs @@ -74,7 +74,7 @@ protected byte[] OutputBuffer { /// The length of the input buffer, starting at . /// The output index. /// The output length. - /// If set to true, all internally buffered data should be flushed to the output buffer. + /// If set to , all internally buffered data should be flushed to the output buffer. protected abstract byte[] Filter (byte[] input, int startIndex, int length, out int outputIndex, out int outputLength, bool flush); static int GetIdealBufferSize (int need) @@ -218,7 +218,7 @@ protected void SaveRemainingInput (byte[] input, int startIndex, int length) /// Ensures that the output buffer is greater than or equal to the specified size. /// /// The minimum size needed. - /// If set to true, the current output should be preserved. + /// If set to , the current output should be preserved. protected void EnsureOutputSize (int size, bool keep) { int outputSize = output != null ? output.Length : -1; diff --git a/MimeKit/IO/Filters/TrailingWhitespaceFilter.cs b/MimeKit/IO/Filters/TrailingWhitespaceFilter.cs index 2eb215e041..63daa6c61a 100644 --- a/MimeKit/IO/Filters/TrailingWhitespaceFilter.cs +++ b/MimeKit/IO/Filters/TrailingWhitespaceFilter.cs @@ -94,7 +94,7 @@ int Filter (ReadOnlySpan input, byte[] output) /// The length of the input buffer, starting at . /// The output index. /// The output length. - /// If set to true, all internally buffered data should be flushed to the output buffer. + /// If set to , all internally buffered data should be flushed to the output buffer. protected override byte[] Filter (byte[] input, int startIndex, int length, out int outputIndex, out int outputLength, bool flush) { if (length == 0) { diff --git a/MimeKit/IO/Filters/Unix2DosFilter.cs b/MimeKit/IO/Filters/Unix2DosFilter.cs index 629b072052..f950802b56 100644 --- a/MimeKit/IO/Filters/Unix2DosFilter.cs +++ b/MimeKit/IO/Filters/Unix2DosFilter.cs @@ -91,7 +91,7 @@ int Filter (ReadOnlySpan input, byte[] output, bool flush) /// The length of the input buffer, starting at . /// The output index. /// The output length. - /// If set to true, all internally buffered data should be flushed to the output buffer. + /// If set to , all internally buffered data should be flushed to the output buffer. protected override byte[] Filter (byte[] input, int startIndex, int length, out int outputIndex, out int outputLength, bool flush) { EnsureOutputSize (length * 2 + (flush && ensureNewLine ? 2 : 0), false); diff --git a/MimeKit/IO/MeasuringStream.cs b/MimeKit/IO/MeasuringStream.cs index 1ebec56940..88d23b35ee 100644 --- a/MimeKit/IO/MeasuringStream.cs +++ b/MimeKit/IO/MeasuringStream.cs @@ -69,7 +69,7 @@ void CheckDisposed () /// /// A is not readable. /// - /// true if the stream supports reading; otherwise, false. + /// if the stream supports reading; otherwise, . public override bool CanRead { get { return false; } } @@ -80,7 +80,7 @@ public override bool CanRead { /// /// A is always writable. /// - /// true if the stream supports writing; otherwise, false. + /// if the stream supports writing; otherwise, . public override bool CanWrite { get { return true; } } @@ -91,7 +91,7 @@ public override bool CanWrite { /// /// A is always seekable. /// - /// true if the stream supports seeking; otherwise, false. + /// if the stream supports seeking; otherwise, . public override bool CanSeek { get { return true; } } @@ -102,7 +102,7 @@ public override bool CanSeek { /// /// Writing to a cannot timeout. /// - /// true if reading and writing to the stream can time out; otherwise, false. + /// if reading and writing to the stream can time out; otherwise, . public override bool CanTimeout { get { return false; } } @@ -416,8 +416,8 @@ public override void SetLength (long value) /// Releases the unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected override void Dispose (bool disposing) { base.Dispose (disposing); diff --git a/MimeKit/IO/MemoryBlockStream.cs b/MimeKit/IO/MemoryBlockStream.cs index 5107519021..976b239010 100644 --- a/MimeKit/IO/MemoryBlockStream.cs +++ b/MimeKit/IO/MemoryBlockStream.cs @@ -113,7 +113,7 @@ void CheckDisposed () /// /// The is always readable. /// - /// true if the stream supports reading; otherwise, false. + /// if the stream supports reading; otherwise, . public override bool CanRead { get { return true; } } @@ -124,7 +124,7 @@ public override bool CanRead { /// /// The is always writable. /// - /// true if the stream supports writing; otherwise, false. + /// if the stream supports writing; otherwise, . public override bool CanWrite { get { return true; } } @@ -135,7 +135,7 @@ public override bool CanWrite { /// /// The is always seekable. /// - /// true if the stream supports seeking; otherwise, false. + /// if the stream supports seeking; otherwise, . public override bool CanSeek { get { return true; } } @@ -146,7 +146,7 @@ public override bool CanSeek { /// /// The does not support timing out. /// - /// true if reading and writing to the stream can time out; otherwise, false. + /// if reading and writing to the stream can time out; otherwise, . public override bool CanTimeout { get { return false; } } @@ -552,8 +552,8 @@ public override void SetLength (long value) /// Releases the unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected override void Dispose (bool disposing) { if (disposing && !disposed) { diff --git a/MimeKit/ITextPart.cs b/MimeKit/ITextPart.cs index 46546df930..eac2476504 100644 --- a/MimeKit/ITextPart.cs +++ b/MimeKit/ITextPart.cs @@ -65,7 +65,7 @@ TextFormat Format { /// Checks whether the text part's Content-Type is text/enriched or its /// predecessor, text/richtext (not to be confused with text/rtf). /// - /// true if the text is enriched; otherwise, false. + /// if the text is enriched; otherwise, . /// /// The has been disposed. /// @@ -83,7 +83,7 @@ bool IsEnriched { /// /// /// - /// true if the text is flowed; otherwise, false. + /// if the text is flowed; otherwise, . /// /// The has been disposed. /// @@ -100,7 +100,7 @@ bool IsFlowed { /// /// /// - /// true if the text is html; otherwise, false. + /// if the text is html; otherwise, . /// /// The has been disposed. /// @@ -114,7 +114,7 @@ bool IsHtml { /// /// Checks whether the text part's Content-Type is text/plain. /// - /// true if the text is html; otherwise, false. + /// if the text is html; otherwise, . /// /// The has been disposed. /// @@ -128,7 +128,7 @@ bool IsPlain { /// /// Checks whether the text part's Content-Type is text/rtf. /// - /// true if the text is RTF; otherwise, false. + /// if the text is RTF; otherwise, . /// /// The has been disposed. /// @@ -174,7 +174,7 @@ string Text { /// is set to the encoding for the specified charset and is /// set to . /// - /// true if an encoding was detected; otherwise, false. + /// if an encoding was detected; otherwise, . /// The detected encoding; otherwise, . /// The confidence in the detected encoding being correct. /// diff --git a/MimeKit/InternetAddress.cs b/MimeKit/InternetAddress.cs index de4d972f90..df6c57d22a 100644 --- a/MimeKit/InternetAddress.cs +++ b/MimeKit/InternetAddress.cs @@ -204,8 +204,8 @@ public int CompareTo (InternetAddress other) /// Compares two internet addresses to determine if they are identical or not. /// /// The to compare with the current . - /// true if the specified is equal to the current - /// ; otherwise, false. + /// if the specified is equal to the current + /// ; otherwise, . public abstract bool Equals (InternetAddress other); #endregion @@ -218,7 +218,7 @@ public int CompareTo (InternetAddress other) /// the current instance is a reference type or a value type. /// /// The object to compare with the current object. - /// true if the specified object is equal to the current object; otherwise, false. + /// if the specified object is equal to the current object; otherwise, . public override bool Equals (object obj) { return Equals (obj as InternetAddress); @@ -252,14 +252,14 @@ internal static string EncodeInternationalizedPhrase (string phrase) /// Serialize an to a string, optionally encoding it for transport. /// /// - /// If the parameter is true, then this method will return + /// If the parameter is , then this method will return /// an encoded version of the internet address according to the rules described in rfc2047. - /// However, if the parameter is false, then this method will + /// However, if the parameter is , then this method will /// return a string suitable only for display purposes. /// /// A string representing the . /// The formatting options. - /// If set to true, the will be encoded. + /// If set to , the will be encoded. /// /// is . /// @@ -269,13 +269,13 @@ internal static string EncodeInternationalizedPhrase (string phrase) /// Serialize an to a string, optionally encoding it for transport. /// /// - /// If the parameter is true, then this method will return + /// If the parameter is , then this method will return /// an encoded version of the internet address according to the rules described in rfc2047. - /// However, if the parameter is false, then this method will + /// However, if the parameter is , then this method will /// return a string suitable only for display purposes. /// /// A string representing the . - /// If set to true, the will be encoded. + /// If set to , the will be encoded. public string ToString (bool encode) { return ToString (FormatOptions.Default, encode); @@ -896,7 +896,7 @@ internal static bool TryParse (AddressParserFlags flags, ParserOptions options, /// Parses a single or . If the buffer contains /// more data, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The parser options to use. /// The input buffer. /// The starting index of the input buffer. @@ -941,7 +941,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde /// Parses a single or . If the buffer contains /// more data, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The input buffer. /// The starting index of the input buffer. /// The number of bytes in the input buffer to parse. @@ -965,7 +965,7 @@ public static bool TryParse (byte[] buffer, int startIndex, int length, out Inte /// Parses a single or . If the buffer contains /// more data, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The parser options to use. /// The input buffer. /// The starting index of the input buffer. @@ -1003,7 +1003,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde /// Parses a single or . If the buffer contains /// more data, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The input buffer. /// The starting index of the input buffer. /// The parsed address. @@ -1025,7 +1025,7 @@ public static bool TryParse (byte[] buffer, int startIndex, out InternetAddress /// Parses a single or . If the buffer contains /// more data, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The parser options to use. /// The input buffer. /// The parsed address. @@ -1059,7 +1059,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, out InternetA /// Parses a single or . If the buffer contains /// more data, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The input buffer. /// The parsed address. /// @@ -1077,7 +1077,7 @@ public static bool TryParse (byte[] buffer, out InternetAddress address) /// Parses a single or . If the text contains /// more data, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The parser options to use. /// The text. /// The parsed address. @@ -1110,7 +1110,7 @@ public static bool TryParse (ParserOptions options, string text, out InternetAdd /// Parses a single or . If the text contains /// more data, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The text. /// The parsed address. /// diff --git a/MimeKit/InternetAddressList.cs b/MimeKit/InternetAddressList.cs index a5485ef8a4..87eb4a8f27 100644 --- a/MimeKit/InternetAddressList.cs +++ b/MimeKit/InternetAddressList.cs @@ -248,7 +248,7 @@ public int Count { /// /// A is never read-only. /// - /// true if this instance is read only; otherwise, false. + /// if this instance is read only; otherwise, . public bool IsReadOnly { get { return false; } } @@ -324,8 +324,8 @@ public void Clear () /// /// Determines whether the address list contains the specified address. /// - /// true if the specified address exists; - /// otherwise false. + /// if the specified address exists; + /// otherwise, . /// The address. /// /// is . @@ -364,7 +364,7 @@ public void CopyTo (InternetAddress[] array, int arrayIndex) /// /// Removes the specified address. /// - /// true if the address was removed; otherwise false. + /// if the address was removed; otherwise, . /// The address. /// /// is . @@ -426,8 +426,8 @@ IEnumerator IEnumerable.GetEnumerator () /// Determines whether the specified is equal to the current . /// /// The to compare with the current . - /// true if the specified is equal to the current - /// ; otherwise, false. + /// if the specified is equal to the current + /// ; otherwise, . public bool Equals (InternetAddressList other) { if (other is null) @@ -484,7 +484,7 @@ public int CompareTo (InternetAddressList other) /// the current instance is a reference type or a value type. /// /// The object to compare with the current object. - /// true if the specified object is equal to the current object; otherwise, false. + /// if the specified object is equal to the current object; otherwise, . public override bool Equals (object obj) { return Equals (obj as InternetAddressList); @@ -518,13 +518,13 @@ internal void Encode (FormatOptions options, StringBuilder builder, bool firstTo /// Serialize an to a string, optionally encoding the list of addresses for transport. /// /// - /// If is true, each address in the list will be encoded + /// If is , each address in the list will be encoded /// according to the rules defined in rfc2047. /// If there are multiple addresses in the list, they will be separated by a comma. /// /// A string representing the . /// The formatting options. - /// If set to true, each in the list will be encoded. + /// If set to , each in the list will be encoded. public string ToString (FormatOptions options, bool encode) { var builder = new StringBuilder (); @@ -551,12 +551,12 @@ public string ToString (FormatOptions options, bool encode) /// Serialize an to a string, optionally encoding the list of addresses for transport. /// /// - /// If is true, each address in the list will be encoded + /// If is , each address in the list will be encoded /// according to the rules defined in rfc2047. /// If there are multiple addresses in the list, they will be separated by a comma. /// /// A string representing the . - /// If set to true, each in the list will be encoded. + /// If set to , each in the list will be encoded. public string ToString (bool encode) { return ToString (FormatOptions.Default, encode); @@ -644,7 +644,7 @@ internal static bool TryParse (AddressParserFlags flags, ParserOptions options, /// Parses a list of addresses from the supplied buffer starting at the given index /// and spanning across the specified number of bytes. /// - /// true, if the address list was successfully parsed, false otherwise. + /// if the address list was successfully parsed; otherwise, . /// The parser options to use. /// The input buffer. /// The starting index of the input buffer. @@ -682,7 +682,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde /// Parses a list of addresses from the supplied buffer starting at the given index /// and spanning across the specified number of bytes. /// - /// true, if the address list was successfully parsed, false otherwise. + /// if the address list was successfully parsed; otherwise, . /// The input buffer. /// The starting index of the input buffer. /// The number of bytes in the input buffer to parse. @@ -705,7 +705,7 @@ public static bool TryParse (byte[] buffer, int startIndex, int length, out Inte /// /// Parses a list of addresses from the supplied buffer starting at the specified index. /// - /// true, if the address list was successfully parsed, false otherwise. + /// if the address list was successfully parsed; otherwise, . /// The parser options to use. /// The input buffer. /// The starting index of the input buffer. @@ -740,7 +740,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde /// /// Parses a list of addresses from the supplied buffer starting at the specified index. /// - /// true, if the address list was successfully parsed, false otherwise. + /// if the address list was successfully parsed; otherwise, . /// The input buffer. /// The starting index of the input buffer. /// The parsed addresses. @@ -761,7 +761,7 @@ public static bool TryParse (byte[] buffer, int startIndex, out InternetAddressL /// /// Parses a list of addresses from the specified buffer. /// - /// true, if the address list was successfully parsed, false otherwise. + /// if the address list was successfully parsed; otherwise, . /// The parser options to use. /// The input buffer. /// The parsed addresses. @@ -792,7 +792,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, out InternetA /// /// Parses a list of addresses from the specified buffer. /// - /// true, if the address list was successfully parsed, false otherwise. + /// if the address list was successfully parsed; otherwise, . /// The input buffer. /// The parsed addresses. /// @@ -809,7 +809,7 @@ public static bool TryParse (byte[] buffer, out InternetAddressList addresses) /// /// Parses a list of addresses from the specified text. /// - /// true, if the address list was successfully parsed, false otherwise. + /// if the address list was successfully parsed; otherwise, . /// The parser options to use. /// The text. /// The parsed addresses. @@ -841,7 +841,7 @@ public static bool TryParse (ParserOptions options, string text, out InternetAdd /// /// Parses a list of addresses from the specified text. /// - /// true, if the address list was successfully parsed, false otherwise. + /// if the address list was successfully parsed; otherwise, . /// The text. /// The parsed addresses. /// diff --git a/MimeKit/MailboxAddress.cs b/MimeKit/MailboxAddress.cs index 3d519c95da..fe4628fd3d 100644 --- a/MimeKit/MailboxAddress.cs +++ b/MimeKit/MailboxAddress.cs @@ -285,7 +285,7 @@ public string Domain { /// For more information, see section 3.2 of /// rfc6532. /// - /// true if the address is an international address; otherwise, false. + /// if the address is an international address; otherwise, . public bool IsInternational { get { if (string.IsNullOrEmpty (address)) @@ -381,9 +381,9 @@ public static string DecodeAddrspec (string addrspec) /// Get the mailbox address, optionally encoded according to IDN encoding rules. /// /// - /// If is true, then the returned mailbox address will be encoded according to the IDN encoding rules. + /// If is , then the returned mailbox address will be encoded according to the IDN encoding rules. /// - /// true if the address should be encoded according to IDN encoding rules; otherwise, false. + /// if the address should be encoded according to IDN encoding rules; otherwise, . /// The mailbox address. public string GetAddress (bool idnEncode) { @@ -480,13 +480,13 @@ internal override void Encode (FormatOptions options, StringBuilder builder, boo /// /// /// Returns a string containing the formatted mailbox address. If the - /// parameter is true, then the mailbox name will be encoded according to the rules defined + /// parameter is , then the mailbox name will be encoded according to the rules defined /// in rfc2047, otherwise the name will not be encoded at all and will therefor only be suitable /// for display purposes. /// /// A string representing the . /// The formatting options. - /// If set to true, the will be encoded. + /// If set to , the will be encoded. /// /// is . /// @@ -526,8 +526,8 @@ public override string ToString (FormatOptions options, bool encode) /// Compares two mailbox addresses to determine if they are identical or not. /// /// The to compare with the current . - /// true if the specified is equal to the current - /// ; otherwise, false. + /// if the specified is equal to the current + /// ; otherwise, . public override bool Equals (InternetAddress other) { return other is MailboxAddress mailbox @@ -566,7 +566,7 @@ internal static bool TryParse (ParserOptions options, byte[] text, ref int index /// Parses a single . If the address is not a mailbox address or /// there is more than a single mailbox address, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The parser options to use. /// The input buffer. /// The starting index of the input buffer. @@ -606,7 +606,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde /// Parses a single . If the address is not a mailbox address or /// there is more than a single mailbox address, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The input buffer. /// The starting index of the input buffer. /// The number of bytes in the input buffer to parse. @@ -630,7 +630,7 @@ public static bool TryParse (byte[] buffer, int startIndex, int length, out Mail /// Parses a single . If the address is not a mailbox address or /// there is more than a single mailbox address, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The parser options to use. /// The input buffer. /// The starting index of the input buffer. @@ -668,7 +668,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, int startInde /// Parses a single . If the address is not a mailbox address or /// there is more than a single mailbox address, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The input buffer. /// The starting index of the input buffer. /// The parsed mailbox address. @@ -690,7 +690,7 @@ public static bool TryParse (byte[] buffer, int startIndex, out MailboxAddress m /// Parses a single . If the address is not a mailbox address or /// there is more than a single mailbox address, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The parser options to use. /// The input buffer. /// The parsed mailbox address. @@ -724,7 +724,7 @@ public static bool TryParse (ParserOptions options, byte[] buffer, out MailboxAd /// Parses a single . If the address is not a mailbox address or /// there is more than a single mailbox address, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The input buffer. /// The parsed mailbox address. /// @@ -742,7 +742,7 @@ public static bool TryParse (byte[] buffer, out MailboxAddress mailbox) /// Parses a single . If the address is not a mailbox address or /// there is more than a single mailbox address, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The parser options to use. /// The text. /// The parsed mailbox address. @@ -779,7 +779,7 @@ public static bool TryParse (ParserOptions options, string text, out MailboxAddr /// Parses a single . If the address is not a mailbox address or /// there is more than a single mailbox address, then parsing will fail. /// - /// true, if the address was successfully parsed, false otherwise. + /// if the address was successfully parsed; otherwise, . /// The text. /// The parsed mailbox address. /// diff --git a/MimeKit/MessageIdList.cs b/MimeKit/MessageIdList.cs index a36ceea552..d7f6037125 100644 --- a/MimeKit/MessageIdList.cs +++ b/MimeKit/MessageIdList.cs @@ -228,8 +228,8 @@ public void Clear () /// /// Determines whether the list contains the specified Message-Id. /// - /// true if the specified Message-Id is contained; - /// otherwise false. + /// if the specified Message-Id is contained; + /// otherwise, . /// The Message-Id. /// /// is . @@ -268,8 +268,8 @@ public void CopyTo (string[] array, int arrayIndex) /// /// Removes the first instance of the specified Message-Id from the list if it exists. /// - /// true if the specified Message-Id was removed; - /// otherwise false. + /// if the specified Message-Id was removed; + /// otherwise, . /// The Message-Id. /// /// is . @@ -304,7 +304,7 @@ public int Count { /// /// A is never read-only. /// - /// true if this instance is read only; otherwise, false. + /// if this instance is read only; otherwise, . public bool IsReadOnly { get { return false; } } diff --git a/MimeKit/MessagePart.cs b/MimeKit/MessagePart.cs index 4424df8505..235f1cb104 100644 --- a/MimeKit/MessagePart.cs +++ b/MimeKit/MessagePart.cs @@ -217,7 +217,7 @@ public override void Prepare (EncodingConstraint constraint, int maxLineLength = /// /// The formatting options. /// The output stream. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -265,7 +265,7 @@ public override void WriteTo (FormatOptions options, Stream stream, bool content /// An awaitable task. /// The formatting options. /// The output stream. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -307,8 +307,8 @@ public override async Task WriteToAsync (FormatOptions options, Stream stream, b /// Releases the unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected override void Dispose (bool disposing) { if (disposing && Message != null) diff --git a/MimeKit/MimeContent.cs b/MimeKit/MimeContent.cs index 7e6ea330b0..89452c9475 100644 --- a/MimeKit/MimeContent.cs +++ b/MimeKit/MimeContent.cs @@ -379,8 +379,8 @@ public async Task DecodeToAsync (Stream stream, CancellationToken cancellationTo /// Releases the unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected virtual void Dispose (bool disposing) { if (disposing && Stream != null) { diff --git a/MimeKit/MimeEntity.cs b/MimeKit/MimeEntity.cs index 0d42b1b354..c7cf48b4c4 100644 --- a/MimeKit/MimeEntity.cs +++ b/MimeKit/MimeEntity.cs @@ -178,7 +178,7 @@ void CheckDisposed () /// Initializes the appropriate property based on the type of the object. /// /// The object. - /// true if the object was recognized and used; false otherwise. + /// if the object was recognized and used; otherwise, . protected bool TryInit (object obj) { // The base MimeEntity class only knows about Headers. @@ -442,10 +442,10 @@ public string ContentId { /// /// /// If the Content-Disposition header is set and has a value of "attachment", - /// then this property returns true. Otherwise, it is assumed that the + /// then this property returns . Otherwise, it is assumed that the /// is not meant to be treated as an attachment. /// - /// true if this is an attachment; otherwise, false. + /// if this is an attachment; otherwise, . /// /// The has been disposed. /// @@ -552,7 +552,7 @@ public virtual void Accept (MimeVisitor visitor) /// /// The formatting options. /// The output stream. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -592,7 +592,7 @@ public virtual void WriteTo (FormatOptions options, Stream stream, bool contentO /// An awaitable task. /// The formatting options. /// The output stream. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -690,7 +690,7 @@ public Task WriteToAsync (FormatOptions options, Stream stream, CancellationToke /// Writes the entity to the output stream. /// /// The output stream. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -717,7 +717,7 @@ public void WriteTo (Stream stream, bool contentOnly, CancellationToken cancella /// /// An awaitable task. /// The output stream. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -795,7 +795,7 @@ public Task WriteToAsync (Stream stream, CancellationToken cancellationToken = d /// /// The formatting options. /// The file. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -847,7 +847,7 @@ public void WriteTo (FormatOptions options, string fileName, bool contentOnly, C /// An awaitable task. /// The formatting options. /// The file. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -980,7 +980,7 @@ public Task WriteToAsync (FormatOptions options, string fileName, CancellationTo /// Writes the entity to the specified file using the default formatting options. /// /// The file. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -1020,7 +1020,7 @@ public void WriteTo (string fileName, bool contentOnly, CancellationToken cancel /// /// An awaitable task. /// The file. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -1284,8 +1284,8 @@ void HeadersChanged (object sender, HeaderListChangedEventArgs e) /// Releases the unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected virtual void Dispose (bool disposing) { } @@ -1312,7 +1312,7 @@ public void Dispose () /// /// Loads a from the given stream, using the /// specified . - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save mmeory usage, but also improve @@ -1321,7 +1321,7 @@ public void Dispose () /// The parsed MIME entity. /// The parser options. /// The stream. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// The cancellation token. /// /// is . @@ -1356,7 +1356,7 @@ public static MimeEntity Load (ParserOptions options, Stream stream, bool persis /// /// Loads a from the given stream, using the /// specified . - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save mmeory usage, but also improve @@ -1365,7 +1365,7 @@ public static MimeEntity Load (ParserOptions options, Stream stream, bool persis /// The parsed MIME entity. /// The parser options. /// The stream. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// The cancellation token. /// /// is . @@ -1460,7 +1460,7 @@ public static Task LoadAsync (ParserOptions options, Stream stream, /// /// Loads a from the given stream, using the /// default . - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save mmeory usage, but also improve @@ -1468,7 +1468,7 @@ public static Task LoadAsync (ParserOptions options, Stream stream, /// /// The parsed MIME entity. /// The stream. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// The cancellation token. /// /// is . @@ -1493,7 +1493,7 @@ public static MimeEntity Load (Stream stream, bool persistent, CancellationToken /// /// Loads a from the given stream, using the /// default . - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -1501,7 +1501,7 @@ public static MimeEntity Load (Stream stream, bool persistent, CancellationToken /// /// The parsed MIME entity. /// The stream. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// The cancellation token. /// /// is . diff --git a/MimeKit/MimeIterator.cs b/MimeKit/MimeIterator.cs index 7fa35f464a..5ecb5f1437 100644 --- a/MimeKit/MimeIterator.cs +++ b/MimeKit/MimeIterator.cs @@ -284,7 +284,7 @@ bool Pop () /// /// /// - /// true if the iterator was successfully advanced to the next entity; otherwise, false. + /// if the iterator was successfully advanced to the next entity; otherwise, . public bool MoveNext () { if (moveFirst) { @@ -361,7 +361,7 @@ static int[] Parse (string pathSpecifier) /// If the iterator has already advanced beyond the entity at the specified /// path, the iterator will and advance as normal. /// - /// true if advancing to the specified entity was successful; otherwise, false. + /// if advancing to the specified entity was successful; otherwise, . /// The path specifier. /// /// is . @@ -435,8 +435,8 @@ public void Reset () /// Releases the unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected virtual void Dispose (bool disposing) { } diff --git a/MimeKit/MimeMessage.cs b/MimeKit/MimeMessage.cs index 99c544ff71..de92d7d496 100644 --- a/MimeKit/MimeMessage.cs +++ b/MimeKit/MimeMessage.cs @@ -1219,7 +1219,7 @@ IList GetMailboxes (bool includeSenders, bool onlyUnique) /// Resent-Cc and Resent-Bcc headers will be used. Otherwise, the recipients defined by the To, Cc /// and Bcc headers will be used. /// - /// If true, only mailboxes with a unique address will be included. + /// If , only mailboxes with a unique address will be included. /// The concatenated list of recipients. public IList GetRecipients (bool onlyUnique = false) { @@ -1306,7 +1306,7 @@ public virtual void Prepare (EncodingConstraint constraint, int maxLineLength = /// /// The formatting options. /// The output stream. - /// true if only the headers should be written; otherwise, false. + /// if only the headers should be written; otherwise, . /// The cancellation token. /// /// is . @@ -1380,7 +1380,7 @@ public void WriteTo (FormatOptions options, Stream stream, bool headersOnly, Can /// An awaitable task. /// The formatting options. /// The output stream. - /// true if only the headers should be written; otherwise, false. + /// if only the headers should be written; otherwise, . /// The cancellation token. /// /// is . @@ -1498,7 +1498,7 @@ public Task WriteToAsync (FormatOptions options, Stream stream, CancellationToke /// Writes the message to the output stream using the default formatting options. /// /// The output stream. - /// true if only the headers should be written; otherwise, false. + /// if only the headers should be written; otherwise, . /// The cancellation token. /// /// is . @@ -1522,7 +1522,7 @@ public void WriteTo (Stream stream, bool headersOnly, CancellationToken cancella /// /// An awaitable task. /// The output stream. - /// true if only the headers should be written; otherwise, false. + /// if only the headers should be written; otherwise, . /// The cancellation token. /// /// is . @@ -2596,8 +2596,8 @@ void HeadersChanged (object o, HeaderListChangedEventArgs e) /// Releases the unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected virtual void Dispose (bool disposing) { if (disposing && Body != null) @@ -2625,7 +2625,7 @@ public void Dispose () /// /// Loads a from the given stream, using the /// specified . - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -2634,7 +2634,7 @@ public void Dispose () /// The parsed message. /// The parser options. /// The stream. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// The cancellation token. /// /// is . @@ -2669,7 +2669,7 @@ public static MimeMessage Load (ParserOptions options, Stream stream, bool persi /// /// Loads a from the given stream, using the /// specified . - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -2678,7 +2678,7 @@ public static MimeMessage Load (ParserOptions options, Stream stream, bool persi /// The parsed message. /// The parser options. /// The stream. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// The cancellation token. /// /// is . @@ -2773,7 +2773,7 @@ public static Task LoadAsync (ParserOptions options, Stream stream, /// /// Loads a from the given stream, using the /// default . - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -2781,7 +2781,7 @@ public static Task LoadAsync (ParserOptions options, Stream stream, /// /// The parsed message. /// The stream. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// The cancellation token. /// /// is . @@ -2806,7 +2806,7 @@ public static MimeMessage Load (Stream stream, bool persistent, CancellationToke /// /// Loads a from the given stream, using the /// default . - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -2814,7 +2814,7 @@ public static MimeMessage Load (Stream stream, bool persistent, CancellationToke /// /// The parsed message. /// The stream. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// The cancellation token. /// /// is . diff --git a/MimeKit/MimeParser.cs b/MimeKit/MimeParser.cs index 9027e1b536..853e90963f 100644 --- a/MimeKit/MimeParser.cs +++ b/MimeKit/MimeParser.cs @@ -158,7 +158,7 @@ public partial class MimeParser : IMimeParser, IEnumerable /// /// /// Creates a new that will parse the specified stream. - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -171,7 +171,7 @@ public partial class MimeParser : IMimeParser, IEnumerable /// /// The stream to parse. /// The format of the stream. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// /// is . /// @@ -184,7 +184,7 @@ public MimeParser (Stream stream, MimeFormat format, bool persistent = false) : /// /// /// Creates a new that will parse the specified stream. - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -193,7 +193,7 @@ public MimeParser (Stream stream, MimeFormat format, bool persistent = false) : /// for to read the content. /// /// The stream to parse. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// /// is . /// @@ -206,7 +206,7 @@ public MimeParser (Stream stream, bool persistent = false) : this (ParserOptions /// /// /// Creates a new that will parse the specified stream. - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -216,7 +216,7 @@ public MimeParser (Stream stream, bool persistent = false) : this (ParserOptions /// /// The parser options. /// The stream to parse. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// /// is . /// -or- @@ -231,7 +231,7 @@ public MimeParser (ParserOptions options, Stream stream, bool persistent = false /// /// /// Creates a new that will parse the specified stream. - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -242,7 +242,7 @@ public MimeParser (ParserOptions options, Stream stream, bool persistent = false /// The parser options. /// The stream to parse. /// The format of the stream. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// /// is . /// -or- @@ -289,8 +289,8 @@ public ParserOptions Options { /// /// /// - /// true if this parser has reached the end of the input stream; - /// otherwise, false. + /// if this parser has reached the end of the input stream; + /// otherwise, . public bool IsEndOfStream { get { return state == MimeParserState.Eos; } } @@ -339,7 +339,7 @@ public string MboxMarker { /// /// /// Sets the stream to parse. - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -350,7 +350,7 @@ public string MboxMarker { /// The parser options. /// The stream to parse. /// The format of the stream. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// /// is . /// -or- @@ -372,7 +372,7 @@ public void SetStream (ParserOptions options, Stream stream, MimeFormat format, /// /// /// Sets the stream to parse. - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -382,7 +382,7 @@ public void SetStream (ParserOptions options, Stream stream, MimeFormat format, /// /// The parser options. /// The stream to parse. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// /// is . /// -or- @@ -399,7 +399,7 @@ public void SetStream (ParserOptions options, Stream stream, bool persistent = f /// /// /// Sets the stream to parse. - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -409,7 +409,7 @@ public void SetStream (ParserOptions options, Stream stream, bool persistent = f /// /// The stream to parse. /// The format of the stream. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// /// is . /// @@ -474,7 +474,7 @@ public void SetStream (Stream stream, MimeFormat format = MimeFormat.Default) /// /// /// Sets the stream to parse. - /// If is true and is seekable, then + /// If is and is seekable, then /// the will not copy the content of s into memory. Instead, /// it will use a to reference a substream of . /// This has the potential to not only save memory usage, but also improve @@ -483,7 +483,7 @@ public void SetStream (Stream stream, MimeFormat format = MimeFormat.Default) /// for to read the content. /// /// The stream to parse. - /// true if the stream is persistent; otherwise false. + /// if the stream is persistent; otherwise, . /// /// is . /// diff --git a/MimeKit/MimePart.cs b/MimeKit/MimePart.cs index 96b00facdf..8f027230b7 100644 --- a/MimeKit/MimePart.cs +++ b/MimeKit/MimePart.cs @@ -596,10 +596,10 @@ public string ComputeContentMd5 () /// /// /// Computes the MD5 checksum of the MIME content and compares it with the - /// value in the Content-MD5 header, returning true if and only if + /// value in the Content-MD5 header, returning if and only if /// the values match. /// - /// true, if content MD5 checksum was verified, false otherwise. + /// if content MD5 checksum was verified; otherwise, . /// /// The has been disposed. /// @@ -667,7 +667,7 @@ public override void Prepare (EncodingConstraint constraint, int maxLineLength = /// /// The formatting options. /// The output stream. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -759,7 +759,7 @@ public override void WriteTo (FormatOptions options, Stream stream, bool content /// An awaitable task. /// The formatting options. /// The output stream. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -882,8 +882,8 @@ protected override void OnHeadersChanged (HeaderListChangedAction action, Header /// Releases the unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected override void Dispose (bool disposing) { if (disposing && Content != null) diff --git a/MimeKit/MimeReader.cs b/MimeKit/MimeReader.cs index 417e8b0e80..2e3720303b 100644 --- a/MimeKit/MimeReader.cs +++ b/MimeKit/MimeReader.cs @@ -160,8 +160,8 @@ public ParserOptions Options { /// /// Gets a value indicating whether the parser has reached the end of the input stream. /// - /// true if this parser has reached the end of the input stream; - /// otherwise, false. + /// if this parser has reached the end of the input stream; + /// otherwise, . public bool IsEndOfStream { get { return state == MimeParserState.Eos; } } diff --git a/MimeKit/MimeTypes.cs b/MimeKit/MimeTypes.cs index 5a2db6f931..ef67b30301 100644 --- a/MimeKit/MimeTypes.cs +++ b/MimeKit/MimeTypes.cs @@ -1037,7 +1037,7 @@ public static string GetMimeType (string fileName) /// /// Gets the standard file extension for a MIME-type. /// - /// true if the extension is known for the specified MIME-type; otherwise, false. + /// if the extension is known for the specified MIME-type; otherwise, . /// The MIME-type. /// The file name extension for the specified MIME-type. /// diff --git a/MimeKit/Multipart.cs b/MimeKit/Multipart.cs index b5add1dffe..d38c932207 100644 --- a/MimeKit/Multipart.cs +++ b/MimeKit/Multipart.cs @@ -311,7 +311,7 @@ public string Epilogue { /// /// Gets or sets whether the end boundary should be written. /// - /// true if the end boundary should be written; otherwise, false. + /// if the end boundary should be written; otherwise, . internal bool WriteEndBoundary { get; set; } @@ -352,7 +352,7 @@ public override void Accept (MimeVisitor visitor) /// /// The preferred text format. /// The MIME part containing the message body in the preferred text format. - /// true if the body part is found; otherwise, false. + /// if the body part is found; otherwise, . /// /// The has been disposed. /// @@ -511,7 +511,7 @@ static FormatOptions GetMultipartSignedFormatOptions (FormatOptions options) /// /// The formatting options. /// The output stream. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -617,7 +617,7 @@ public override void WriteTo (FormatOptions options, Stream stream, bool content /// An awaitable task. /// The formatting options. /// The output stream. - /// true if only the content should be written; otherwise, false. + /// if only the content should be written; otherwise, . /// The cancellation token. /// /// is . @@ -697,7 +697,7 @@ public int Count { /// /// A is never read-only. /// - /// true if this instance is read only; otherwise, false. + /// if this instance is read only; otherwise, . public bool IsReadOnly { get { return false; } } @@ -758,7 +758,7 @@ public void Clear () /// /// Removes all the entities within the multipart, optionally disposing them in the process. /// - /// true if all the child entities of the multipart should be disposed; otherwise, false. + /// if all the child entities of the multipart should be disposed; otherwise, . /// /// The has been disposed. /// @@ -781,8 +781,8 @@ public void Clear (bool dispose) /// /// Determines whether the multipart contains the specified entity. /// - /// true if the specified entity exists; - /// otherwise false. + /// if the specified entity exists; + /// otherwise, . /// The entity to check for. /// /// is . @@ -830,7 +830,7 @@ public void CopyTo (MimeEntity[] array, int arrayIndex) /// /// Removes the specified entity if it exists within the multipart. /// - /// true if the part was removed; otherwise false. + /// if the part was removed; otherwise, . /// The MIME entity to remove. /// /// is . @@ -1018,8 +1018,8 @@ IEnumerator IEnumerable.GetEnumerator () /// Releases the unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected override void Dispose (bool disposing) { if (disposing) { diff --git a/MimeKit/MultipartAlternative.cs b/MimeKit/MultipartAlternative.cs index a4f83ab3c9..e7bd8f2c35 100644 --- a/MimeKit/MultipartAlternative.cs +++ b/MimeKit/MultipartAlternative.cs @@ -184,7 +184,7 @@ public string GetTextBody (TextFormat format) /// /// The preferred text format. /// The MIME part containing the message body in the preferred text format. - /// true if the body part is found; otherwise, false. + /// if the body part is found; otherwise, . /// /// The has been disposed. /// diff --git a/MimeKit/MultipartRelated.cs b/MimeKit/MultipartRelated.cs index 4a139267b7..656f2f8bac 100644 --- a/MimeKit/MultipartRelated.cs +++ b/MimeKit/MultipartRelated.cs @@ -223,7 +223,7 @@ public override void Accept (MimeVisitor visitor) /// /// The preferred text format. /// The MIME part containing the message body in the preferred text format. - /// true if the body part is found; otherwise, false. + /// if the body part is found; otherwise, . /// /// The has been disposed. /// @@ -254,7 +254,7 @@ public override bool TryGetValue (TextFormat format, out TextPart body) /// /// Determines whether the multipart/related entity contains a part matching the specified URI. /// - /// true if the specified part exists; otherwise false. + /// if the specified part exists; otherwise, . /// The URI of the MIME part. /// /// is . diff --git a/MimeKit/Parameter.cs b/MimeKit/Parameter.cs index 8b1f527644..0fa2abfd12 100644 --- a/MimeKit/Parameter.cs +++ b/MimeKit/Parameter.cs @@ -249,7 +249,7 @@ public ParameterEncodingMethod EncodingMethod { /// adhere to the MIME specifications, this property can be used to force MimeKit to quote parameter values that would normally /// not require quoting. /// - /// true if the parameter value should always be quoted; otherwise, false. + /// if the parameter value should always be quoted; otherwise, . public bool AlwaysQuote { get { return alwaysQuote; } set { diff --git a/MimeKit/ParameterList.cs b/MimeKit/ParameterList.cs index b9494825ca..596a6ae9c8 100644 --- a/MimeKit/ParameterList.cs +++ b/MimeKit/ParameterList.cs @@ -138,8 +138,8 @@ public void Add (string charset, string name, string value) /// /// Determines whether the parameter list contains a parameter with the specified name. /// - /// true if the requested parameter exists; - /// otherwise false. + /// if the requested parameter exists; + /// otherwise, . /// The parameter name. /// /// is . @@ -210,8 +210,8 @@ public void Insert (int index, string name, string value) /// /// Removes the parameter with the specified name from the list, if it exists. /// - /// true if the specified parameter was removed; - /// otherwise false. + /// if the specified parameter was removed; + /// otherwise, . /// The parameter name. /// /// is . @@ -277,7 +277,7 @@ public string this [string name] { /// /// /// - /// true if the parameter exists; otherwise, false. + /// if the parameter exists; otherwise, . /// The parameter name. /// The parameter. /// @@ -297,7 +297,7 @@ public bool TryGetValue (string name, out Parameter param) /// /// Gets the value of the parameter with the specified name. /// - /// true if the parameter exists; otherwise, false. + /// if the parameter exists; otherwise, . /// The parameter name. /// The parameter value. /// @@ -337,7 +337,7 @@ public int Count { /// /// A is never read-only. /// - /// true if this instance is read only; otherwise, false. + /// if this instance is read only; otherwise, . public bool IsReadOnly { get { return false; } } @@ -394,8 +394,8 @@ public void Clear () /// /// Determines whether the parameter list contains the specified parameter. /// - /// true if the specified parameter is contained; - /// otherwise false. + /// if the specified parameter is contained; + /// otherwise, . /// The parameter. /// /// The is . @@ -428,8 +428,8 @@ public void CopyTo (Parameter[] array, int arrayIndex) /// /// Removes the specified parameter from the list. /// - /// true if the specified parameter was removed; - /// otherwise false. + /// if the specified parameter was removed; + /// otherwise, . /// The parameter. /// /// The is . diff --git a/MimeKit/ParserOptions.cs b/MimeKit/ParserOptions.cs index d8c9a760d6..820b33d6d9 100644 --- a/MimeKit/ParserOptions.cs +++ b/MimeKit/ParserOptions.cs @@ -77,25 +77,25 @@ public class ParserOptions /// Get or set whether the rfc822 address parser should ignore unquoted commas in address names. /// /// - /// In general, you'll probably want this value to be true (the default) as it allows + /// In general, you'll probably want this value to be (the default) as it allows /// maximum interoperability with existing (broken) mail clients and other mail software such as /// sloppily written perl scripts (aka spambots) that do not properly quote the name when it /// contains a comma. /// - /// true if the address parser should ignore unquoted commas in address names; otherwise, false. + /// if the address parser should ignore unquoted commas in address names; otherwise, . public bool AllowUnquotedCommasInAddresses { get; set; } /// /// Get or set whether the rfc822 address parser should allow addresses without a domain. /// /// - /// In general, you'll probably want this value to be true (the default) as it allows + /// In general, you'll probably want this value to be (the default) as it allows /// maximum interoperability with older email messages that may contain local UNIX addresses. /// This option exists in order to allow parsing of mailbox addresses that do not have an /// @domain component. These types of addresses are rare and were typically only used when sending /// mail to other users on the same UNIX system. /// - /// true if the address parser should allow mailbox addresses without a domain; otherwise, false. + /// if the address parser should allow mailbox addresses without a domain; otherwise, . public bool AllowAddressesWithoutDomain { get; set; } /// @@ -156,8 +156,8 @@ public class ParserOptions /// at /// http://www.jwz.org/doc/content-length.html. /// - /// true if the Content-Length value should be respected; - /// otherwise, false. + /// if the Content-Length value should be respected; + /// otherwise, . public bool RespectContentLength { get; set; } /// diff --git a/MimeKit/Text/FlowedToHtml.cs b/MimeKit/Text/FlowedToHtml.cs index 58af5d2c0a..6c318e2f58 100644 --- a/MimeKit/Text/FlowedToHtml.cs +++ b/MimeKit/Text/FlowedToHtml.cs @@ -88,13 +88,13 @@ public override TextFormat OutputFormat { /// Gets or sets whether the trailing space on a wrapped line should be deleted. /// The flowed text format defines a Content-Type parameter called "delsp" which can /// have a value of "yes" or "no". If the parameter exists and the value is "yes", then - /// should be set to true, otherwise - /// should be set to false. + /// should be set to , otherwise + /// should be set to . /// /// /// /// - /// true if the trailing space on a wrapped line should be deleted; otherwise, false. + /// if the trailing space on a wrapped line should be deleted; otherwise, . public bool DeleteSpace { get; set; } @@ -141,7 +141,7 @@ public HtmlTagCallback HtmlTagCallback { /// Gets or sets whether the converter should only output an entire /// HTML document or just a fragment of the HTML body content. /// - /// true if the converter should only output an HTML fragment; otherwise, false. + /// if the converter should only output an HTML fragment; otherwise, . public bool OutputHtmlFragment { get; set; } diff --git a/MimeKit/Text/FlowedToText.cs b/MimeKit/Text/FlowedToText.cs index 631edd120e..0fd88f0024 100644 --- a/MimeKit/Text/FlowedToText.cs +++ b/MimeKit/Text/FlowedToText.cs @@ -78,10 +78,10 @@ public override TextFormat OutputFormat { /// Gets or sets whether the trailing space on a wrapped line should be deleted. /// The flowed text format defines a Content-Type parameter called "delsp" which can /// have a value of "yes" or "no". If the parameter exists and the value is "yes", then - /// should be set to true, otherwise - /// should be set to false. + /// should be set to , otherwise + /// should be set to . /// - /// true if the trailing space on a wrapped line should be deleted; otherwise, false. + /// if the trailing space on a wrapped line should be deleted; otherwise, . public bool DeleteSpace { get; set; } diff --git a/MimeKit/Text/HtmlAttributeCollection.cs b/MimeKit/Text/HtmlAttributeCollection.cs index f26627a25d..e8f0ccb5fa 100644 --- a/MimeKit/Text/HtmlAttributeCollection.cs +++ b/MimeKit/Text/HtmlAttributeCollection.cs @@ -90,7 +90,7 @@ internal void Add (HtmlAttribute attribute) /// Checks if an attribute exists. /// /// The attribute. - /// true if the attribute exists within the collection; otherwise, false. + /// if the attribute exists within the collection; otherwise, . public bool Contains (HtmlAttributeId id) { return IndexOf (id) != -1; @@ -103,7 +103,7 @@ public bool Contains (HtmlAttributeId id) /// Checks if an attribute exists. /// /// The name of the attribute. - /// true if the attribute exists within the collection; otherwise, false. + /// if the attribute exists within the collection; otherwise, . /// /// is . /// @@ -119,7 +119,7 @@ public bool Contains (string name) /// Gets the index of a desired attribute. /// /// The attribute. - /// true if the attribute exists within the collection; otherwise, false. + /// if the attribute exists within the collection; otherwise, . public int IndexOf (HtmlAttributeId id) { for (int i = 0; i < attributes.Count; i++) { @@ -137,7 +137,7 @@ public int IndexOf (HtmlAttributeId id) /// Gets the index of a desired attribute. /// /// The name of the attribute. - /// true if the attribute exists within the collection; otherwise, false. + /// if the attribute exists within the collection; otherwise, . /// /// is . /// @@ -177,7 +177,7 @@ public HtmlAttribute this[int index] { /// /// The id of the attribute. /// The attribute if found; otherwise, . - /// true if the desired attribute is found; otherwise, false. + /// if the desired attribute is found; otherwise, . public bool TryGetValue (HtmlAttributeId id, out HtmlAttribute attribute) { int index; @@ -200,7 +200,7 @@ public bool TryGetValue (HtmlAttributeId id, out HtmlAttribute attribute) /// /// The name of the attribute. /// The attribute if found; otherwise, . - /// true if the desired attribute is found; otherwise, false. + /// if the desired attribute is found; otherwise, . /// /// is . /// diff --git a/MimeKit/Text/HtmlEntityDecoder.cs b/MimeKit/Text/HtmlEntityDecoder.cs index b3a47c7324..801c0f81c8 100644 --- a/MimeKit/Text/HtmlEntityDecoder.cs +++ b/MimeKit/Text/HtmlEntityDecoder.cs @@ -116,7 +116,7 @@ bool PushNumericEntity (char c) /// Pushes the specified character into the HTML entity decoder. /// The first character pushed MUST be the '&' character. /// - /// true if the character was accepted; otherwise, false. + /// if the character was accepted; otherwise, . /// The character. /// /// is the first character being pushed and was not the '&' character. diff --git a/MimeKit/Text/HtmlTagContext.cs b/MimeKit/Text/HtmlTagContext.cs index 07a67dd73e..46dd24c905 100644 --- a/MimeKit/Text/HtmlTagContext.cs +++ b/MimeKit/Text/HtmlTagContext.cs @@ -73,7 +73,7 @@ public abstract HtmlAttributeCollection Attributes { /// /// Gets or sets whether the end tag should be deleted. /// - /// true if the end tag should be deleted; otherwise, false. + /// if the end tag should be deleted; otherwise, . public bool DeleteEndTag { get; set; } @@ -84,7 +84,7 @@ public bool DeleteEndTag { /// /// Gets or sets whether the tag should be deleted. /// - /// true if the tag should be deleted; otherwise, false. + /// if the tag should be deleted; otherwise, . public bool DeleteTag { get; set; } @@ -98,7 +98,7 @@ public bool DeleteTag { /// /// /// - /// true if the callback should be invoked for end tag; otherwise, false. + /// if the callback should be invoked for end tag; otherwise, . public bool InvokeCallbackForEndTag { get; set; } @@ -112,7 +112,7 @@ public bool InvokeCallbackForEndTag { /// /// /// - /// true if the tag is an empty element; otherwise, false. + /// if the tag is an empty element; otherwise, . public abstract bool IsEmptyElementTag { get; } @@ -126,7 +126,7 @@ public abstract bool IsEmptyElementTag { /// /// /// - /// true if the tag is an end tag; otherwise, false. + /// if the tag is an end tag; otherwise, . public abstract bool IsEndTag { get; } @@ -137,7 +137,7 @@ public abstract bool IsEndTag { /// /// Gets or sets whether the inner content of the tag should be suppressed. /// - /// true if the inner content should be suppressed; otherwise, false. + /// if the inner content should be suppressed; otherwise, . public bool SuppressInnerContent { get; set; } @@ -195,7 +195,7 @@ public void WriteTag (HtmlWriter htmlWriter) /// /// /// The HTML writer. - /// true if the should also be written; otherwise, false. + /// if the should also be written; otherwise, . /// /// is . /// diff --git a/MimeKit/Text/HtmlTagId.cs b/MimeKit/Text/HtmlTagId.cs index 7d3d9e3fde..0cbdf230c4 100644 --- a/MimeKit/Text/HtmlTagId.cs +++ b/MimeKit/Text/HtmlTagId.cs @@ -925,7 +925,7 @@ internal static HtmlTagId ToHtmlTagId (this string name) /// /// Determines whether the HTML tag is an empty element. /// - /// true if the tag is an empty element; otherwise, false. + /// if the tag is an empty element; otherwise, . /// Identifier. public static bool IsEmptyElement (this HtmlTagId id) { @@ -958,7 +958,7 @@ public static bool IsEmptyElement (this HtmlTagId id) /// /// Determines whether the HTML tag is a formatting element. /// - /// true if the HTML tag is a formatting element; otherwise, false. + /// if the HTML tag is a formatting element; otherwise, . /// The HTML tag identifier. public static bool IsFormattingElement (this HtmlTagId id) { diff --git a/MimeKit/Text/HtmlToHtml.cs b/MimeKit/Text/HtmlToHtml.cs index ecb15f1f28..a8eebfcc3a 100644 --- a/MimeKit/Text/HtmlToHtml.cs +++ b/MimeKit/Text/HtmlToHtml.cs @@ -91,7 +91,7 @@ public override TextFormat OutputFormat { /// /// Gets or sets whether the converter should remove HTML comments from the output. /// - /// true if the converter should remove comments; otherwise, false. + /// if the converter should remove comments; otherwise, . public bool FilterComments { get; set; } @@ -102,7 +102,7 @@ public bool FilterComments { /// /// Gets or sets whether executable scripts should be stripped from the output. /// - /// true if executable scripts should be filtered; otherwise, false. + /// if executable scripts should be filtered; otherwise, . public bool FilterHtml { get; set; } @@ -154,7 +154,7 @@ public HtmlTagCallback HtmlTagCallback { /// Gets or sets whether the converter should collapse white space, /// balance tags, and fix other problems in the source HTML. /// - /// true if the output html should be normalized; otherwise, false. + /// if the output html should be normalized; otherwise, . public bool NormalizeHtml { get; set; } @@ -167,7 +167,7 @@ public bool NormalizeHtml { /// /// Gets or sets whether the converter should only output an HTML fragment. /// - /// true if the converter should only output an HTML fragment; otherwise, false. + /// if the converter should only output an HTML fragment; otherwise, . public bool OutputHtmlFragment { get; set; } diff --git a/MimeKit/Text/HtmlToken.cs b/MimeKit/Text/HtmlToken.cs index ae2880fc5d..771983d790 100644 --- a/MimeKit/Text/HtmlToken.cs +++ b/MimeKit/Text/HtmlToken.cs @@ -104,7 +104,7 @@ public class HtmlCommentToken : HtmlToken /// Creates a new . /// /// The comment text. - /// true if the comment is bogus; otherwise, false. + /// if the comment is bogus; otherwise, . /// /// is . /// @@ -134,7 +134,7 @@ public string Comment { /// /// Gets whether the comment is a bogus comment. /// - /// true if the comment is bogus; otherwise, false. + /// if the comment is bogus; otherwise, . public bool IsBogusComment { get; private set; } @@ -372,7 +372,7 @@ public class HtmlTagToken : HtmlToken /// /// The name of the tag. /// The attributes. - /// true if the tag is an empty element; otherwise, false. + /// if the tag is an empty element; otherwise, . /// /// is . /// -or- @@ -398,7 +398,7 @@ public HtmlTagToken (string name, IEnumerable attributes, bool is /// Creates a new . /// /// The name of the tag. - /// true if the tag is an end tag; otherwise, false. + /// if the tag is an end tag; otherwise, . /// /// is . /// @@ -445,7 +445,7 @@ public HtmlTagId Id { /// /// Gets whether the tag is an empty element. /// - /// true if the tag is an empty element; otherwise, false. + /// if the tag is an empty element; otherwise, . public bool IsEmptyElement { get; internal set; } @@ -456,7 +456,7 @@ public bool IsEmptyElement { /// /// Gets whether the tag is an end tag. /// - /// true if the tag is an end tag; otherwise, false. + /// if the tag is an end tag; otherwise, . public bool IsEndTag { get; private set; } @@ -537,7 +537,7 @@ internal string RawTagName { /// /// Gets whether quirks-mode should be forced. /// - /// true if quirks-mode should be forced; otherwise, false. + /// if quirks-mode should be forced; otherwise, . public bool ForceQuirksMode { get; set; } diff --git a/MimeKit/Text/HtmlTokenizer.cs b/MimeKit/Text/HtmlTokenizer.cs index 5b567f9f97..b00a958b40 100644 --- a/MimeKit/Text/HtmlTokenizer.cs +++ b/MimeKit/Text/HtmlTokenizer.cs @@ -122,7 +122,7 @@ public HtmlTokenizer (Stream stream, Encoding encoding) : this (stream, encoding /// /// The input stream. /// The charset encoding of the stream. - /// true if byte order marks should be detected and used to override the ; otherwise, false. + /// if byte order marks should be detected and used to override the ; otherwise, . /// The minimum buffer size to use for reading. public HtmlTokenizer (Stream stream, Encoding encoding, bool detectEncodingFromByteOrderMarks, int bufferSize = 4096) : this () { @@ -166,9 +166,9 @@ public HtmlTokenizer (TextReader reader) : this () /// /// Gets or sets whether the tokenizer should decode character references. /// Character references in attribute values will still be decoded - /// even if this value is set to false. + /// even if this value is set to . /// - /// true if character references should be decoded; otherwise, false. + /// if character references should be decoded; otherwise, . public bool DecodeCharacterReferences { get; set; } @@ -189,10 +189,10 @@ public HtmlNamespace HtmlNamespace { /// /// /// Gets or sets whether the tokenizer should ignore truncated tags. - /// If false and the stream abruptly ends in the middle of an HTML tag, it will be + /// If and the stream abruptly ends in the middle of an HTML tag, it will be /// treated as an instead. /// - /// true if truncated tags should be ignored; otherwise, false. + /// if truncated tags should be ignored; otherwise, . public bool IgnoreTruncatedTags { get; set; } @@ -263,7 +263,7 @@ HtmlDocTypeToken CreateDocTypeToken (string rawTagName) /// /// The HTML comment token. /// The comment. - /// true if the comment is bogus; otherwise, false. + /// if the comment is bogus; otherwise, . protected virtual HtmlCommentToken CreateCommentToken (string comment, bool bogus = false) { return new HtmlCommentToken (comment, bogus); @@ -316,7 +316,7 @@ protected virtual HtmlScriptDataToken CreateScriptDataToken (string data) /// /// The HTML tag token. /// The tag name. - /// true if the tag is an end tag; otherwise, false. + /// if the tag is an end tag; otherwise, . protected virtual HtmlTagToken CreateTagToken (string name, bool isEndTag = false) { return new HtmlTagToken (name, isEndTag); @@ -2715,7 +2715,7 @@ HtmlToken ReadCDataSection () /// /// Reads the next token. /// - /// true if the next token was read; otherwise, false. + /// if the next token was read; otherwise, . /// The token that was read. public bool ReadNextToken (out HtmlToken token) { diff --git a/MimeKit/Text/HtmlWriter.cs b/MimeKit/Text/HtmlWriter.cs index 61985542d0..83d1a33dd6 100644 --- a/MimeKit/Text/HtmlWriter.cs +++ b/MimeKit/Text/HtmlWriter.cs @@ -868,8 +868,8 @@ public void Flush () /// Releases any unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected virtual void Dispose (bool disposing) { if (disposing) diff --git a/MimeKit/Text/TextConverter.cs b/MimeKit/Text/TextConverter.cs index 64941353c6..30c8c2dafb 100644 --- a/MimeKit/Text/TextConverter.cs +++ b/MimeKit/Text/TextConverter.cs @@ -87,7 +87,7 @@ protected TextConverter () /// Gets or sets whether the encoding of the input is detected from the byte order mark or /// determined by the property. /// - /// true if detect encoding from byte order mark; otherwise, false. + /// if detect encoding from byte order mark; otherwise, . public bool DetectEncodingFromByteOrderMark { get; set; } diff --git a/MimeKit/Text/TextToHtml.cs b/MimeKit/Text/TextToHtml.cs index e1e9501f8c..3ce36788ee 100644 --- a/MimeKit/Text/TextToHtml.cs +++ b/MimeKit/Text/TextToHtml.cs @@ -120,7 +120,7 @@ public HtmlTagCallback HtmlTagCallback { /// Gets or sets whether the converter should only output an entire /// HTML document or just a fragment of the HTML body content. /// - /// true if the converter should only output an HTML fragment; otherwise, false. + /// if the converter should only output an HTML fragment; otherwise, . public bool OutputHtmlFragment { get; set; } diff --git a/MimeKit/Text/Trie.cs b/MimeKit/Text/Trie.cs index 951261bb37..100ab49b14 100644 --- a/MimeKit/Text/Trie.cs +++ b/MimeKit/Text/Trie.cs @@ -71,7 +71,7 @@ public TrieMatch (char value) /// /// Creates a new . /// - /// true if searching should ignore case; otherwise, false. + /// if searching should ignore case; otherwise, . public Trie (bool ignoreCase) { failStates = new List (); diff --git a/MimeKit/TextPart.cs b/MimeKit/TextPart.cs index cfc0180170..7e6daa2ea0 100644 --- a/MimeKit/TextPart.cs +++ b/MimeKit/TextPart.cs @@ -250,7 +250,7 @@ public TextFormat Format { /// Checks whether the text part's Content-Type is text/enriched or its /// predecessor, text/richtext (not to be confused with text/rtf). /// - /// true if the text is enriched; otherwise, false. + /// if the text is enriched; otherwise, . /// /// The has been disposed. /// @@ -272,7 +272,7 @@ public bool IsEnriched { /// /// /// - /// true if the text is flowed; otherwise, false. + /// if the text is flowed; otherwise, . /// /// The has been disposed. /// @@ -296,7 +296,7 @@ public bool IsFlowed { /// /// /// - /// true if the text is html; otherwise, false. + /// if the text is html; otherwise, . /// /// The has been disposed. /// @@ -314,7 +314,7 @@ public bool IsHtml { /// /// Checks whether the text part's Content-Type is text/plain. /// - /// true if the text is html; otherwise, false. + /// if the text is html; otherwise, . /// /// The has been disposed. /// @@ -332,7 +332,7 @@ public bool IsPlain { /// /// Checks whether the text part's Content-Type is text/rtf. /// - /// true if the text is RTF; otherwise, false. + /// if the text is RTF; otherwise, . /// /// The has been disposed. /// @@ -404,7 +404,7 @@ public override void Accept (MimeVisitor visitor) /// /// Determines whether the text is in the specified format. /// - /// true if the text is in the specified format; otherwise, false. + /// if the text is in the specified format; otherwise, . /// The text format. /// /// The has been disposed. @@ -549,7 +549,7 @@ bool TryDetectHtmlEncoding (out Encoding encoding, out TextEncodingConfidence co /// is set to the encoding for the specified charset and is /// set to . /// - /// true if an encoding was detected; otherwise, false. + /// if an encoding was detected; otherwise, . /// The detected encoding; otherwise, . /// The confidence in the detected encoding being correct. /// diff --git a/MimeKit/Tnef/RtfCompressedToRtf.cs b/MimeKit/Tnef/RtfCompressedToRtf.cs index 6e6e0a6a2f..908b03d528 100644 --- a/MimeKit/Tnef/RtfCompressedToRtf.cs +++ b/MimeKit/Tnef/RtfCompressedToRtf.cs @@ -98,9 +98,9 @@ public RtfCompressionMode CompressionMode { /// Get a value indicating whether the crc32 is valid. /// /// - /// Until all data has been processed, this property will always return false. + /// Until all data has been processed, this property will always return . /// - /// true if the crc32 is valid; otherwise, false. + /// if the crc32 is valid; otherwise, . public bool IsValidCrc32 { get { return crc32.Checksum == checksum; } } @@ -170,7 +170,7 @@ bool TryReadInt32 (byte[] buffer, ref int index, int endIndex, out int value) /// Length. /// Output index. /// Output length. - /// If set to true flush. + /// If set to flush. protected override byte[] Filter (byte[] input, int startIndex, int length, out int outputIndex, out int outputLength, bool flush) { int endIndex = startIndex + length; diff --git a/MimeKit/Tnef/TnefNameId.cs b/MimeKit/Tnef/TnefNameId.cs index 12cbe62cc9..dd302d8a2d 100644 --- a/MimeKit/Tnef/TnefNameId.cs +++ b/MimeKit/Tnef/TnefNameId.cs @@ -130,8 +130,8 @@ public override int GetHashCode () /// Determines whether the specified is equal to the current . /// /// The to compare with the current . - /// true if the specified is equal to the current - /// ; otherwise, false. + /// if the specified is equal to the current + /// ; otherwise, . public override bool Equals (object obj) { return obj is TnefNameId other && Equals (other); @@ -144,8 +144,8 @@ public override bool Equals (object obj) /// Compares two TNEF name identifiers to determine if they are identical or not. /// /// The to compare with the current . - /// true if the specified is equal to the current - /// ; otherwise, false. + /// if the specified is equal to the current + /// ; otherwise, . public bool Equals (TnefNameId other) { if (kind != other.kind || guid != other.guid) @@ -162,7 +162,7 @@ public bool Equals (TnefNameId other) /// /// The first object to compare. /// The second object to compare. - /// true if and are equal; otherwise, false. + /// if and are equal; otherwise, . public static bool operator == (TnefNameId left, TnefNameId right) { return left.Equals (right); @@ -176,7 +176,7 @@ public bool Equals (TnefNameId other) /// /// The first object to compare. /// The second object to compare. - /// true if and are unequal; otherwise, false. + /// if and are unequal; otherwise, . public static bool operator != (TnefNameId left, TnefNameId right) { return !(left == right); diff --git a/MimeKit/Tnef/TnefPropertyReader.cs b/MimeKit/Tnef/TnefPropertyReader.cs index 8a0c7d97c9..c15b4f7177 100644 --- a/MimeKit/Tnef/TnefPropertyReader.cs +++ b/MimeKit/Tnef/TnefPropertyReader.cs @@ -63,7 +63,7 @@ internal TnefAttachMethod AttachMethod { /// /// Gets a value indicating whether the current property is a computed property. /// - /// true if the current property is a computed property; otherwise, false. + /// if the current property is a computed property; otherwise, . public bool IsComputedProperty { get { throw new NotImplementedException (); } } @@ -75,7 +75,7 @@ public bool IsComputedProperty { /// /// Gets a value indicating whether the current property is an embedded TNEF message. /// - /// true if the current property is an embedded TNEF message; otherwise, false. + /// if the current property is an embedded TNEF message; otherwise, . public bool IsEmbeddedMessage { get { return propertyTag.Id == TnefPropertyId.AttachData && AttachMethod == TnefAttachMethod.EmbeddedMessage; } } @@ -87,7 +87,7 @@ public bool IsEmbeddedMessage { /// /// Gets a value indicating whether the current property has a large value. /// - /// true if the current property has a large value; otherwise, false. + /// if the current property has a large value; otherwise, . public bool IsLargeValue { get { throw new NotImplementedException (); } } @@ -99,7 +99,7 @@ public bool IsLargeValue { /// /// Gets a value indicating whether the current property has multiple values. /// - /// true if the current property has multiple values; otherwise, false. + /// if the current property has multiple values; otherwise, . public bool IsMultiValuedProperty { get { return propertyTag.IsMultiValued; } } @@ -110,7 +110,7 @@ public bool IsMultiValuedProperty { /// /// Gets a value indicating whether the current property is a named property. /// - /// true if the current property is a named property; otherwise, false. + /// if the current property is a named property; otherwise, . public bool IsNamedProperty { get { return propertyTag.IsNamed; } } @@ -121,7 +121,7 @@ public bool IsNamedProperty { /// /// Gets a value indicating whether the current property contains object values. /// - /// true if the current property contains object values; otherwise, false. + /// if the current property contains object values; otherwise, . public bool IsObjectProperty { get { return propertyTag.ValueTnefType == TnefPropertyType.Object; } } @@ -521,7 +521,7 @@ void LoadPropertyName () /// /// Advances to the next MAPI property. /// - /// true if there is another property available to be read; otherwise false. + /// if there is another property available to be read; otherwise, . /// /// The TNEF data is corrupt or invalid. /// @@ -569,7 +569,7 @@ public bool ReadNextProperty () /// /// Advances to the next table row of properties. /// - /// true if there is another row available to be read; otherwise false. + /// if there is another row available to be read; otherwise, . /// /// The TNEF data is corrupt or invalid. /// @@ -599,7 +599,7 @@ public bool ReadNextRow () /// /// Advances to the next value in the TNEF stream. /// - /// true if there is another value available to be read; otherwise false. + /// if there is another value available to be read; otherwise, . /// /// The TNEF data is corrupt or invalid. /// @@ -1506,8 +1506,8 @@ public override int GetHashCode () /// Determines whether the specified is equal to the current . /// /// The to compare with the current . - /// true if the specified is equal to the current - /// ; otherwise, false. + /// if the specified is equal to the current + /// ; otherwise, . public override bool Equals (object obj) { return obj is TnefPropertyReader prop && prop.reader == reader; diff --git a/MimeKit/Tnef/TnefPropertyTag.cs b/MimeKit/Tnef/TnefPropertyTag.cs index b2022d800d..a1d9b06b1c 100644 --- a/MimeKit/Tnef/TnefPropertyTag.cs +++ b/MimeKit/Tnef/TnefPropertyTag.cs @@ -5547,7 +5547,7 @@ public TnefPropertyId Id { /// /// Gets a value indicating whether the property contains multiple values. /// - /// true if the property contains multiple values; otherwise, false. + /// if the property contains multiple values; otherwise, . public bool IsMultiValued { get { return (((short) type) & MultiValuedFlag) != 0; } } @@ -5558,7 +5558,7 @@ public bool IsMultiValued { /// /// Gets a value indicating whether the property has a special name. /// - /// true if the property has a special name; otherwise, false. + /// if the property has a special name; otherwise, . public bool IsNamed { get { return (int) id >= (int) NamedMin && (int) id <= (int) NamedMax; } } @@ -5569,7 +5569,7 @@ public bool IsNamed { /// /// Gets a value indicating whether the property value type is valid. /// - /// true if the property value type is valid; otherwise, false. + /// if the property value type is valid; otherwise, . public bool IsTnefTypeValid { get { switch (ValueTnefType) { @@ -5700,8 +5700,8 @@ public override int GetHashCode () /// Determines whether the specified is equal to the current . /// /// The to compare with the current . - /// true if the specified is equal to the current - /// ; otherwise, false. + /// if the specified is equal to the current + /// ; otherwise, . public override bool Equals (object obj) { return obj is TnefPropertyTag tag @@ -5743,7 +5743,7 @@ public TnefPropertyTag ToUnicode () /// /// The first object to compare. /// The second object to compare. - /// true if and are equal; otherwise, false. + /// if and are equal; otherwise, . public static bool operator == (TnefPropertyTag left, TnefPropertyTag right) { return left.Equals (right); @@ -5757,7 +5757,7 @@ public TnefPropertyTag ToUnicode () /// /// The first object to compare. /// The second object to compare. - /// true if and are unequal; otherwise, false. + /// if and are unequal; otherwise, . public static bool operator != (TnefPropertyTag left, TnefPropertyTag right) { return !(left == right); diff --git a/MimeKit/Tnef/TnefReader.cs b/MimeKit/Tnef/TnefReader.cs index 8aaedb7f3c..774e337d5c 100644 --- a/MimeKit/Tnef/TnefReader.cs +++ b/MimeKit/Tnef/TnefReader.cs @@ -595,7 +595,7 @@ bool SkipAttributeRawValue () /// /// Advances to the next attribute in the TNEF stream. /// - /// true if there is another attribute available to be read; otherwise false. + /// if there is another attribute available to be read; otherwise, . /// /// The TNEF stream is corrupted or invalid. /// @@ -744,8 +744,8 @@ public void Close () /// Releases the unmanaged resources used by the and /// optionally releases the managed resources. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected virtual void Dispose (bool disposing) { if (disposing && !closed) diff --git a/MimeKit/Tnef/TnefReaderStream.cs b/MimeKit/Tnef/TnefReaderStream.cs index 29c875c9d6..6dd13aba96 100644 --- a/MimeKit/Tnef/TnefReaderStream.cs +++ b/MimeKit/Tnef/TnefReaderStream.cs @@ -68,7 +68,7 @@ void CheckDisposed () /// /// The is always readable. /// - /// true if the stream supports reading; otherwise, false. + /// if the stream supports reading; otherwise, . public override bool CanRead { get { return true; } } @@ -79,7 +79,7 @@ public override bool CanRead { /// /// Writing to a is not supported. /// - /// true if the stream supports writing; otherwise, false. + /// if the stream supports writing; otherwise, . public override bool CanWrite { get { return false; } } @@ -90,7 +90,7 @@ public override bool CanWrite { /// /// Seeking within a is not supported. /// - /// true if the stream supports seeking; otherwise, false. + /// if the stream supports seeking; otherwise, . public override bool CanSeek { get { return false; } } @@ -259,8 +259,8 @@ public override void SetLength (long value) /// /// The underlying is not disposed. /// - /// true to release both managed and unmanaged resources; - /// false to release only the unmanaged resources. + /// to release both managed and unmanaged resources; + /// to release only the unmanaged resources. protected override void Dispose (bool disposing) { base.Dispose (disposing); diff --git a/MimeKit/Utils/BufferPool.cs b/MimeKit/Utils/BufferPool.cs index 8d290994a0..7fedfe5662 100644 --- a/MimeKit/Utils/BufferPool.cs +++ b/MimeKit/Utils/BufferPool.cs @@ -111,7 +111,7 @@ public int MaxBufferCount { /// in subsequent uses of . /// /// The rented buffer. - /// true if the buffer should be cleared; otherwise, false. + /// true if the buffer should be cleared; otherwise, . public byte[] Rent (bool clear = false) { byte[] buffer = null; diff --git a/MimeKit/Utils/DateUtils.cs b/MimeKit/Utils/DateUtils.cs index fe3b4c9fd7..f45ccb0fd7 100644 --- a/MimeKit/Utils/DateUtils.cs +++ b/MimeKit/Utils/DateUtils.cs @@ -520,7 +520,7 @@ static bool TryParseUnknownDateFormat (IList tokens, byte[] text, out /// Parses an rfc822 date and time from the supplied buffer starting at the given index /// and spanning across the specified number of bytes. /// - /// true, if the date was successfully parsed, false otherwise. + /// if the date was successfully parsed; otherwise, . /// The input buffer. /// The starting index of the input buffer. /// The number of bytes in the input buffer to parse. @@ -562,7 +562,7 @@ public static bool TryParse (byte[] buffer, int startIndex, int length, out Date /// /// Parses an rfc822 date and time from the supplied buffer starting at the specified index. /// - /// true, if the date was successfully parsed, false otherwise. + /// if the date was successfully parsed; otherwise, . /// The input buffer. /// The starting index of the input buffer. /// The parsed date. @@ -589,7 +589,7 @@ public static bool TryParse (byte[] buffer, int startIndex, out DateTimeOffset d /// /// Parses an rfc822 date and time from the specified buffer. /// - /// true, if the date was successfully parsed, false otherwise. + /// if the date was successfully parsed; otherwise, . /// The input buffer. /// The parsed date. /// @@ -609,7 +609,7 @@ public static bool TryParse (byte[] buffer, out DateTimeOffset date) /// /// Parses an rfc822 date and time from the specified text. /// - /// true, if the date was successfully parsed, false otherwise. + /// if the date was successfully parsed; otherwise, . /// The input text. /// The parsed date. /// diff --git a/MimeKit/Utils/MimeUtils.cs b/MimeKit/Utils/MimeUtils.cs index afcc1b13f4..1e4b5700b2 100644 --- a/MimeKit/Utils/MimeUtils.cs +++ b/MimeKit/Utils/MimeUtils.cs @@ -276,7 +276,7 @@ public static string ParseMessageId (string text) /// Parses a MIME version string from the supplied buffer starting at the given index /// and spanning across the specified number of bytes. /// - /// true, if the version was successfully parsed, false otherwise. + /// if the version was successfully parsed; otherwise, . /// The raw byte buffer to parse. /// The index into the buffer to start parsing. /// The length of the buffer to parse. @@ -333,7 +333,7 @@ public static bool TryParse (byte[] buffer, int startIndex, int length, out Vers /// /// Parses a MIME version string from the specified text. /// - /// true, if the version was successfully parsed, false otherwise. + /// if the version was successfully parsed; otherwise, . /// The text to parse. /// The parsed version. /// @@ -360,7 +360,7 @@ static bool IsEncoding (string value, string text, int startIndex, int length) /// /// Parses a Content-Transfer-Encoding header value. /// - /// true, if the encoding was successfully parsed, false otherwise. + /// if the encoding was successfully parsed; otherwise, . /// The text to parse. /// The parsed encoding. /// @@ -525,7 +525,7 @@ public static string Quote (string text) /// /// The unquoted text. /// The text to unquote. - /// true if tab characters should be converted to a space; otherwise, false. + /// if tab characters should be converted to a space; otherwise, . /// /// is . /// diff --git a/MimeKit/Utils/OptimizedOrdinalComparer.cs b/MimeKit/Utils/OptimizedOrdinalComparer.cs index ae8179033d..4c95485eb1 100644 --- a/MimeKit/Utils/OptimizedOrdinalComparer.cs +++ b/MimeKit/Utils/OptimizedOrdinalComparer.cs @@ -71,10 +71,10 @@ static int ToUpper (int c) /// /// Compares the input strings for equality. /// - /// trueif and refer to the same object, + /// if and refer to the same object, /// or and are equal, /// or and are ; - /// otherwise, false. + /// otherwise, . /// A string to compare to . /// A string to compare to . public bool Equals (string x, string y)