Skip to content

Commit 1ffe196

Browse files
committed
posix: c_lib_ext: fnmatch: added Doxygen
Added Doxygen on new functions and on fnmatch function Signed-off-by: Harun Spago <harun.spago.code@gmail.com>
1 parent 00de0de commit 1ffe196

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

include/zephyr/posix/fnmatch.h

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,26 @@
5050
extern "C" {
5151
#endif
5252

53-
int fnmatch(const char *, const char *, int);
53+
/**
54+
* Function used to check if the given pattern is in the string, using the given flags
55+
*
56+
* @param pattern pattern that is matched against the string
57+
* @param string string that is checked for the pattern
58+
* @param flags used to signal special matching conditions
59+
* FNM_NOESCAPE 0x01 Disable backslash escaping.
60+
* FNM_PATHNAME 0x02 Slash must be matched by slash.
61+
* FNM_PERIOD 0x04 Period must be matched by period.
62+
* FNM_CASEFOLD 0x08 Pattern is matched case-insensitive
63+
* FNM_LEADING_DIR 0x10 Ignore /<tail> after Imatch.
64+
*
65+
*
66+
* @return int
67+
* @retval 0 pattern found in string
68+
* @retval FNM_NOMATCH pattern not found in string
69+
* @retval FNM_NORES recursion limit reached
70+
* @retval FNM_NOSYS function not implemented
71+
*/
72+
int fnmatch(const char *pattern, const char *string, int flags);
5473

5574
#ifdef __cplusplus
5675
}

0 commit comments

Comments
 (0)