Skip to content

Commit 936b18f

Browse files
committed
chore: fix doc comments
Signed-off-by: Egor Lazarchuk <[email protected]>
1 parent 9e748fd commit 936b18f

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

Cargo.lock

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/common/headers.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -251,8 +251,8 @@ impl Headers {
251251

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

src/request.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -166,11 +166,11 @@ pub struct Request {
166166
impl Request {
167167
/// Parses a byte slice into a HTTP Request.
168168
///
169-
/// The byte slice is expected to have the following format: </br>
170-
/// * Request Line: "GET SP Request-uri SP HTTP/1.0 CRLF" - Mandatory </br>
171-
/// * Request Headers "<headers> CRLF"- Optional </br>
172-
/// * Empty Line "CRLF" </br>
173-
/// * Entity Body - Optional </br>
169+
/// The byte slice is expected to have the following format: <br/>
170+
/// * Request Line: "GET SP Request-uri SP HTTP/1.0 CRLF" - Mandatory <br/>
171+
/// * Request Headers "`<headers>` CRLF"- Optional <br/>
172+
/// * Empty Line "CRLF" <br/>
173+
/// * Entity Body - Optional <br/>
174174
/// The request headers and the entity body are not parsed and None is returned because
175175
/// these are not used by the MMDS server.
176176
/// The only supported method is GET and the HTTP protocol is expected to be HTTP/1.0

src/response.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ impl ResponseHeaders {
209209
}
210210

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

0 commit comments

Comments
 (0)