Add remaining documentation

[libcontrac.git] / include / contrac / utils.h

diff --git a/include/contrac/utils.h b/include/contrac/utils.h
index 38b0c3f..0f40c8c 100644 (file)
--- a/include/contrac/utils.h
+++ b/include/contrac/utils.h
@@ -1,25 +1,34 @@
-/** \ingroup contrac
+/** \ingroup Utils
  * @file
- * @author     David Llewellyn-Jones
+ * @author     David Llewellyn-Jones <david@flypig.co.uk>
  * @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
 
 // Includes
 
+#include <time.h>
+
 // Defines
 
 #define MAX(a,b) \
@@ -41,11 +50,12 @@ size_t base64_decode_size(size_t base64_input);
 void base64_encode_binary_to_base64(unsigned char const *input, size_t input_size, unsigned char *output, size_t *output_size);
 void base64_decode_base64_to_binary(unsigned char const *input, size_t input_size, unsigned char *output, size_t *output_size);
 
+uint32_t epoch_to_day_number(time_t epoch);
+uint8_t epoch_to_time_interval_number(time_t epoch);
+
 // Function definitions
 
 #endif // __UTILS_H
 
-
-
-
+/** @} addtogroup Utils */