X-Git-Url: https://www.flypig.org.uk/git/?p=libcontrac.git;a=blobdiff_plain;f=include%2Fcontrac%2Futils.h;h=0f40c8c8c0b6d7fd3d6933517375d9f912c8cfe1;hp=41df6d1318535b3637fc81841a399c0aafd744ed;hb=e48c390a86b448137a87d0d0a5863c202ba66abd;hpb=f8c83387f5abffa94e59332382441a71f5b95545 diff --git a/include/contrac/utils.h b/include/contrac/utils.h index 41df6d1..0f40c8c 100644 --- a/include/contrac/utils.h +++ b/include/contrac/utils.h @@ -1,19 +1,26 @@ -/** \ingroup contrac +/** \ingroup Utils * @file - * @author David Llewellyn-Jones + * @author David Llewellyn-Jones * @version $(VERSION) * * @section LICENSE * + * Copyright David Llewellyn-Jones, 2020 + * Released under the GPLv2. * - * - * @brief + * @brief Static utility functions * @section DESCRIPTION * + * Provides various static utitlity functions. In particular: * + * base64 encoding and decoding functionality. + * Time conversion: from epoch to day numbers and time interval numbers. * */ +/** \addtogroup Utils + * @{ + */ #ifndef __UTILS_H #define __UTILS_H @@ -50,7 +57,5 @@ uint8_t epoch_to_time_interval_number(time_t epoch); #endif // __UTILS_H - - - +/** @} addtogroup Utils */