From f22cabd4f46bf3b2c84155bb7359d7674dbe2c97 Mon Sep 17 00:00:00 2001 From: Raphael Date: Mon, 2 Jun 2025 22:41:29 +0200 Subject: [PATCH 1/3] docs(cmd/pass): adding the documentation for pass cmd --- sources/commands/pass.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sources/commands/pass.cpp b/sources/commands/pass.cpp index ef799b2..3991e90 100644 --- a/sources/commands/pass.cpp +++ b/sources/commands/pass.cpp @@ -6,7 +6,7 @@ /* By: rparodi +#+ +:+ +#+ */ /* +#+#+#+#+#+ +#+ */ /* Created: 2025/05/24 17:29:48 by rparodi #+# #+# */ -/* Updated: 2025/05/29 12:41:39 by rparodi ### ########.fr */ +/* Updated: 2025/06/02 22:41:12 by rparodi ### ########.fr */ /* */ /* ************************************************************************** */ @@ -30,7 +30,7 @@ bool Pass::checkArgs() { /** * @brief Execute the Pass command - * @note To Pass a users to join a channel (from an operator) + * @note To connect a user with the password */ void Pass::execute() { if (checkArgs() == false) { From 99619310dba8f95860039f7328038dbbd0f5ce57 Mon Sep 17 00:00:00 2001 From: Raphael Date: Mon, 2 Jun 2025 22:42:34 +0200 Subject: [PATCH 2/3] docs(cmd/join): adding the documentation for join cmd --- sources/commands/join.cpp | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/sources/commands/join.cpp b/sources/commands/join.cpp index 031e676..8935a74 100644 --- a/sources/commands/join.cpp +++ b/sources/commands/join.cpp @@ -6,7 +6,7 @@ /* By: rparodi +#+ +:+ +#+ */ /* +#+#+#+#+#+ +#+ */ /* Created: 2025/05/24 17:29:48 by rparodi #+# #+# */ -/* Updated: 2025/05/26 22:56:16 by rparodi ### ########.fr */ +/* Updated: 2025/06/02 22:42:17 by rparodi ### ########.fr */ /* */ /* ************************************************************************** */ @@ -44,6 +44,10 @@ bool Join::checkArgs() { return true; } +/** + * @brief Execute the join command + * @note To join a new channel + */ void Join::execute() { if (checkArgs() == false) { ERROR_MSG("Invalid arguments for Join command (see warning message)"); From a955a426ba323b6f1cc9dcd9420e50772353fe9f Mon Sep 17 00:00:00 2001 From: Raphael Date: Mon, 2 Jun 2025 23:20:22 +0200 Subject: [PATCH 3/3] docs(cmd/notice): correct the documentation of notice --- sources/commands/notice.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/sources/commands/notice.cpp b/sources/commands/notice.cpp index 9985b3c..e54d10e 100644 --- a/sources/commands/notice.cpp +++ b/sources/commands/notice.cpp @@ -6,7 +6,7 @@ /* By: rparodi +#+ +:+ +#+ */ /* +#+#+#+#+#+ +#+ */ /* Created: 2025/05/24 17:29:48 by rparodi #+# #+# */ -/* Updated: 2025/06/02 01:18:05 by rparodi ### ########.fr */ +/* Updated: 2025/06/02 22:44:49 by rparodi ### ########.fr */ /* */ /* ************************************************************************** */ @@ -45,12 +45,12 @@ bool Notice::checkArgs() { } /** - * @brief Execute the PrivMsg command - * @note To send a private message to a user / a channel + * @brief Execute the Notice command + * @note To send a private message to a user / a channel (like privmsg but without error) */ void Notice::execute() { if (checkArgs() == false) { - ERROR_MSG("Invalid arguments for PRIVMSG command (see warning message)"); + ERROR_MSG("Invalid arguments for NOTICE command (see warning message)"); return; } // check how the com