X-Git-Url: https://www.flypig.org.uk/git/?p=libcontrac.git;a=blobdiff_plain;f=include%2Fcontrac%2Fdtk_list.h;fp=include%2Fcontrac%2Fdtk_list.h;h=b54308c3b4521170898710bacca32732b4b317df;hp=a681229c03b0dbd98983cbb7c3276d8592c3e654;hb=e48c390a86b448137a87d0d0a5863c202ba66abd;hpb=f8c83387f5abffa94e59332382441a71f5b95545

diff --git a/include/contrac/dtk_list.h b/include/contrac/dtk_list.h
index a681229..b54308c 100644
--- a/include/contrac/dtk_list.h
+++ b/include/contrac/dtk_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 DTKs 
  * @section DESCRIPTION
  *
+ * This class allows the simplified management of lists of Dtk objects. This is
+ * useful when checking DTKs received from a Diagnosis Server with RPIs
+ * captured over Bluetooth. Combined with the \ref RpiList class the two can
+ * be easily stored and passed into the \ref match_list_find_matches() function.
  *
- *
+ */
+
+/** \addtogroup Containers
+ *  @{
  */
 
 #ifndef __DTK_LIST_H
@@ -26,7 +34,18 @@
 
 // Structures
 
+/**
+ * An opaque structure that represents the head of the list.
+ * 
+ * The internal structure can be found in dtk_list.c
+ */
 typedef struct _DtkList DtkList;
+
+/**
+ * An opaque structure that represents an item in the list.
+ * 
+ * The internal structure can be found in dtk_list.c
+ */
 typedef struct _DtkListItem DtkListItem;
 
 // Function prototypes
@@ -45,4 +64,5 @@ Dtk const * dtk_list_get_dtk(DtkListItem const * data);
 
 #endif // __DTK_LIST_H
 
+/** @} addtogroup Containers*/