From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-we0-x230.google.com (mail-we0-x230.google.com [IPv6:2a00:1450:400c:c03::230]) by dpdk.org (Postfix) with ESMTP id CC7CB6AE7 for ; Fri, 19 Apr 2013 19:01:23 +0200 (CEST) Received: by mail-we0-f176.google.com with SMTP id s43so3882335wey.35 for ; Fri, 19 Apr 2013 10:00:29 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20120113; h=x-received:from:to:subject:date:message-id:x-mailer:in-reply-to :references:in-reply-to:references:x-gm-message-state; bh=ArVBRvBcXhtAYywr8NL81Cdm4/RMUcc5aBLiccUJwA8=; b=U9UVBxCcab0aZKGCZ7Bp8lVwk1M0FUsDCU03N6zGt0rVRc97vbLL//4i8zx7zvlobA onHXoe87FbrgJlhgka5EXcZEme8IM6SzjfPgP6/qgozFKieuItI2bxmhzu477L5IGNVe dLWKGJO7Q2GUhB7vqd5QZHEYhcGbxGrz4q9VAoe45nH7Ez8+uOoMfgMYpUwF5j1ci7m1 HlKges6D5WiI1dbhfrs9fFXJvTOgjGHl7yvd+eiGp0LVE61T8Pqf3shXb/P8xmG+fEtB gVEQxWCo91rO/TV01saZUY11ev4g+gjQYux0RVikwrEZoaRxoJnsWYH2RpVb2V4MuJBW YF8w== X-Received: by 10.180.37.166 with SMTP id z6mr40950685wij.34.1366390829602; Fri, 19 Apr 2013 10:00:29 -0700 (PDT) Received: from 6wind.com (6wind.net2.nerim.net. [213.41.180.237]) by mx.google.com with ESMTPS id bq19sm4719205wib.7.2013.04.19.10.00.27 (version=TLSv1 cipher=RC4-SHA bits=128/128); Fri, 19 Apr 2013 10:00:28 -0700 (PDT) Received: by 6wind.com (sSMTP sendmail emulation); Fri, 19 Apr 2013 19:00:27 +0200 From: Thomas Monjalon To: dev@dpdk.org Date: Fri, 19 Apr 2013 19:00:20 +0200 Message-Id: <63fa0a76b322c6e8a0202dc8bf96be7b499c14b0.1366390454.git.thomas.monjalon@6wind.com> X-Mailer: git-send-email 1.7.10.4 In-Reply-To: References: In-Reply-To: References: X-Gm-Message-State: ALoCoQk3RqEjNfkFZ+WCY9vGZ/D//so683uIWmpLLIvS6dKvHY/FzGN5kNKDuqB986YujAURJ8c5 Subject: [dpdk-dev] [PATCH 1/4] lib: fix some doxygen comments X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 19 Apr 2013 17:01:24 -0000 - 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 --- 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