Skip to content

Commit f325c05

Browse files
committed
doc: create time module documentation
1 parent 2d5c329 commit f325c05

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

libs/time/main.h

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
#ifndef LIBS__TIME_H_INCLUDED
22
#define LIBS__TIME_H_INCLUDED
33

4+
/**
5+
* @brief Concatenates the current time to the given string.
6+
*
7+
* This function retrieves the current system time and appends it to the provided string.
8+
* The concatenated time format is YYYY-MM-DD-HH-mm.
9+
*
10+
* @param string String on which the current time will be concatenated.
11+
*
12+
* @return 0 if the operation is successful, 1 otherwise.
13+
*
14+
* @warning Ensure that the provided string has sufficient space to hold the concatenated time.
15+
*/
416
unsigned char concatCurrentTime(char* string);
517

618
#endif // LIBS__TIME_H_INCLUDED

0 commit comments

Comments
 (0)