fix docs

1148118271 · Sep 16, 2023 · 22c6a3c · 22c6a3c
1 parent 512a01f
commit 22c6a3c
Show file tree

Hide file tree

Showing 9 changed files with 13 additions and 13 deletions.
diff --git a/src/algorithm/encryption/mod.rs b/src/algorithm/encryption/mod.rs
@@ -11,7 +11,7 @@ use crate::SshResult;
 
 use super::{hash::HashCtx, mac::MacNone, Enc};
 
-/// https://www.rfc-editor.org/rfc/rfc4253#section-6.3
+/// <https://www.rfc-editor.org/rfc/rfc4253#section-6.3>
 pub(crate) trait Encryption: Send + Sync {
     fn bsize(&self) -> usize;
     fn iv_size(&self) -> usize;

diff --git a/src/algorithm/hash/hash.rs b/src/algorithm/hash/hash.rs
@@ -3,7 +3,7 @@ use crate::algorithm::hash;
 use crate::algorithm::hash::HashType;
 use crate::constant;
 
-/// https://www.rfc-editor.org/rfc/rfc4253#section-7.2
+/// <https://www.rfc-editor.org/rfc/rfc4253#section-7.2>
 ///
 /// The key exchange produces two values: a shared secret K, and an
 /// exchange hash H.  Encryption and authentication keys are derived from

diff --git a/src/algorithm/hash/hash_ctx.rs b/src/algorithm/hash/hash_ctx.rs
@@ -1,6 +1,6 @@
 use crate::model::Data;
 
-/// https://www.rfc-editor.org/rfc/rfc4253#section-7.2
+/// <https://www.rfc-editor.org/rfc/rfc4253#section-7.2>
 ///
 /// The key exchange produces two values: a shared secret K, and an
 /// exchange hash H.  Encryption and authentication keys are derived from

diff --git a/src/algorithm/key_exchange/mod.rs b/src/algorithm/key_exchange/mod.rs
@@ -5,7 +5,7 @@ use ring::agreement::{EphemeralPrivateKey, UnparsedPublicKey};
 
 /// # Algorithms that used for key exchange
 ///
-/// https://www.rfc-editor.org/rfc/rfc4253#section-7
+/// <https://www.rfc-editor.org/rfc/rfc4253#section-7>
 mod curve25519;
 mod dh;
 mod ecdh_sha2_nistp256;

diff --git a/src/algorithm/public_key/mod.rs b/src/algorithm/public_key/mod.rs
@@ -12,7 +12,7 @@ use ed25519::Ed25519;
 
 /// # Public Key Algorithms
 ///
-/// https://www.rfc-editor.org/rfc/rfc4253#section-6.6
+/// <https://www.rfc-editor.org/rfc/rfc4253#section-6.6>
 
 pub(crate) trait PublicKey: Send + Sync {
     fn new() -> Self

diff --git a/src/constant.rs b/src/constant.rs
@@ -85,7 +85,7 @@ pub(crate) mod size {
     pub const LOCAL_WINDOW_SIZE: u32 = 2097152;
 }
 
-/// https://www.rfc-editor.org/rfc/rfc4254#section-9
+/// <https://www.rfc-editor.org/rfc/rfc4254#section-9>
 #[allow(dead_code)]
 pub(crate) mod ssh_connection_code {
     pub const GLOBAL_REQUEST: u8 = 80;
@@ -104,7 +104,7 @@ pub(crate) mod ssh_connection_code {
     pub const CHANNEL_FAILURE: u8 = 100;
 }
 
-/// https://www.rfc-editor.org/rfc/rfc4254#section-5.1
+/// <https://www.rfc-editor.org/rfc/rfc4254#section-5.1>
 #[allow(dead_code)]
 pub(crate) mod ssh_channel_fail_code {
     pub const ADMINISTRATIVELY_PROHIBITED: u32 = 1;
@@ -113,7 +113,7 @@ pub(crate) mod ssh_channel_fail_code {
     pub const RESOURCE_SHORTAGE: u32 = 4;
 }
 
-/// https://www.rfc-editor.org/rfc/rfc4253#section-12
+/// <https://www.rfc-editor.org/rfc/rfc4253#section-12>
 #[allow(dead_code)]
 pub(crate) mod ssh_transport_code {
     pub const DISCONNECT: u8 = 1;
@@ -128,7 +128,7 @@ pub(crate) mod ssh_transport_code {
     pub const KEXDH_REPLY: u8 = 31;
 }
 
-/// https://www.rfc-editor.org/rfc/rfc4253#section-11.1
+/// <https://www.rfc-editor.org/rfc/rfc4253#section-11.1>
 #[allow(dead_code)]
 pub(crate) mod ssh_disconnection_code {
     pub const HOST_NOT_ALLOWED_TO_CONNECT: u8 = 1;
@@ -148,7 +148,7 @@ pub(crate) mod ssh_disconnection_code {
     pub const ILLEGAL_USER_NAME: u8 = 15;
 }
 
-/// https://www.rfc-editor.org/rfc/rfc4252#section-6
+/// <https://www.rfc-editor.org/rfc/rfc4252#section-6>
 #[allow(dead_code)]
 pub(crate) mod ssh_user_auth_code {
     pub const REQUEST: u8 = 50;

diff --git a/src/model/data.rs b/src/model/data.rs
@@ -5,7 +5,7 @@ use crate::error::SshResult;
 use super::Packet;
 
 /// Data Type Representations Used in the SSH Protocols
-/// https://www.rfc-editor.org/rfc/rfc4251#section-5
+/// <https://www.rfc-editor.org/rfc/rfc4251#section-5>
 
 /// byte
 ///

diff --git a/src/model/packet.rs b/src/model/packet.rs
@@ -8,7 +8,7 @@ use super::timeout::Timeout;
 
 /// ## Binary Packet Protocol
 ///
-/// https://www.rfc-editor.org/rfc/rfc4253#section-6
+/// <https://www.rfc-editor.org/rfc/rfc4253#section-6>
 ///
 /// uint32 `packet_length`
 ///

diff --git a/src/session/session_broker.rs b/src/session/session_broker.rs
@@ -74,7 +74,7 @@ impl SessionBroker {
         self.open_shell_terminal(TerminalSize::from(80, 24))
     }
 
-    /// open a [LocalShell] channel
+    /// open a [ShellBrocker] channel
     ///
     /// custom terminal dimensions
     ///