[dpdk-dev] [PATCH 1/4] lib: fix some doxygen comments

[Thomas Monjalon <thomas.monjalon@6wind.com>]

- rte_panic must be before rte_panic_ to be associated to its doc
- marker /**< must be used when commenting after the declaration only
- fix rte_string_fns.h title
- typos

Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---
 lib/librte_eal/common/include/rte_debug.h      |    2 +-
 lib/librte_eal/common/include/rte_pci.h        |    4 ++--
 lib/librte_eal/common/include/rte_string_fns.h |    4 ++--
 lib/librte_ether/rte_ethdev.h                  |    6 +++---
 4 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/lib/librte_eal/common/include/rte_debug.h b/lib/librte_eal/common/include/rte_debug.h
index 1936dde..dc0fc7f 100644
--- a/lib/librte_eal/common/include/rte_debug.h
+++ b/lib/librte_eal/common/include/rte_debug.h
@@ -77,8 +77,8 @@ void rte_dump_registers(void);
  * @param args
  *   The variable list of arguments.
  */
-#define rte_panic_(func, format, ...) __rte_panic(func, format "%.0s", __VA_ARGS__)
 #define rte_panic(...) rte_panic_(__func__, __VA_ARGS__, "dummy")
+#define rte_panic_(func, format, ...) __rte_panic(func, format "%.0s", __VA_ARGS__)
 
 /*
  * Provide notification of a critical non-recoverable error and stop.
diff --git a/lib/librte_eal/common/include/rte_pci.h b/lib/librte_eal/common/include/rte_pci.h
index 1007f51..c3937f0 100644
--- a/lib/librte_eal/common/include/rte_pci.h
+++ b/lib/librte_eal/common/include/rte_pci.h
@@ -153,9 +153,9 @@ struct rte_pci_driver {
 	uint32_t drv_flags;                     /**< Flags contolling handling of device. */
 };
 
-/**< Device needs igb_uio kernel module */
+/** Device needs igb_uio kernel module */
 #define RTE_PCI_DRV_NEED_IGB_UIO 0x0001
-/**< Device driver must be registered several times until failure */
+/** Device driver must be registered several times until failure */
 #define RTE_PCI_DRV_MULTIPLE 0x0002
 
 /**
diff --git a/lib/librte_eal/common/include/rte_string_fns.h b/lib/librte_eal/common/include/rte_string_fns.h
index da3a3c9..2a366da 100644
--- a/lib/librte_eal/common/include/rte_string_fns.h
+++ b/lib/librte_eal/common/include/rte_string_fns.h
@@ -36,7 +36,7 @@
 /**
  * @file
  *
- * Definitions of warnings for use of various insecure functions
+ * String-related functions as replacement for libc equivalents
  */
 
 #ifndef _RTE_STRING_FNS_H_
@@ -106,7 +106,7 @@ einval_error:
  * Takes string "string" parameter and splits it at character "delim"
  * up to maxtokens-1 times - to give "maxtokens" resulting tokens. Like
  * strtok or strsep functions, this modifies its input string, by replacing
- * instances of "delim" with '\0'. All resultant tokens are returned in the
+ * instances of "delim" with '\\0'. All resultant tokens are returned in the
  * "tokens" array which must have enough entries to hold "maxtokens".
  *
  * @param string
diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h
index 86477e0..5985496 100644
--- a/lib/librte_ether/rte_ethdev.h
+++ b/lib/librte_ether/rte_ethdev.h
@@ -400,9 +400,9 @@ struct rte_fdir_conf {
 	enum rte_fdir_mode mode; /**< Flow Director mode. */
 	enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
 	enum rte_fdir_status_mode status;  /**< How to report FDIR hash. */
-	/* Offset of flexbytes field in RX packets (in 16-bit word units). */
+	/** Offset of flexbytes field in RX packets (in 16-bit word units). */
 	uint8_t flexbytes_offset;
-	/* RX queue of packets matching a "drop" filter in perfect mode. */
+	/** RX queue of packets matching a "drop" filter in perfect mode. */
 	uint8_t drop_queue;
 };
 
@@ -410,7 +410,7 @@ struct rte_fdir_conf {
  *  Possible l4type of FDIR filters.
  */
 enum rte_l4type {
-	RTE_FDIR_L4TYPE_NONE = 0,       /**< Nnoe. */
+	RTE_FDIR_L4TYPE_NONE = 0,       /**< None. */
 	RTE_FDIR_L4TYPE_UDP,            /**< UDP. */
 	RTE_FDIR_L4TYPE_TCP,            /**< TCP. */
 	RTE_FDIR_L4TYPE_SCTP,     	/**< SCTP. */
-- 
1.7.10.4