chore: fix doc comments

Signed-off-by: Egor Lazarchuk <yegorlz@amazon.co.uk>

Cargo.lock

@@ -1,6 +1,6 @@
 # This file is automatically @generated by Cargo.
 # It is not intended for manual editing.
-version = 3
+version = 4
 
 [[package]]
 name = "bitflags"
@@ -24,9 +24,9 @@ dependencies = [
 
 [[package]]
 name = "vmm-sys-util"
-version = "0.12.1"
+version = "0.14.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1d1435039746e20da4f8d507a72ee1b916f7b4b05af7a91c093d2c6561934ede"
+checksum = "d21f366bf22bfba3e868349978766a965cbe628c323d58e026be80b8357ab789"
 dependencies = [
  "bitflags",
  "libc",

src/common/headers.rs

@@ -251,8 +251,8 @@ impl Headers {
 
     /// Parses a byte slice into a Headers structure for a HTTP request.
     ///
-    /// The byte slice is expected to have the following format: </br>
-    ///     * Request Header Lines "<header_line> CRLF"- Optional </br>
+    /// The byte slice is expected to have the following format: <br/>
+    ///     * Request Header Lines "<header_line> CRLF"- Optional <br/>
     /// There can be any number of request headers, including none, followed by
     /// an extra sequence of Carriage Return and Line Feed.
     /// All header fields are parsed. However, only the ones present in the

src/request.rs

@@ -166,11 +166,11 @@ pub struct Request {
 impl Request {
     /// Parses a byte slice into a HTTP Request.
     ///
-    /// The byte slice is expected to have the following format: </br>
-    ///     * Request Line: "GET SP Request-uri SP HTTP/1.0 CRLF" - Mandatory </br>
-    ///     * Request Headers "<headers> CRLF"- Optional </br>
-    ///     * Empty Line "CRLF" </br>
-    ///     * Entity Body - Optional </br>
+    /// The byte slice is expected to have the following format: <br/>
+    ///     * Request Line: "GET SP Request-uri SP HTTP/1.0 CRLF" - Mandatory <br/>
+    ///     * Request Headers "`<headers>` CRLF"- Optional <br/>
+    ///     * Empty Line "CRLF" <br/>
+    ///     * Entity Body - Optional <br/>
     /// The request headers and the entity body are not parsed and None is returned because
     /// these are not used by the MMDS server.
     /// The only supported method is GET and the HTTP protocol is expected to be HTTP/1.0

src/response.rs

@@ -209,7 +209,7 @@ impl ResponseHeaders {
     }
 
     /// Sets the `Deprecation` header to be written in the HTTP response.
-    /// https://tools.ietf.org/id/draft-dalal-deprecation-header-03.html
+    /// <https://tools.ietf.org/id/draft-dalal-deprecation-header-03.html>
     #[allow(unused)]
     pub fn set_deprecation(&mut self) {
         self.deprecation = true;
@@ -263,7 +263,7 @@ impl Response {
     /// status code is 1XX or 204. If needed, users can remove it by calling
     /// `set_content_length(None)`.
     ///
-    /// https://datatracker.ietf.org/doc/html/rfc9110#name-content-length
+    /// <https://datatracker.ietf.org/doc/html/rfc9110#name-content-length>
     /// > A server MAY send a Content-Length header field in a response to a
     /// > HEAD request (Section 9.3.2); a server MUST NOT send Content-Length
     /// > in such a response unless its field value equals the decimal number