fix some docs

actix-http/src/h1/dispatcher.rs

@@ -27,6 +27,7 @@ use crate::{
 
 use super::{
     codec::Codec,
+    decoder::MAX_BUFFER_SIZE,
     payload::{Payload, PayloadSender, PayloadStatus},
     Message, MessageType,
 };
@@ -793,7 +794,6 @@ where
     /// Returns true when io stream can be disconnected after write to it.
     ///
     /// It covers these conditions:
-    ///
     /// - `std::io::ErrorKind::ConnectionReset` after partial read.
     /// - all data read done.
     #[inline(always)]
@@ -813,46 +813,39 @@ where
 
         loop {
             // Return early when read buf exceed decoder's max buffer size.
-            if this.read_buf.len() >= super::decoder::MAX_BUFFER_SIZE {
+            if this.read_buf.len() >= MAX_BUFFER_SIZE {
-                /*
+                // At this point it's not known IO stream is still scheduled to be waked up so
-                 At this point it's not known IO stream is still scheduled
+                // force wake up dispatcher just in case.
-                 to be waked up. so force wake up dispatcher just in case.
+                //
+                // Reason:
+                // AsyncRead mostly would only have guarantee wake up when the poll_read
+                // return Poll::Pending.
+                //
+                // Case:
+                // When read_buf is beyond max buffer size the early return could be successfully
+                // be parsed as a new Request. This case would not generate ParseError::TooLarge and
+                // at this point IO stream is not fully read to Pending and would result in
+                // dispatcher stuck until timeout (KA)
+                //
+                // Note:
+                // This is a perf choice to reduce branch on <Request as MessageType>::decode.
+                //
+                // A Request head too large to parse is only checked on
+                // `httparse::Status::Partial` condition.
 
-                 Reason:
-                 AsyncRead mostly would only have guarantee wake up
-                 when the poll_read return Poll::Pending.
-
-                 Case:
-                 When read_buf is beyond max buffer size the early return
-                 could be successfully be parsed as a new Request.
-                 This case would not generate ParseError::TooLarge
-                 and at this point IO stream is not fully read to Pending
-                 and would result in dispatcher stuck until timeout (KA)
-
-                 Note:
-                 This is a perf choice to reduce branch on
-                 <Request as MessageType>::decode.
-
-                 A Request head too large to parse is only checked on
-                 httparse::Status::Partial condition.
-                */
                 if this.payload.is_none() {
-                    /*
+                    // When dispatcher has a payload the responsibility of wake up it would be shift
-                    When dispatcher has a payload the responsibility of
+                    // to h1::payload::Payload.
-                    wake up it would be shift to h1::payload::Payload.
+                    //
-
+                    // Reason:
-                    Reason:
+                    // Self wake up when there is payload would waste poll and/or result in
-                    Self wake up when there is payload would waste poll
+                    // over read.
-                    and/or result in over read.
+                    //
-
+                    // Case:
-                    Case:
+                    // When payload is (partial) dropped by user there is no need to do
-                    When payload is (partial) dropped by user there is
+                    // read anymore. At this case read_buf could always remain beyond
-                    no need to do read anymore.
+                    // MAX_BUFFER_SIZE and self wake up would be busy poll dispatcher and
-                    At this case read_buf could always remain beyond
+                    // waste resources.
-                    MAX_BUFFER_SIZE and self wake up would be busy poll
-                    dispatcher and waste resource.
-
-                    */
                     cx.waker().wake_by_ref();
                 }
 

actix-http/src/h2/dispatcher.rs

@@ -109,7 +109,7 @@ where
                 Poll::Ready(Some((req, tx))) => {
                     let (parts, body) = req.into_parts();
                     let pl = crate::h2::Payload::new(body);
-                    let pl = Payload::<crate::payload::PayloadStream>::H2(pl);
+                    let pl = Payload::H2(pl);
                     let mut req = Request::with_payload(pl);
 
                     let head = req.head_mut();

actix-http/src/header/as_name.rs

@@ -6,7 +6,7 @@ use http::header::{HeaderName, InvalidHeaderName};
 
 /// Sealed trait implemented for types that can be effectively borrowed as a [`HeaderValue`].
 ///
-/// [`HeaderValue`]: crate::http::HeaderValue
+/// [`HeaderValue`]: super::HeaderValue
 pub trait AsHeaderName: Sealed {}
 
 pub struct Seal;

actix-http/src/header/into_pair.rs

@@ -12,7 +12,7 @@ use super::{Header, IntoHeaderValue};
 /// An interface for types that can be converted into a [`HeaderName`]/[`HeaderValue`] pair for
 /// insertion into a [`HeaderMap`].
 ///
-/// [`HeaderMap`]: crate::http::HeaderMap
+/// [`HeaderMap`]: super::HeaderMap
 pub trait IntoHeaderPair: Sized {
     type Error: Into<HttpError>;
 

actix-http/src/response_builder.rs

@@ -47,7 +47,8 @@ impl ResponseBuilder {
     /// Create response builder
     ///
     /// # Examples
-    //    /// use actix_http::{Response, ResponseBuilder, StatusCode};, / ``
+    /// ```
+    /// use actix_http::{Response, ResponseBuilder, StatusCode};
     /// let res: Response<_> = ResponseBuilder::default().finish();
     /// assert_eq!(res.status(), StatusCode::OK);
     /// ```
@@ -62,7 +63,8 @@ impl ResponseBuilder {
     /// Set HTTP status code of this response.
     ///
     /// # Examples
-    //    /// use actix_http::{ResponseBuilder, StatusCode};, / ``
+    /// ```
+    /// use actix_http::{ResponseBuilder, StatusCode};
     /// let res = ResponseBuilder::default().status(StatusCode::NOT_FOUND).finish();
     /// assert_eq!(res.status(), StatusCode::NOT_FOUND);
     /// ```

src/error/mod.rs

@@ -2,7 +2,7 @@
 
 /// This is meant to be a glob import of the whole error module, but rustdoc can't handle
 /// shadowing `Error` type, so it is expanded manually.
-/// See https://github.com/rust-lang/rust/issues/83375
+/// See <https://github.com/rust-lang/rust/issues/83375>
 pub use actix_http::error::{
     BlockingError, ContentTypeError, DispatchError, HttpError, ParseError, PayloadError,
 };

src/request.rs

@@ -174,7 +174,7 @@ impl HttpRequest {
     /// let opt_t = req.conn_data::<PeerCertificate>();
     /// ```
     ///
-    /// [on-connect]: crate::HttpServiceBuilder::on_connect_ext
+    /// [on-connect]: crate::HttpServer::on_connect
     pub fn conn_data<T: 'static>(&self) -> Option<&T> {
         self.inner
             .conn_data