-/** \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
// 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
#endif // __RPI_LIST_H
+/** @} addtogroup Containers*/