d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: fix some doxygen comments

Browse Source 
- 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>
This commit is contained in:
Thomas Monjalon 2013-03-22 16:34:54 +01:00 committed by David Marchand
parent d0d2e6a505
commit 9b226335bb
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/librte_eal/common/include/rte_debug.h
View File

@ -75,8 +75,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__)
#define RTE_VERIFY(exp) do { \
if (!(exp)) \

4
lib/librte_eal/common/include/rte_string_fns.h
View File

@ -34,7 +34,7 @@
/**
* @file
*
* Definitions of warnings for use of various insecure functions
* String-related functions as replacement for libc equivalents
*/
#ifndef _RTE_STRING_FNS_H_
@ -104,7 +104,7 @@ rte_snprintf(char *buffer, int buflen, const char *format, ...)
* 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

4
lib/librte_eal/linuxapp/eal/include/eal_internal_cfg.h
View File

@ -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 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 */
uintptr_t base_virtaddr; /**< base address to try and reserve memory from */