From c4fa868345da1cfcfeac3729a3756d1854560a0e Mon Sep 17 00:00:00 2001
From: yggverse <yggverse@project>
Date: Fri, 1 Nov 2024 19:12:19 +0200
Subject: [PATCH] add documentation comments

---
 src/client/response/meta/status.rs | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/src/client/response/meta/status.rs b/src/client/response/meta/status.rs
index 45f386b..1d0c719 100644
--- a/src/client/response/meta/status.rs
+++ b/src/client/response/meta/status.rs
@@ -1,37 +1,34 @@
-//! Parser and holder API for [Status code](https://geminiprotocol.net/docs/protocol-specification.gmi#status-codes)
+//! Parser and holder tools for
+//! [Status code](https://geminiprotocol.net/docs/protocol-specification.gmi#status-codes)
 
 pub mod error;
 pub use error::Error;
 
 use glib::GString;
 
+/// Holder for [status code](https://geminiprotocol.net/docs/protocol-specification.gmi#status-codes)
 #[derive(Debug)]
 pub enum Status {
     // Input
     Input = 10,
     SensitiveInput = 11,
-
     // Success
     Success = 20,
-
     // Redirect
     Redirect = 30,
     PermanentRedirect = 31,
-
     // Temporary failure
     TemporaryFailure = 40,
     ServerUnavailable = 41,
     CgiError = 42,
     ProxyError = 43,
     SlowDown = 44,
-
     // Permanent failure
     PermanentFailure = 50,
     NotFound = 51,
     ResourceGone = 52,
     ProxyRequestRefused = 53,
     BadRequest = 59,
-
     // Client certificates
     CertificateRequest = 60,
     CertificateUnauthorized = 61,
@@ -39,6 +36,9 @@ pub enum Status {
 }
 
 impl Status {
+    /// Create new `Self` from UTF-8 buffer
+    ///
+    /// * includes `Self::from_string` parser, it means that given buffer should contain some **header**
     pub fn from_utf8(buffer: &[u8]) -> Result<Self, Error> {
         match buffer.get(0..2) {
             Some(value) => match GString::from_utf8(value.to_vec()) {
@@ -49,6 +49,7 @@ impl Status {
         }
     }
 
+    /// Create new `Self` from string that includes **header**
     pub fn from_string(code: &str) -> Result<Self, Error> {
         match code {
             // Input