Add remaining documentation

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

diff --git a/include/contrac/contrac_private.h b/include/contrac/contrac_private.h
index 68d5aad..570060c 100644 (file)
--- a/include/contrac/contrac_private.h
+++ b/include/contrac/contrac_private.h
@@ -1,17 +1,22 @@
-/** \ingroup contrac
+/** \ingroup KeyGeneration
  * @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 Private header for the Core Contact Tracing functionality 
  * @section DESCRIPTION
  *
+ * This provides access to private functionality in the \ref Contrac class.
  *
- *
+ */
+
+/** \addtogroup KeyGeneration
+ *  @{
  */
 
 #ifndef __CONTRAC_PRIVATE_H
@@ -29,10 +34,9 @@
 
 // Function prototypes
 
-void contrac_set_tracing_key(Contrac * data, unsigned char const * tracing_key);
-bool contrac_set_tracing_key_base64(Contrac * data, char const * tracing_key);
-
 // Function definitions
 
 #endif // __CONTRAC_PRIVATE_H
 
+/** @} addtogroup KeyGeneration */
+