projects
/
libcontrac.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Add remaining documentation
[libcontrac.git]
/
include
/
contrac
/
match.h
diff --git
a/include/contrac/match.h
b/include/contrac/match.h
index
fe38c74
..
5523eed
100644
(file)
--- a/
include/contrac/match.h
+++ b/
include/contrac/match.h
@@
-1,19
+1,29
@@
-/** \ingroup contrac
+/** \ingroup Matching
* @file
* @file
- * @author David Llewellyn-Jones
+ * @author David Llewellyn-Jones <david@flypig.co.uk>
* @version $(VERSION)
*
* @section LICENSE
*
* @version $(VERSION)
*
* @section LICENSE
*
+ * Copyright David Llewellyn-Jones, 2020
+ * Released under the GPLv2.
*
*
- *
- * @brief
+ * @brief Provides a way to match collected RPIs with downloaded DTKs
* @section DESCRIPTION
*
* @section DESCRIPTION
*
+ * This class provides functionality allowing RPIs that have been collected
+ * over Bluetooth to be matched against DTKs downloaded from a Diagnosis
+ * Server.
*
*
+ * The list of RPIs and DTKs can be constructed easily using the
+ * \ref Container functions.
*
*/
*
*/
+/** \addtogroup Matching
+ * @{
+ */
+
#ifndef __MATCH_H
#define __MATCH_H
#ifndef __MATCH_H
#define __MATCH_H
@@
-26,7
+36,18
@@
// Structures
// Structures
+/**
+ * An opaque structure that represents the head of the list.
+ *
+ * The internal structure can be found in match.c
+ */
typedef struct _MatchList MatchList;
typedef struct _MatchList MatchList;
+
+/**
+ * An opaque structure that represents an item in the list.
+ *
+ * The internal structure can be found in match.c
+ */
typedef struct _MatchListItem MatchListItem;
// Function prototypes
typedef struct _MatchListItem MatchListItem;
// Function prototypes
@@
-49,4
+70,5
@@
void match_list_find_matches(MatchList * data, RpiList * beacons, DtkList * diag
#endif // __MATCH_H
#endif // __MATCH_H
+/** @} addtogroup Matching*/