summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Monjalon <thomas.monjalon@6wind.com>2013-03-22 16:34:54 +0100
committerThomas Monjalon <thomas.monjalon@6wind.com>2013-07-25 16:08:01 +0200
commit4dc5801cdab7ed982ec917269e2804f9ff89840c (patch)
tree679d86860a4be97be1d22402c99a2d6d86cdcca7
parent16b24267a8584b1bd85986403555f51fcfd48222 (diff)
downloaddpdk-4dc5801cdab7ed982ec917269e2804f9ff89840c.zip
dpdk-4dc5801cdab7ed982ec917269e2804f9ff89840c.tar.gz
dpdk-4dc5801cdab7ed982ec917269e2804f9ff89840c.tar.xz
lib: fix some doxygen comments
- 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> Acked-by: Olivier Matz <olivier.matz@6wind.com>
-rw-r--r--lib/librte_eal/common/include/rte_debug.h2
-rw-r--r--lib/librte_eal/common/include/rte_pci.h4
-rw-r--r--lib/librte_eal/common/include/rte_string_fns.h4
-rw-r--r--lib/librte_eal/linuxapp/eal/include/eal_internal_cfg.h4
-rw-r--r--lib/librte_ether/rte_ethdev.h4
5 files changed, 9 insertions, 9 deletions
diff --git a/lib/librte_eal/common/include/rte_debug.h b/lib/librte_eal/common/include/rte_debug.h
index acb4a9f..add4396 100644
--- a/lib/librte_eal/common/include/rte_debug.h
+++ b/lib/librte_eal/common/include/rte_debug.h
@@ -76,8 +76,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 93e3636..3afbae6 100644
--- a/lib/librte_eal/common/include/rte_pci.h
+++ b/lib/librte_eal/common/include/rte_pci.h
@@ -183,9 +183,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
/** Device needs to be unbound even if no module is provided */
#define RTE_PCI_DRV_FORCE_UNBIND 0x0004
diff --git a/lib/librte_eal/common/include/rte_string_fns.h b/lib/librte_eal/common/include/rte_string_fns.h
index 5cef986..e79ea03 100644
--- a/lib/librte_eal/common/include/rte_string_fns.h
+++ b/lib/librte_eal/common/include/rte_string_fns.h
@@ -35,7 +35,7 @@
/**
* @file
*
- * Definitions of warnings for use of various insecure functions
+ * String-related functions as replacement for libc equivalents
*/
#ifndef _RTE_STRING_FNS_H_
@@ -105,7 +105,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_eal/linuxapp/eal/include/eal_internal_cfg.h b/lib/librte_eal/linuxapp/eal/include/eal_internal_cfg.h
index 7f91855..58cd4ea 100644
--- a/lib/librte_eal/linuxapp/eal/include/eal_internal_cfg.h
+++ b/lib/librte_eal/linuxapp/eal/include/eal_internal_cfg.h
@@ -69,8 +69,8 @@ struct internal_config {
volatile unsigned vmware_tsc_map; /**< true to use VMware TSC mapping instead of native TSC */
volatile unsigned no_shconf; /**< true if there is no shared config */
volatile int syslog_facility; /**< facility passed to openlog() */
- volatile enum rte_proc_type_t process_type; /* multi-process proc type */
- /* true to try allocating memory on specific sockets */
+ volatile enum rte_proc_type_t process_type; /**< multi-process proc type */
+ /** true to try allocating memory on specific sockets */
volatile unsigned force_sockets;
volatile uint64_t socket_mem[RTE_MAX_NUMA_NODES]; /**< amount of memory per socket*/
const char *hugefile_prefix; /**< the base filename of hugetlbfs files */
diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h
index 69814bc..86eb295 100644
--- a/lib/librte_ether/rte_ethdev.h
+++ b/lib/librte_ether/rte_ethdev.h
@@ -495,9 +495,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;
};