Merge pull request #8 from EniumRaphael/raph

docs(cmds): correction of the documentation in function
This commit is contained in:
Raphaël 2025-06-02 23:22:18 +02:00 committed by GitHub
commit 60bb0d7258
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 11 additions and 7 deletions

View file

@ -6,7 +6,7 @@
/* By: rparodi <rparodi@student.42.fr> +#+ +:+ +#+ */ /* By: rparodi <rparodi@student.42.fr> +#+ +:+ +#+ */
/* +#+#+#+#+#+ +#+ */ /* +#+#+#+#+#+ +#+ */
/* Created: 2025/05/24 17:29:48 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; return true;
} }
/**
* @brief Execute the join command
* @note To join a new channel
*/
void Join::execute() { void Join::execute() {
if (checkArgs() == false) { if (checkArgs() == false) {
ERROR_MSG("Invalid arguments for Join command (see warning message)"); ERROR_MSG("Invalid arguments for Join command (see warning message)");

View file

@ -6,7 +6,7 @@
/* By: rparodi <rparodi@student.42.fr> +#+ +:+ +#+ */ /* By: rparodi <rparodi@student.42.fr> +#+ +:+ +#+ */
/* +#+#+#+#+#+ +#+ */ /* +#+#+#+#+#+ +#+ */
/* Created: 2025/05/24 17:29:48 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 * @brief Execute the Notice command
* @note To send a private message to a user / a channel * @note To send a private message to a user / a channel (like privmsg but without error)
*/ */
void Notice::execute() { void Notice::execute() {
if (checkArgs() == false) { if (checkArgs() == false) {
ERROR_MSG("Invalid arguments for PRIVMSG command (see warning message)"); ERROR_MSG("Invalid arguments for NOTICE command (see warning message)");
return; return;
} }
// check how the com // check how the com

View file

@ -6,7 +6,7 @@
/* By: rparodi <rparodi@student.42.fr> +#+ +:+ +#+ */ /* By: rparodi <rparodi@student.42.fr> +#+ +:+ +#+ */
/* +#+#+#+#+#+ +#+ */ /* +#+#+#+#+#+ +#+ */
/* Created: 2025/05/24 17:29:48 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 * @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() { void Pass::execute() {
if (checkArgs() == false) { if (checkArgs() == false) {