diff options
author | mvglasow <mvglasow@ffa7fe5e-494d-0410-b361-a75ebd5db220> | 2014-11-15 16:50:21 +0000 |
---|---|---|
committer | mvglasow <mvglasow@ffa7fe5e-494d-0410-b361-a75ebd5db220> | 2014-11-15 16:50:21 +0000 |
commit | bab28ff2c621410fdc7ea08e8ac444b660d9b539 (patch) | |
tree | ec89aeb02a56d632789e690b30f68acfab094177 /navit/util.c | |
parent | e23cc5b467250b9098ee41455675789f51bdfa85 (diff) | |
download | navit-bab28ff2c621410fdc7ea08e8ac444b660d9b539.tar.gz |
Refactoring:core:Add some more documentation
Signed-off-by: mvglasow <michael -at- vonglasow.com>
git-svn-id: http://svn.code.sf.net/p/navit/code/trunk/navit@5948 ffa7fe5e-494d-0410-b361-a75ebd5db220
Diffstat (limited to 'navit/util.c')
-rw-r--r-- | navit/util.c | 24 |
1 files changed, 11 insertions, 13 deletions
diff --git a/navit/util.c b/navit/util.c index e18799f01..1859d38b1 100644 --- a/navit/util.c +++ b/navit/util.c @@ -184,17 +184,15 @@ char *stristr(const char *String, const char *Pattern) #ifndef HAVE_GETDELIM /** - * Read the part of a file up to a delimiter to a string. + * @brief Reads the part of a file up to a delimiter to a string. * <p> - * Read up to (and including) a DELIMITER from FP into *LINEPTR (and - NUL-terminate it). - * @param lineptr Pointer to a pointer returned from malloc (or - NULL), pointing to a buffer. It is realloc'ed as - necessary and will receive the data read. + * Read up to (and including) a DELIMITER from FP into *LINEPTR (and NUL-terminate it). + * + * @param lineptr Pointer to a pointer returned from malloc (or NULL), pointing to a buffer. It is + * realloc'ed as necessary and will receive the data read. * @param n Size of the buffer. * - * @return Number of characters read (not including - the null terminator), or -1 on error or EOF. + * @return Number of characters read (not including the null terminator), or -1 on error or EOF. */ ssize_t getdelim (char **lineptr, size_t *n, int delimiter, FILE *fp) @@ -312,11 +310,11 @@ int gettimeofday(struct timeval *time, void *local) } #endif /** - * Convert an ISO 8601-style time string into epoch time. + * @brief Converts an ISO 8601-style time string into epoch time. * - * @param iso8601 Pointer to a string containing the time in ISO 8601 format. + * @param iso8601 Time in ISO 8601 format. * - * @return An unsigned integer representing the number of seconds elapsed since January 1, 1970, 00:00:00 UTC. + * @return The number of seconds elapsed since January 1, 1970, 00:00:00 UTC. */ unsigned int iso8601_to_secs(char *iso8601) @@ -347,9 +345,9 @@ iso8601_to_secs(char *iso8601) } /** - * Output local system time in ISO 8601 format. + * @brief Outputs local system time in ISO 8601 format. * - * @return Pointer to a string containing the time in ISO 8601 format + * @return Time in ISO 8601 format */ char * current_to_iso8601(void) |