Add remaining documentation

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

diff --git a/include/contrac/rpi_list.h b/include/contrac/rpi_list.h
index 7814708..03584d4 100644 (file)
--- a/include/contrac/rpi_list.h
+++ b/include/contrac/rpi_list.h
@@ -1,17 +1,25 @@
-/** \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 Provides a list of RPIs 
  * @section DESCRIPTION
  *
+ * This class allows the simplified management of lists of Rpi objects. This is
+ * useful when checking DTKs received from a Diagnosis Server with RPIs
+ * captured over Bluetooth. Combined with the \ref DtkList class the two can
+ * be easily stored and passed into the \ref match_list_find_matches() function.
  *
- *
+ */
+
+/** \addtogroup Containers
+ *  @{
  */
 
 #ifndef __RPI_LIST_H
@@ -26,7 +34,18 @@
 
 // Structures
 
+/**
+ * An opaque structure that represents the head of the list.
+ * 
+ * The internal structure can be found in rpi_list.c
+ */
 typedef struct _RpiList RpiList;
+
+/**
+ * An opaque structure that represents an item in the list.
+ * 
+ * The internal structure can be found in rpi_list.c
+ */
 typedef struct _RpiListItem RpiListItem;
 
 // Function prototypes
@@ -35,6 +54,7 @@ RpiList * rpi_list_new();
 void rpi_list_delete(RpiList * data);
 
 void rpi_list_append(RpiList * data, Rpi * rpi);
+void rpi_list_add_beacon(RpiList * data, unsigned char const * rpi_bytes, uint8_t time_interval_number);
 
 RpiListItem const * rpi_list_first(RpiList const * data);
 RpiListItem const * rpi_list_next(RpiListItem const * data);
@@ -44,4 +64,5 @@ Rpi const * rpi_list_get_rpi(RpiListItem const * data);
 
 #endif // __RPI_LIST_H
 
+/** @} addtogroup Containers*/