doc: fix doxygen warnings and don't parse include/linux

diff --git a/doxygen.cfg b/doxygen.cfg
index 56141266272ee464bf27a526b325ae262f6cc6d1..1a070c91187460149013ab55e7d19f456d31a479 100644 (file)
--- a/doxygen.cfg
+++ b/doxygen.cfg
@@ -104,7 +104,7 @@ FILE_PATTERNS          = *.c *.h
 RECURSIVE              = YES
 EXCLUDE                = config.h test-glue.h
 EXCLUDE_SYMLINKS       = NO
-EXCLUDE_PATTERNS       = */tests/* */libevent/* */build/* *.git *.svn
+EXCLUDE_PATTERNS       = */tests/* */libevent/* */build/* */include/linux/* *.git *.svn
 EXCLUDE_SYMBOLS        =
 EXAMPLE_PATH           =
 EXAMPLE_PATTERNS       =

diff --git a/src/client/commands.c b/src/client/commands.c
index 65658ee6d0affde2f9bfa6d665a8ca7e3be9b161..7eee64a6a2b67cf212aa2e8b4855ece86c6920d3 100644 (file)
--- a/src/client/commands.c
+++ b/src/client/commands.c
@@ -497,7 +497,8 @@ commands_execute(struct lldpctl_conn_t *conn, struct writer *w,
  * Check if the environment does not contain the given key.
  *
  * @param env The environment.
- * @param arg The key to search for.
+ * @param key The key to search for.
+ * @return 1 if the environment does not contain the key. 0 otherwise.
  */
 int
 cmd_check_no_env(struct cmd_env *env, void *key)
@@ -509,7 +510,8 @@ cmd_check_no_env(struct cmd_env *env, void *key)
  * Check if the environment does contain the given key.
  *
  * @param env The environment.
- * @param arg The key to search for. Can be a comma separated list.
+ * @param key The key to search for. Can be a comma separated list.
+ * @return 1 if the environment does contain the key. 0 otherwise.
  */
 int
 cmd_check_env(struct cmd_env *env, void *key)
@@ -528,8 +530,11 @@ cmd_check_env(struct cmd_env *env, void *key)
 /**
  * Store the given key in the environment.
  *
+ * @param conn The connection.
+ * @param w    The writer (not used).
  * @param env The environment.
  * @param key The key to store.
+ * @return 1 if the key was stored
  */
 int
 cmd_store_env(struct lldpctl_conn_t *conn, struct writer *w,
@@ -541,8 +546,11 @@ cmd_store_env(struct lldpctl_conn_t *conn, struct writer *w,
 /**
  * Store the given key in the environment and pop one element from the stack.
  *
+ * @param conn The connection.
+ * @param w    The writer (not used).
  * @param env The environment.
  * @param key The key to store.
+ * @return 1 if the key was stored
  */
 int
 cmd_store_env_and_pop(struct lldpctl_conn_t *conn, struct writer *w,
@@ -556,8 +564,11 @@ cmd_store_env_and_pop(struct lldpctl_conn_t *conn, struct writer *w,
  * Store the given key with a value being the current keyword in the environment
  * and pop X elements from the stack.
  *
+ * @param conn The connection.
+ * @param w    The writer (not used).
  * @param env The environment.
  * @param key The key to store.
+ * @return 1 if the key was stored
  */
 int
 cmd_store_env_value_and_pop(struct lldpctl_conn_t *conn, struct writer *w,

diff --git a/src/client/display.c b/src/client/display.c
index 3169e81ea7ab528e47137a1f8982b821cd33f787..f2c7dd2eac6efc296a9456b6e0de03f19357f60e 100644 (file)
--- a/src/client/display.c
+++ b/src/client/display.c
@@ -540,7 +540,7 @@ display_interface(lldpctl_conn_t *conn, struct writer *w, int hidden,
  * @param conn       Connection to lldpd.
  * @param w          Writer.
  * @param hidden     Whatever to show hidden ports.
- * @param interfaces List of interfaces we should restrict to (comma separated).
+ * @param env        Environment from which we may find the list of ports.
  * @param details    Level of details we need (DISPLAY_*).
  */
 void

diff --git a/src/daemon/interfaces.c b/src/daemon/interfaces.c
index c5fac4d987a905ae8b5da863d4427a47b79f9738..facc69c8d57764d40689a81c6bd864298a12017d 100644 (file)
--- a/src/daemon/interfaces.c
+++ b/src/daemon/interfaces.c
@@ -119,7 +119,7 @@ interfaces_free_addresses(struct interfaces_address_list *ifaddrs)
  *
  * @param interfaces List of available interfaces
  * @param device     Name of the device we search for
- * @param return The interface or NULL if not found
+ * @return The interface or NULL if not found
  */
 struct interfaces_device*
 interfaces_nametointerface(struct interfaces_device_list *interfaces,
@@ -140,7 +140,7 @@ interfaces_nametointerface(struct interfaces_device_list *interfaces,
  *
  * @param interfaces List of available interfaces
  * @param index      Index of the device we search for
- * @param return The interface or NULL if not found
+ * @return The interface or NULL if not found
  */
 struct interfaces_device*
 interfaces_indextointerface(struct interfaces_device_list *interfaces,

diff --git a/src/lib/lldpctl.h b/src/lib/lldpctl.h
index 89379208f3d877a3b5abd82ffc9c8dcf65f4b311..b9112c170d2a2f6bbba5995efca9bc423d0e104c 100644 (file)
--- a/src/lib/lldpctl.h
+++ b/src/lib/lldpctl.h
@@ -690,7 +690,7 @@ typedef enum {
  * corresponding map.
  *
  * @param key    The piece of information we want a map from.
- * @param return The map or @c NULL if no map is available.
+ * @return       The map or @c NULL if no map is available.
  *
  * The returned map has its last element set to 0. It is also expected that the
  * string value can be used with a set operation. It will be translated to the