Skip to content

Commit 87c5e3e

Browse files
committed
doc: add documentation for validatePlatform function
1 parent c621800 commit 87c5e3e

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

libs/validators.h

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,16 @@ int validateGeneration(char* generation);
3838
*/
3939
int validatePattern(char* pattern);
4040

41-
// TODO: Documentation
41+
/**
42+
* @brief Validates a platform.
43+
*
44+
* This function checks if a provided platform matches `console`, `simple directmedia layer (sdl)`,
45+
* `simple directmedia layer`, or `sdl`. The comparison is case insensitive.
46+
*
47+
* @param platform The platform to be validated.
48+
*
49+
* @return 1 if the platform is valid, 0 otherwise.
50+
*/
4251
int validatePlatform(char* platform);
4352

4453
#endif // VALIDATORS_H_INCLUDED

0 commit comments

Comments
 (0)