From: Thomas Monjalon Date: Fri, 22 Mar 2013 15:34:54 +0000 (+0100) Subject: doc: fix some doxygen comments X-Git-Tag: spdx-start~10987 X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=9b226335bb0357b0152c68fa57d1bc335ac1626c;p=dpdk.git doc: 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 Acked-by: Olivier Matz --- diff --git a/lib/librte_eal/common/include/rte_debug.h b/lib/librte_eal/common/include/rte_debug.h index e234e2ffe6..9cd818cd40 100644 --- a/lib/librte_eal/common/include/rte_debug.h +++ b/lib/librte_eal/common/include/rte_debug.h @@ -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)) \ diff --git a/lib/librte_eal/common/include/rte_string_fns.h b/lib/librte_eal/common/include/rte_string_fns.h index 70047b8882..d8fde148e6 100644 --- a/lib/librte_eal/common/include/rte_string_fns.h +++ b/lib/librte_eal/common/include/rte_string_fns.h @@ -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 @@ 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 643db7cfcc..a274995202 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 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 */