summaryrefslogtreecommitdiffstats
path: root/lib/addr.c
diff options
context:
space:
mode:
authorThomas Graf <tgraf@redhat.com>2012-05-10 10:03:59 (GMT)
committerThomas Graf <tgraf@redhat.com>2012-05-10 10:03:59 (GMT)
commitfec10a282355def49133e63b8a4591cc51b46478 (patch)
tree68995f7b253397edfe7ba0511c14a9b1bf85a911 /lib/addr.c
parent32057bc15469e6f012841605daa38766497fa196 (diff)
downloadlibnl-fec10a282355def49133e63b8a4591cc51b46478.zip
libnl-fec10a282355def49133e63b8a4591cc51b46478.tar.gz
libnl-fec10a282355def49133e63b8a4591cc51b46478.tar.bz2
doc: documentation restructuring
- changes the modules hierarchy to better represent the set of libaries - list the header file that needs to be included - remove examples/doc from api ref that is included in the guide - add references to the guide - fix doxygen api linking for version 1.8.0 - readd doxygen mainpage to config file - fix a couple of doxygen doc bugs
Diffstat (limited to 'lib/addr.c')
-rw-r--r--lib/addr.c30
1 files changed, 16 insertions, 14 deletions
diff --git a/lib/addr.c b/lib/addr.c
index 30c708d..89d3d4f 100644
--- a/lib/addr.c
+++ b/lib/addr.c
@@ -1,28 +1,30 @@
/*
- * lib/addr.c Abstract Address
+ * lib/addr.c Network Address
*
* 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-2010 Thomas Graf <tgraf@suug.ch>
+ * Copyright (c) 2003-2012 Thomas Graf <tgraf@suug.ch>
*/
/**
- * @ingroup core
- * @defgroup addr Abstract Address
+ * @ingroup core_types
+ * @defgroup addr Network Address
+ *
+ * Abstract data type representing any kind of network address
+ *
+ * Related sections in the development guide:
+ * - @core_doc{_abstract_address, Network Addresses}
*
- * @par 1) Transform character string to abstract address
- * @code
- * struct nl_addr *a = nl_addr_parse("::1", AF_UNSPEC);
- * printf("Address family: %s\n", nl_af2str(nl_addr_get_family(a)));
- * nl_addr_put(a);
- * a = nl_addr_parse("11:22:33:44:55:66", AF_UNSPEC);
- * printf("Address family: %s\n", nl_af2str(nl_addr_get_family(a)));
- * nl_addr_put(a);
- * @endcode
* @{
+ *
+ * Header
+ * ------
+ * ~~~~{.c}
+ * #include <netlink/addr.h>
+ * ~~~~
*/
#include <netlink-local.h>
@@ -163,7 +165,7 @@ static void addr_destroy(struct nl_addr *addr)
}
/**
- * @name Creating Abstract Addresses
+ * @name Creating Abstract Network Addresses
* @{
*/