summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorThomas Graf <tgraf@redhat.com>2012-05-10 12:03:59 +0200
committerThomas Graf <tgraf@redhat.com>2012-05-10 12:03:59 +0200
commitfec10a282355def49133e63b8a4591cc51b46478 (patch)
tree68995f7b253397edfe7ba0511c14a9b1bf85a911 /include
parent32057bc15469e6f012841605daa38766497fa196 (diff)
downloadlibnl-fec10a282355def49133e63b8a4591cc51b46478.tar.gz
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 'include')
-rw-r--r--include/netlink/attr.h14
-rw-r--r--include/netlink/types.h8
-rw-r--r--include/netlink/utils.h4
3 files changed, 13 insertions, 13 deletions
diff --git a/include/netlink/attr.h b/include/netlink/attr.h
index 8479c23..4d32113 100644
--- a/include/netlink/attr.h
+++ b/include/netlink/attr.h
@@ -28,12 +28,12 @@ struct nl_msg;
* @{
*/
- /**
- * @ingroup attr
- * Basic attribute data types
- *
- * See \ref attr_datatypes for more details.
- */
+/**
+ * @ingroup attr
+ * Basic attribute data types
+ *
+ * See section @core_doc{core_attr_parse,Attribute Parsing} for more details.
+ */
enum {
NLA_UNSPEC, /**< Unspecified type, binary data chunk */
NLA_U8, /**< 8 bit integer */
@@ -55,7 +55,7 @@ enum {
* @ingroup attr
* Attribute validation policy.
*
- * See \ref attr_datatypes for more details.
+ * See section @core_doc{core_attr_parse,Attribute Parsing} for more details.
*/
struct nla_policy {
/** Type of attribute or NLA_UNSPEC */
diff --git a/include/netlink/types.h b/include/netlink/types.h
index f6dade3..09cc5bd 100644
--- a/include/netlink/types.h
+++ b/include/netlink/types.h
@@ -1,12 +1,12 @@
/*
- * netlink/netlink-types.h Netlink Types
+ * netlink/types.h Definition of public types
*
* 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>
+ * Copyright (c) 2003-2012 Thomas Graf <tgraf@suug.ch>
*/
#ifndef __NETLINK_TYPES_H_
@@ -15,8 +15,8 @@
#include <stdio.h>
/**
- * Dumping types (dp_type)
* @ingroup utils
+ * Enumeration of dumping variations (dp_type)
*/
enum nl_dump_type {
NL_DUMP_LINE, /**< Dump object briefly on one line */
@@ -27,8 +27,8 @@ enum nl_dump_type {
#define NL_DUMP_MAX (__NL_DUMP_MAX - 1)
/**
- * Dumping parameters
* @ingroup utils
+ * Dumping parameters
*/
struct nl_dump_params
{
diff --git a/include/netlink/utils.h b/include/netlink/utils.h
index a1ef82e..4d7b969 100644
--- a/include/netlink/utils.h
+++ b/include/netlink/utils.h
@@ -6,7 +6,7 @@
* License as published by the Free Software Foundation version 2.1
* of the License.
*
- * Copyright (c) 2003-2008 Thomas Graf <tgraf@suug.ch>
+ * Copyright (c) 2003-2012 Thomas Graf <tgraf@suug.ch>
*/
#ifndef NETLINK_UTILS_H_
@@ -31,7 +31,7 @@ extern "C" {
#define NL_PROB_MIN 0x0
/**
- * Upper probability limit
+ * Upper probability limit nl_dump_type
* @ingroup utils
*/
#define NL_PROB_MAX 0xffffffff