From 95ed48517b38ba6778584d85754aba723341b07a Mon Sep 17 00:00:00 2001 From: joaoviictorti Date: Fri, 4 Oct 2024 11:14:59 -0300 Subject: [PATCH] docs(client): Adjusts documentation to use 'Arguments' instead of 'Parameters --- client/src/utils/keylogger.rs | 4 ++-- client/src/utils/mod.rs | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/client/src/utils/keylogger.rs b/client/src/utils/keylogger.rs index 959a8b5..238ed7d 100644 --- a/client/src/utils/keylogger.rs +++ b/client/src/utils/keylogger.rs @@ -15,7 +15,7 @@ pub unsafe fn update_key_state() { /// Checks if a key has been pressed. /// -/// # Parameters +/// # Arguments /// /// - `key`: The key code. /// @@ -31,7 +31,7 @@ pub unsafe fn key_pressed(key: u8) -> bool { /// Converts a virtual key code to a character. /// -/// # Parameters +/// # Arguments /// /// - `key`: The code for the virtual key. /// diff --git a/client/src/utils/mod.rs b/client/src/utils/mod.rs index 8dd6349..e45c03c 100644 --- a/client/src/utils/mod.rs +++ b/client/src/utils/mod.rs @@ -33,7 +33,7 @@ pub const BANNER: &str = r#" /// Checks if the given file exists. /// -/// # Parameters +/// # Arguments /// /// - `file` - A string reference representing the file path. /// @@ -78,7 +78,7 @@ pub fn open_driver() -> Result { /// Initializes the logger with the specified verbosity level. /// -/// # Parameters +/// # Arguments /// /// - `verbose` - A `u8` representing the verbosity level. /// - `0` for `Info` level. @@ -110,7 +110,7 @@ pub fn init_logger(verbose: u8) { /// Validates that a given file has a `.sys` extension. /// -/// # Parameters +/// # Arguments /// /// - `val` - A string slice representing the file name. /// @@ -129,11 +129,11 @@ pub fn validate_sys_extension(val: &str) -> Result { /// Searches for the process ID (PID) of a running process by name. /// -/// # Parameters +/// # Arguments /// /// - `name`: A reference to a string containing the name of the process to be searched. /// -/// # Return +/// # Returns /// /// -`Option`: Returns the PID of the process found, or `None` if no process with the specified name is found. ///