*------------------------------------------------------------------
*/
-/** @file */
+/** @file
+ * @defgroup libmemif
+ */
#ifndef _LIBMEMIF_H_
#define _LIBMEMIF_H_
/**
* @defgroup MEMIF_FD_EVENT Types of events that need to be watched for specific fd.
- *
+ * @ingroup libmemif
* @{
*/
typedef void *memif_conn_handle_t;
/**
* @defgroup CALLBACKS Callback functions definitions
+ * @ingroup libmemif
*
* @{
*/
/**
* @defgroup ARGS_N_BUFS Connection arguments and buffers
+ * @ingroup libmemif
*
* @{
*/
memif_interface_id_t interface_id;
uint8_t interface_name[32];
- uint8_t instance_name[32];
+ uint8_t instance_name[32]; /*!< deprecated, will be removed in 2.0 */
memif_interface_mode_t mode:8;
} memif_conn_args_t;
/**
* @defgroup MEMIF_DETAILS Memif details structs
+ * @ingroup libmemif
*
* @{
*/
/**
* @defgroup API_CALLS Api calls
+ * @ingroup libmemif
*
* @{
*/
/** \brief Memif initialization
@param on_control_fd_update - if control fd updates inform user to watch new fd
- @param app_name - application name
+ @param app_name - application name (will be truncated to 32 chars)
if param on_control_fd_update is set to NULL,
libmemif will handle file descriptor event polling