link/api: Improve API documentation.

diff --git a/include/netlink/route/link/api.h b/include/netlink/route/link/api.h
index 42c00d93ebc5bccebf81750e3bd7625e05b7facf..8222e230942e27e71ae65e5b097e7f43e34f1d38 100644 (file)
--- a/include/netlink/route/link/api.h
+++ b/include/netlink/route/link/api.h
@@ -19,16 +19,16 @@ extern "C" {
 #endif
 
 /**
- * @ingroup link_info
+ * @ingroup link_api
  *
- * Link info operations
+ * Available operations to modules implementing a link info type.
  */
 struct rtnl_link_info_ops
 {
-       /** Name of operations, must match name on kernel side */
+       /** Name of link info type, must match name on kernel side */
        char *          io_name;
 
-       /** Reference count (internal, do not use) */
+       /** Reference count, DO NOT MODIFY */
        int             io_refcnt;
 
        /** Called to assign an info type to a link.
@@ -69,6 +69,11 @@ extern int                   rtnl_link_register_info(struct rtnl_link_info_ops *);
 extern int                     rtnl_link_unregister_info(struct rtnl_link_info_ops *);
 
 
+/**
+ * @ingroup link_api
+ *
+ * Available operations to modules implementing a link address family.
+ */
 struct rtnl_link_af_ops
 {
        /** The address family this operations set implements */

diff --git a/lib/route/link/api.c b/lib/route/link/api.c
index 1830fe3759c66e2320fd4317fb522000a01225c1..b1608e3e720257340c09d026545abb6f95c3245e 100644 (file)
--- a/lib/route/link/api.c
+++ b/lib/route/link/api.c
@@ -11,8 +11,8 @@
 
 /**
  * @ingroup link
- * @defgroup link_info Link Info API
- * @brief
+ * @defgroup link_API Link Modules API
+ * @brief API for modules implementing specific link types/semantics.
  *
  * @par 1) Registering/Unregistering a new link info type
  * @code
@@ -58,6 +58,11 @@ static struct rtnl_link_info_ops *__rtnl_link_info_ops_lookup(const char *name)
        return NULL;
 }
 
+/**
+ * @name Link Info Modules
+ * @{
+ */
+
 /**
  * Return operations of a specific link info type
  * @arg name           Name of link info type.
@@ -147,6 +152,13 @@ int rtnl_link_unregister_info(struct rtnl_link_info_ops *ops)
        return -NLE_OPNOTSUPP;
 }
 
+/** @} */
+
+/**
+ * @name Link Address Family Modules
+ * @{
+ */
+
 static struct rtnl_link_af_ops *af_ops[AF_MAX];
 
 /**
@@ -242,3 +254,5 @@ int rtnl_link_af_unregister(struct rtnl_link_af_ops *ops)
 
 /** @} */
 
+/** @} */
+

diff --git a/lib/route/link/bridge.c b/lib/route/link/bridge.c
index 4e4da58bed250c74493d8b3ad358f93e825ed5f6..32fd38f24e13d97c0d8411aeab4259d7dabd8656 100644 (file)
--- a/lib/route/link/bridge.c
+++ b/lib/route/link/bridge.c
@@ -9,14 +9,6 @@
  * Copyright (c) 2010 Thomas Graf <tgraf@suug.ch>
  */
 
-/**
- * @ingroup link
- * @defgroup link_bridge Bridge Specifics
- * @brief
- *
- * @{
- */
-
 #include <netlink-local.h>
 #include <netlink/netlink.h>
 #include <netlink/attr.h>
@@ -89,5 +81,3 @@ static void __exit bridge_exit(void)
 {
        rtnl_link_af_unregister(&bridge_ops);
 }
-
-/** @} */

diff --git a/lib/route/link/vlan.c b/lib/route/link/vlan.c
index a76cb838e87185f617c7d0aec613299fd6b6cca9..da3ae4903399d26a2244b09079e038023855abe9 100644 (file)
--- a/lib/route/link/vlan.c
+++ b/lib/route/link/vlan.c
@@ -10,7 +10,7 @@
  */
 
 /**
- * @ingroup link_info
+ * @ingroup link_api
  * @defgroup vlan VLAN
  * @brief
  *