doc: improve documentation of validatePattern function

hozlucas28 · hozlucas28 · commit 8f8a5fb9eb31 · 2024-09-19T17:06:13.000-03:00
diff --git a/libs/validators.h b/libs/validators.h
@@ -27,12 +27,12 @@ int validateDelay(char* delay);
 int validateGeneration(char* generation);
 
 /**
- * @brief Validates the pattern of user input.
+ * @brief Validates a pattern.
  *
- * This function checks if the user input matches `glider`, `toad`, `press`, or
- * `glider cannon` pattern. The comparison is case insensitive.
+ * This function checks if a provided pattern matches `glider`, `toad`, `press`, or
+ * `glider cannon`. The comparison is case insensitive.
  *
- * @param userInput The user input to be validated.
+ * @param userInput The pattern to be validated.
  *
  * @return 1 if the pattern is valid, 0 otherwise.
  */

Original file line number	Diff line number	Diff line change
`@@ -27,12 +27,12 @@ int validateDelay(char* delay);`
`27`	`27`	`int validateGeneration(char* generation);`
`28`	`28`
`29`	`29`	`/**`
`30`		`- * @brief Validates the pattern of user input.`
	`30`	`+ * @brief Validates a pattern.`
`31`	`31`	`*`
`32`		- * This function checks if the user input matches `glider`, `toad`, `press`, or
`33`		- * `glider cannon` pattern. The comparison is case insensitive.
	`32`	+ * This function checks if a provided pattern matches `glider`, `toad`, `press`, or
	`33`	+ * `glider cannon`. The comparison is case insensitive.
`34`	`34`	`*`
`35`		`- * @param userInput The user input to be validated.`
	`35`	`+ * @param userInput The pattern to be validated.`
`36`	`36`	`*`
`37`	`37`	`* @return 1 if the pattern is valid, 0 otherwise.`
`38`	`38`	`*/`