stv0g/libnl
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

restructure module documentation order

Browse source 
split hiearchy into one top level module per library
This commit is contained in:
Thomas Graf 2008-12-10 18:12:30 +01:00
parent b624b9ed93
commit 6782b6f709
13 changed files with 50 additions and 73 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
lib/addr.c
View file

@ -10,7 +10,7 @@
*/
/**
* @ingroup utils
* @ingroup core
* @defgroup addr Abstract Address
*
* @par 1) Transform character string to abstract address

1
lib/cache_mngt.c
View file

@ -10,6 +10,7 @@
*/
/**
* @ingroup core
* @defgroup cache_mngt Caching
* @{
*/

2
lib/data.c
View file

@ -10,7 +10,7 @@
*/
/**
* @ingroup utils
* @ingroup core
* @defgroup data Abstract Data
* @{
*/

62
lib/family.c
View file

@ -1,62 +0,0 @@
/*
* lib/family.c Netlink Family
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation version 2.1
* of the License.
*
* Copyright (c) 2003-2006 Thomas Graf <tgraf@suug.ch>
*/
/**
* @defgroup nlfam Netlink Families
* @brief
*
* @{
*/
#include <netlink-local.h>
#include <netlink/netlink.h>
#include <netlink/utils.h>
/**
* @name Netlink Family Name Translation
* @{
*/
static struct trans_tbl nlfamilies[] = {
__ADD(NETLINK_ROUTE,route)
__ADD(NETLINK_USERSOCK,usersock)
__ADD(NETLINK_FIREWALL,firewall)
__ADD(NETLINK_INET_DIAG,inetdiag)
__ADD(NETLINK_NFLOG,nflog)
__ADD(NETLINK_XFRM,xfrm)
__ADD(NETLINK_SELINUX,selinux)
__ADD(NETLINK_ISCSI,iscsi)
__ADD(NETLINK_AUDIT,audit)
__ADD(NETLINK_FIB_LOOKUP,fib_lookup)
__ADD(NETLINK_CONNECTOR,connector)
__ADD(NETLINK_NETFILTER,netfilter)
__ADD(NETLINK_IP6_FW,ip6_fw)
__ADD(NETLINK_DNRTMSG,dnrtmsg)
__ADD(NETLINK_KOBJECT_UEVENT,kobject_uevent)
__ADD(NETLINK_GENERIC,generic)
__ADD(NETLINK_SCSITRANSPORT,scsitransport)
__ADD(NETLINK_ECRYPTFS,ecryptfs)
};
char * nl_nlfamily2str(int family, char *buf, size_t size)
{
return __type2str(family, buf, size, nlfamilies,
ARRAY_SIZE(nlfamilies));
}
int nl_str2nlfamily(const char *name)
{
return __str2type(name, nlfamilies, ARRAY_SIZE(nlfamilies));
}
/** @} */
/** @} */

1
lib/fib_lookup/lookup.c
View file

@ -10,7 +10,6 @@
*/
/**
* @ingroup nlfam
* @defgroup fib_lookup FIB Lookup
* @brief
* @{

1
lib/genl/genl.c
View file

@ -10,7 +10,6 @@
*/
/**
* @ingroup nlfam
* @defgroup genl Generic Netlink
*
* @par Message Format

2
lib/handlers.c
View file

@ -10,7 +10,7 @@
*/
/**
* @ingroup nl
* @ingroup core
* @defgroup cb Callbacks/Customization
*
* @details

2
lib/msg.c
View file

@ -10,7 +10,7 @@
*/
/**
* @ingroup nl
* @ingroup core
* @defgroup msg Messages
* Netlink Message Construction/Parsing Interface
*

1
lib/netfilter/nfnl.c
View file

@ -12,7 +12,6 @@
*/
/**
* @ingroup nlfam
* @defgroup nfnl Netfilter Netlink
*
* @par Message Format

2
lib/nl.c
View file

@ -10,7 +10,7 @@
*/
/**
* @defgroup nl Core Netlink API
* @defgroup core Core
*
* @details
* @par 1) Connecting the socket

3
lib/route/rtnl.c
View file

@ -10,8 +10,7 @@
*/
/**
* @ingroup nlfam
* @defgroup rtnl Routing Netlink
* @defgroup rtnl Routing Family
* @{
*/

2
lib/socket.c
View file

@ -10,7 +10,7 @@
*/
/**
* @ingroup nl
* @ingroup core
* @defgroup socket Socket
* @{
*/

42
lib/utils.c
View file

@ -10,6 +10,7 @@
*/
/**
* @ingroup core
* @defgroup utils Utilities
* @{
*/
@ -433,6 +434,47 @@ char * nl_msec2str(uint64_t msec, char *buf, size_t len)
/** @} */
/**
* @name Netlink Family Translations
* @{
*/
static struct trans_tbl nlfamilies[] = {
__ADD(NETLINK_ROUTE,route)
__ADD(NETLINK_USERSOCK,usersock)
__ADD(NETLINK_FIREWALL,firewall)
__ADD(NETLINK_INET_DIAG,inetdiag)
__ADD(NETLINK_NFLOG,nflog)
__ADD(NETLINK_XFRM,xfrm)
__ADD(NETLINK_SELINUX,selinux)
__ADD(NETLINK_ISCSI,iscsi)
__ADD(NETLINK_AUDIT,audit)
__ADD(NETLINK_FIB_LOOKUP,fib_lookup)
__ADD(NETLINK_CONNECTOR,connector)
__ADD(NETLINK_NETFILTER,netfilter)
__ADD(NETLINK_IP6_FW,ip6_fw)
__ADD(NETLINK_DNRTMSG,dnrtmsg)
__ADD(NETLINK_KOBJECT_UEVENT,kobject_uevent)
__ADD(NETLINK_GENERIC,generic)
__ADD(NETLINK_SCSITRANSPORT,scsitransport)
__ADD(NETLINK_ECRYPTFS,ecryptfs)
};
char * nl_nlfamily2str(int family, char *buf, size_t size)
{
return __type2str(family, buf, size, nlfamilies,
ARRAY_SIZE(nlfamilies));
}
int nl_str2nlfamily(const char *name)
{
return __str2type(name, nlfamilies, ARRAY_SIZE(nlfamilies));
}
/**
* @}
*/
/**
* @name Link Layer Protocol Translations
* @{