projects
/
libcontrac.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Add documentation for Contrac and Dtk classes.
[libcontrac.git]
/
include
/
contrac
/
dtk.h
diff --git
a/include/contrac/dtk.h
b/include/contrac/dtk.h
index
c263fe2
..
ee621e5
100644
(file)
--- a/
include/contrac/dtk.h
+++ b/
include/contrac/dtk.h
@@
-1,17
+1,24
@@
-/** \ingroup contrac
+/** \ingroup DailyTracingKey
* @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 Daily Tracing Key functionality
* @section DESCRIPTION
*
* @section DESCRIPTION
*
+ * This class is used to generate and manage the Daily Tracing Key. It's
+ * largely internal. The functionality from \ref Contrac should generally be
+ * used instead of these functions.
*
*
- *
+ */
+
+/** \addtogroup DailyTracingKey
+ * @{
*/
#ifndef __DTK_H
*/
#ifndef __DTK_H
@@
-21,11
+28,26
@@
// Defines
// Defines
+/**
+ * The size in bytes of a DTK in binary format.
+ *
+ */
#define DTK_SIZE (16)
#define DTK_SIZE (16)
+
+/**
+ * The size in bytes of a DTK in base64 format, not including the null
+ * terminator.
+ *
+ */
#define DTK_SIZE_BASE64 (24)
// Structures
#define DTK_SIZE_BASE64 (24)
// Structures
+/**
+ * An opaque structure for representing a DTK.
+ *
+ * The internal structure can be found in dtk.c
+ */
typedef struct _Dtk Dtk;
// Function prototypes
typedef struct _Dtk Dtk;
// Function prototypes
@@
-42,4
+64,5
@@
void dtk_assign(Dtk * data, unsigned char const * dtk_bytes, uint32_t day_number
#endif // __DTK_H
#endif // __DTK_H
+/** @} addtogroup DailyTracingKey */