dect
/
libdect
Archived
13
0
Fork 0
Code Releases Activity

doc: add some misc documentation 

Signed-off-by: Patrick McHardy <kaber@trash.net>
This commit is contained in:
Patrick McHardy 2010-07-08 21:17:12 +02:00
parent 453287afd1
commit f9020e9086
4 changed files with 19 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/dect/auth.h
View File

@ -24,10 +24,10 @@ extern "C" {
/**
* struct dect_aalg - DECT authentication algorithm
*
* @type: algorithm ID
* @d1_len: length of input D1
* @d2_len: length of input D2
* @calc: function to calculate output E
* @arg type algorithm ID
* @arg d1_len length of input D1
* @arg d2_len length of input D2
* @arg calc function to calculate output E
*/
struct dect_aalg {
uint8_t type;

3
include/dect/identities.h
View File

@ -204,7 +204,8 @@ extern void dect_dump_tpui(const struct dect_tpui *tpui);
/* Collective broadcast identifier */
#define DECT_TPUI_CBI 0xcfff
/** @}@} */
/** @} */
/** @} */
#ifdef __cplusplus
}

10
include/dect/libdect.h
View File

@ -29,11 +29,11 @@ struct dect_handle;
/**
* struct dect_msg_buf - DECT message buffer
*
* @list: Data link TX queue node
* @type: Message type
* @len: Data length
* @data: Data pointer
* @head: Storage area for on-stack buffers
* @arg list Data link TX queue node
* @arg type Message type
* @arg len Data length
* @arg data Data pointer
* @arg head Storage area for on-stack buffers
*/
struct dect_msg_buf {
struct list_head list;

11
src/mm.c
View File

@ -609,7 +609,8 @@ static int dect_mm_send_msg(const struct dect_handle *dh,
* "P-MM" =>> "P-IWU" [label="MM_AUTHENTICATE-cfm", URL="\ref dect_mm_ops::mm_authenticate_cfm"];
* \endmsc
*
* @sa ETSI EN 300 175-7 (DECT Common Interface - Security Features)
* @sa \ref security "Security Features",
* ETSI EN 300 175-7 (DECT Common Interface - Security Features)
*
* @{
*/
@ -735,7 +736,8 @@ err1:
* "MM-1" =>> "IWU-1" [label="MM_AUTHENTICATE-cfm", URL="\ref dect_mm_ops::mm_authenticate_cfm"];
* \endmsc
*
* @sa ETSI EN 300 175-7 (DECT Common Interface - Security Features)
* @sa \ref security "Security Features",
* ETSI EN 300 175-7 (DECT Common Interface - Security Features)
*
* @{
*/
@ -1004,6 +1006,9 @@ err1:
* "F-MM" =>> "F-IWU" [label="MM_CIPHER-cfm", URL="\ref dect_mm_ops::mm_cipher_cfm"];
* \endmsc
*
* @sa \ref security "Security Features",
* ETSI EN 300 175-7 (DECT Common Interface - Security Features)
*
* @{
*/
@ -1511,7 +1516,7 @@ err1:
/**
* @}
* @defgroup mm_access_rights_terminate Access rights termination
* @defgroup mm_access_rights_terminate Access Rights termination
*
* This module implements the access rights termination procedure specified in
* ETSI EN 300 175-5 section 13.5.2.