Documentation fixes

Author: link2xt

src/client.rs

@@ -733,8 +733,8 @@ impl<T: Read + Write + Unpin + fmt::Debug + Send> Session<T> {
     /// either does not have [`Flag::Deleted`] set or has a [`Uid`] that is not included in the
     /// specified sequence set, it is not affected.
     ///
-    /// This command is particularly useful for disconnected use clients. By using [`uid_expunge`]
-    /// instead of [`expunge`] when resynchronizing with the server, the client can ensure that it
+    /// This command is particularly useful for disconnected use clients. By using `uid_expunge`
+    /// instead of [`Self::expunge`] when resynchronizing with the server, the client can ensure that it
     /// does not inadvertantly remove any messages that have been marked as [`Flag::Deleted`] by
     /// other clients between the time that the client was last connected and the time the client
     /// resynchronizes.

src/lib.rs

@@ -8,9 +8,11 @@
 //! challenge/response authentication respectively. This in turn gives you an authenticated
 //! [`Session`], which lets you access the mailboxes at the server.
 //!
-//! The documentation within this crate borrows heavily from the various RFCs, but should not be
-//! considered a complete reference. If anything is unclear, follow the links to the RFCs embedded
-//! in the documentation for the various types and methods and read the raw text there!
+//! The documentation within this crate borrows heavily from the various RFCs,
+//! but should not be considered a complete reference.
+//! If anything is unclear,
+//! follow the links to the RFCs embedded in the documentation
+//! for the various types and methods and read the raw text there!
 //!
 //! Below is a basic client example. See the `examples/` directory for more.
 //!

src/types/capabilities.rs

@@ -40,7 +40,7 @@ impl From<&CapabilityRef<'_>> for Capability {
 /// authentication mechanism.
 ///
 /// The `LOGINDISABLED` capability indicates that the `LOGIN` command is disabled, and that the
-/// server will respond with a [`super::Error::No`] response to any attempt to use the `LOGIN`
+/// server will respond with a [`crate::error::Error::No`] response to any attempt to use the `LOGIN`
 /// command even if the user name and password are valid.  An IMAP client MUST NOT issue the
 /// `LOGIN` command if the server advertises the `LOGINDISABLED` capability.
 ///

src/types/id_generator.rs

@@ -1,11 +1,14 @@
 use imap_proto::RequestId;
 
+/// Request ID generator.
 #[derive(Debug)]
 pub struct IdGenerator {
+    /// Last returned ID.
     next: u64,
 }
 
 impl IdGenerator {
+    /// Creates a new request ID generator.
     pub fn new() -> Self {
         Self { next: 0 }
     }

src/types/quota.rs

@@ -3,7 +3,7 @@ use imap_proto::types::QuotaResource as QuotaResourceRef;
 use imap_proto::types::QuotaResourceName as QuotaResourceNameRef;
 use imap_proto::types::QuotaRoot as QuotaRootRef;
 
-/// https://tools.ietf.org/html/rfc2087#section-3
+/// <https://tools.ietf.org/html/rfc2087#section-3>
 #[derive(Debug, Eq, PartialEq, Hash, Clone)]
 pub enum QuotaResourceName {
     /// Sum of messages' RFC822.SIZE, in units of 1024 octets
@@ -24,7 +24,7 @@ impl<'a> From<QuotaResourceNameRef<'a>> for QuotaResourceName {
     }
 }
 
-/// 5.1. QUOTA Response (https://tools.ietf.org/html/rfc2087#section-5.1)
+/// 5.1. QUOTA Response (<https://tools.ietf.org/html/rfc2087#section-5.1>)
 #[derive(Debug, Eq, PartialEq, Hash, Clone)]
 pub struct QuotaResource {
     /// name of the resource
@@ -46,13 +46,13 @@ impl<'a> From<QuotaResourceRef<'a>> for QuotaResource {
 }
 
 impl QuotaResource {
-    /// gets the usage percentage of a QuotaResource
+    /// Returns the usage percentage of a QuotaResource.
     pub fn get_usage_percentage(&self) -> u64 {
         self.usage.saturating_mul(100) / self.limit
     }
 }
 
-/// 5.1. QUOTA Response (https://tools.ietf.org/html/rfc2087#section-5.1)
+/// 5.1. QUOTA Response (<https://tools.ietf.org/html/rfc2087#section-5.1>)
 #[derive(Debug, Eq, PartialEq, Hash, Clone)]
 pub struct Quota {
     /// quota root name
@@ -70,7 +70,7 @@ impl<'a> From<QuotaRef<'a>> for Quota {
     }
 }
 
-/// 5.2. QUOTAROOT Response (https://tools.ietf.org/html/rfc2087#section-5.2)
+/// 5.2. QUOTAROOT Response (<https://tools.ietf.org/html/rfc2087#section-5.2>)
 #[derive(Debug, Eq, PartialEq, Hash, Clone)]
 pub struct QuotaRoot {
     /// mailbox name