Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/5525/?format=api
{ "id": 5525, "url": "http://patches.dpdk.org/api/patches/5525/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/1434663829-5494-1-git-send-email-thomas.monjalon@6wind.com/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<1434663829-5494-1-git-send-email-thomas.monjalon@6wind.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1434663829-5494-1-git-send-email-thomas.monjalon@6wind.com", "date": "2015-06-18T21:43:49", "name": "[dpdk-dev] doc: fix doxygen warnings", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "68719eb139211c60ff2f2cc712d32ccad890a7dc", "submitter": { "id": 1, "url": "http://patches.dpdk.org/api/people/1/?format=api", "name": "Thomas Monjalon", "email": "thomas.monjalon@6wind.com" }, "delegate": null, "mbox": "http://patches.dpdk.org/project/dpdk/patch/1434663829-5494-1-git-send-email-thomas.monjalon@6wind.com/mbox/", "series": [], "comments": "http://patches.dpdk.org/api/patches/5525/comments/", "check": "pending", "checks": "http://patches.dpdk.org/api/patches/5525/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [IPv6:::1])\n\tby dpdk.org (Postfix) with ESMTP id B6B4CC636;\n\tThu, 18 Jun 2015 23:45:16 +0200 (CEST)", "from mail-wg0-f45.google.com (mail-wg0-f45.google.com\n\t[74.125.82.45]) by dpdk.org (Postfix) with ESMTP id 05624C632\n\tfor <dev@dpdk.org>; Thu, 18 Jun 2015 23:45:15 +0200 (CEST)", "by wgez8 with SMTP id z8so74487840wge.0\n\tfor <dev@dpdk.org>; Thu, 18 Jun 2015 14:45:14 -0700 (PDT)", "from localhost.localdomain (136-92-190-109.dsl.ovh.fr.\n\t[109.190.92.136]) by mx.google.com with ESMTPSA id\n\tpg1sm14049333wjb.39.2015.06.18.14.45.12 for <dev@dpdk.org>\n\t(version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128);\n\tThu, 18 Jun 2015 14:45:13 -0700 (PDT)" ], "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20130820;\n\th=x-gm-message-state:from:to:subject:date:message-id;\n\tbh=3CjXTpyQIXq7xqehDRD0trA5tF82/P7e6sQyKd8G8XA=;\n\tb=iIlf2r66oufwxaBoWUeiDmpJI5r/lExOVlqRSpghCbs1riVsZIddsW8u3NoTFGGbVQ\n\teQrelsHaJkYRS177e5G22agEe3ycKoSPDXfSdLxfHcr2NVqg4P/ksMaTq+YPlBsB/coD\n\tKcQTuxqF1N60V4uNQY4GF9aCyx4Fa+MkrqAwqjht2ntwHE3IEISx6EQ0J/GR/lRKHtZX\n\tDBzigbj8R9IvWj3sfMwXG3CZpUSDGz5FUh26/RccEHDcFXUmt7/i8xt8QD5aIScTkwrB\n\taTHNc60KRT28JTn43Wkhe8p91CoIvpFWm2LR2zA4GDM98rvU1ilpMmSeSCcOgHjtlLqi\n\tCkiw==", "X-Gm-Message-State": "ALoCoQk3C4AaSgRzWHe8/CcnL7Lv0k2+YPYD8tJdqTuFM3Zp/wka+zOZK81anNEbCt0vvpgGRYi9", "X-Received": "by 10.180.87.38 with SMTP id u6mr251312wiz.43.1434663914783;\n\tThu, 18 Jun 2015 14:45:14 -0700 (PDT)", "From": "Thomas Monjalon <thomas.monjalon@6wind.com>", "To": "dev@dpdk.org", "Date": "Thu, 18 Jun 2015 23:43:49 +0200", "Message-Id": "<1434663829-5494-1-git-send-email-thomas.monjalon@6wind.com>", "X-Mailer": "git-send-email 2.4.2", "Subject": "[dpdk-dev] [PATCH] doc: fix doxygen warnings", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "patches and discussions about DPDK <dev.dpdk.org>", "List-Unsubscribe": "<http://dpdk.org/ml/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://dpdk.org/ml/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<http://dpdk.org/ml/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>\n---\n .../common/include/generic/rte_cpuflags.h | 2 +-\n lib/librte_eal/common/include/rte_common.h | 6 ++---\n lib/librte_eal/common/include/rte_debug.h | 6 ++---\n lib/librte_eal/common/include/rte_devargs.h | 2 +-\n lib/librte_eal/common/include/rte_eal.h | 4 ++--\n lib/librte_eal/common/include/rte_log.h | 4 +---\n lib/librte_eal/common/include/rte_memzone.h | 2 +-\n lib/librte_ether/rte_eth_ctrl.h | 2 +-\n lib/librte_ether/rte_ethdev.h | 28 +++++++++++-----------\n lib/librte_ether/rte_ether.h | 2 +-\n lib/librte_kni/rte_kni.h | 7 +-----\n lib/librte_mempool/rte_mempool.h | 2 ++\n lib/librte_power/rte_power.h | 8 -------\n 13 files changed, 30 insertions(+), 45 deletions(-)", "diff": "diff --git a/lib/librte_eal/common/include/generic/rte_cpuflags.h b/lib/librte_eal/common/include/generic/rte_cpuflags.h\nindex 7f04838..a04e021 100644\n--- a/lib/librte_eal/common/include/generic/rte_cpuflags.h\n+++ b/lib/librte_eal/common/include/generic/rte_cpuflags.h\n@@ -89,7 +89,7 @@ rte_cpu_get_features(uint32_t leaf, uint32_t subleaf, cpuid_registers_t out);\n /**\n * Function for checking a CPU flag availability\n *\n- * @param flag\n+ * @param feature\n * CPU flag to query CPU for\n * @return\n * 1 if flag is available\ndiff --git a/lib/librte_eal/common/include/rte_common.h b/lib/librte_eal/common/include/rte_common.h\nindex c0ab8b4..c6e076b 100644\n--- a/lib/librte_eal/common/include/rte_common.h\n+++ b/lib/librte_eal/common/include/rte_common.h\n@@ -220,8 +220,8 @@ rte_align32pow2(uint32_t x)\n /**\n * Aligns 64b input parameter to the next power of 2\n *\n- * @param x\n- * The 64b value to algin\n+ * @param v\n+ * The 64b value to align\n *\n * @return\n * Input parameter aligned to the next power of 2\n@@ -303,7 +303,7 @@ rte_bsf32(uint32_t v)\n /** Take a macro value and get a string version of it */\n #define RTE_STR(x) _RTE_STR(x)\n \n-/** Mask value of type <tp> for the first <ln> bit set. */\n+/** Mask value of type \"tp\" for the first \"ln\" bit set. */\n #define\tRTE_LEN2MASK(ln, tp)\t\\\n \t((tp)((uint64_t)-1 >> (sizeof(uint64_t) * CHAR_BIT - (ln))))\n \ndiff --git a/lib/librte_eal/common/include/rte_debug.h b/lib/librte_eal/common/include/rte_debug.h\nindex 82ee3b3..94129fa 100644\n--- a/lib/librte_eal/common/include/rte_debug.h\n+++ b/lib/librte_eal/common/include/rte_debug.h\n@@ -70,10 +70,8 @@ void rte_dump_registers(void);\n *\n * The function never returns.\n *\n- * @param format\n- * The format string\n- * @param args\n- * The variable list of arguments.\n+ * @param ...\n+ * The format string, followed by the variable list of arguments.\n */\n #define rte_panic(...) rte_panic_(__func__, __VA_ARGS__, \"dummy\")\n #define rte_panic_(func, format, ...) __rte_panic(func, format \"%.0s\", __VA_ARGS__)\ndiff --git a/lib/librte_eal/common/include/rte_devargs.h b/lib/librte_eal/common/include/rte_devargs.h\nindex 039f728..7084ae2 100644\n--- a/lib/librte_eal/common/include/rte_devargs.h\n+++ b/lib/librte_eal/common/include/rte_devargs.h\n@@ -141,7 +141,7 @@ int rte_eal_parse_devargs_str(const char *devargs_str,\n *\n * @param devtype\n * The type of the device.\n- * @param devargs_list\n+ * @param devargs_str\n * The arguments as given by the user.\n *\n * @return\ndiff --git a/lib/librte_eal/common/include/rte_eal.h b/lib/librte_eal/common/include/rte_eal.h\nindex 1385a73..f36a792 100644\n--- a/lib/librte_eal/common/include/rte_eal.h\n+++ b/lib/librte_eal/common/include/rte_eal.h\n@@ -171,7 +171,7 @@ typedef void\t(*rte_usage_hook_t)(const char * prgname);\n * This routine is optional for the application and will behave as if the set\n * routine was never called as the default behavior.\n *\n- * @param func\n+ * @param usage_func\n * The func argument is a function pointer to the application usage routine.\n * Called function is defined using rte_usage_hook_t typedef, which is of\n * the form void rte_usage_func(const char * prgname).\n@@ -183,7 +183,7 @@ typedef void\t(*rte_usage_hook_t)(const char * prgname);\n * the caller to daisy chain the usage routines if needing more then one.\n */\n rte_usage_hook_t\n-rte_set_application_usage_hook( rte_usage_hook_t usage_func );\n+rte_set_application_usage_hook(rte_usage_hook_t usage_func);\n \n /**\n * macro to get the lock of tailq in mem_config\ndiff --git a/lib/librte_eal/common/include/rte_log.h b/lib/librte_eal/common/include/rte_log.h\nindex 3b467c1..24a55cc 100644\n--- a/lib/librte_eal/common/include/rte_log.h\n+++ b/lib/librte_eal/common/include/rte_log.h\n@@ -289,11 +289,9 @@ int rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)\n * @param t\n * The log type, for example, EAL. The short name is expanded by the\n * macro, so it cannot be an integer value.\n- * @param fmt\n+ * @param ...\n * The fmt string, as in printf(3), followed by the variable arguments\n * required by the format.\n- * @param args\n- * The variable list of arguments according to the format string.\n * @return\n * - 0: Success.\n * - Negative on error.\ndiff --git a/lib/librte_eal/common/include/rte_memzone.h b/lib/librte_eal/common/include/rte_memzone.h\nindex 81b6ad4..ee62680 100644\n--- a/lib/librte_eal/common/include/rte_memzone.h\n+++ b/lib/librte_eal/common/include/rte_memzone.h\n@@ -258,7 +258,7 @@ const struct rte_memzone *rte_memzone_lookup(const char *name);\n * @param f\n * A pointer to a file for output\n */\n-void rte_memzone_dump(FILE *);\n+void rte_memzone_dump(FILE *f);\n \n /**\n * Walk list of all memzones\ndiff --git a/lib/librte_ether/rte_eth_ctrl.h b/lib/librte_ether/rte_eth_ctrl.h\nindex 498fc85..9187d6d 100644\n--- a/lib/librte_ether/rte_eth_ctrl.h\n+++ b/lib/librte_ether/rte_eth_ctrl.h\n@@ -109,7 +109,7 @@ enum rte_filter_op {\n \tRTE_ETH_FILTER_OP_MAX\n };\n \n-/*\n+/**\n * MAC filter type\n */\n enum rte_mac_filter_type {\ndiff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h\nindex 04c192d..f1219ac 100644\n--- a/lib/librte_ether/rte_ethdev.h\n+++ b/lib/librte_ether/rte_ethdev.h\n@@ -1040,10 +1040,10 @@ typedef void (*eth_queue_release_t)(void *queue);\n \n typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,\n \t\t\t\t\t uint16_t rx_queue_id);\n-/**< @Get number of available descriptors on a receive queue of an Ethernet device. */\n+/**< @internal Get number of available descriptors on a receive queue of an Ethernet device. */\n \n typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);\n-/**< @Check DD bit of specific RX descriptor */\n+/**< @internal Check DD bit of specific RX descriptor */\n \n typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);\n /**< @internal Set MTU. */\n@@ -1456,8 +1456,8 @@ struct rte_eth_rxtx_callback {\n \tvoid *param;\n };\n \n-/*\n- * The eth device type\n+/**\n+ * The eth device type.\n */\n enum rte_eth_dev_type {\n \tRTE_ETH_DEV_UNKNOWN,\t/**< unknown device type */\n@@ -1629,7 +1629,7 @@ int rte_eth_dev_attach(const char *devargs, uint8_t *port_id);\n *\n * @param port_id\n * The port identifier of the device to detach.\n- * @param addr\n+ * @param devname\n * A pointer to a device name actually detached.\n * @return\n * 0 on success and devname is filled, negative on error\n@@ -2474,7 +2474,7 @@ rte_eth_rx_queue_count(uint8_t port_id, uint16_t queue_id)\n * The port identifier of the Ethernet device.\n * @param queue_id\n * The queue id on the specific port.\n- * @offset\n+ * @param offset\n * The offset of the descriptor ID from tail.\n * @return\n * - (1) if the specific DD bit is set.\n@@ -3266,7 +3266,7 @@ int rte_eth_dev_bypass_state_show(uint8_t port, uint32_t *state);\n *\n * @param port\n * The port identifier of the Ethernet device.\n- * @param state\n+ * @param new_state\n * The current bypass state.\n * - (1) Normal mode\n * - (2) Bypass mode\n@@ -3331,7 +3331,7 @@ int rte_eth_dev_bypass_event_store(uint8_t port, uint32_t event, uint32_t state)\n *\n * @param port\n * The port identifier of the Ethernet device.\n- * @param state\n+ * @param timeout\n * The timeout to be set.\n * - (0) 0 seconds (timer is off)\n * - (1) 1.5 seconds\n@@ -3560,9 +3560,9 @@ void *rte_eth_add_tx_callback(uint8_t port_id, uint16_t queue_id,\n * since the it may still be in use. The memory for the callback can be\n * subsequently freed back by the application by calling rte_free():\n *\n- * - Immediately - if the port is stopped, or the user knows that no\n- * callbacks are in flight e.g. if called from the thread doing RX/TX\n- * on that queue.\n+ * - Immediately - if the port is stopped, or the user knows that no\n+ * callbacks are in flight e.g. if called from the thread doing RX/TX\n+ * on that queue.\n *\n * - After a short delay - where the delay is sufficient to allow any\n * in-flight callbacks to complete.\n@@ -3593,9 +3593,9 @@ int rte_eth_remove_rx_callback(uint8_t port_id, uint16_t queue_id,\n * since the it may still be in use. The memory for the callback can be\n * subsequently freed back by the application by calling rte_free():\n *\n- * - Immediately - if the port is stopped, or the user knows that no\n- * callbacks are in flight e.g. if called from the thread doing RX/TX\n- * on that queue.\n+ * - Immediately - if the port is stopped, or the user knows that no\n+ * callbacks are in flight e.g. if called from the thread doing RX/TX\n+ * on that queue.\n *\n * - After a short delay - where the delay is sufficient to allow any\n * in-flight callbacks to complete.\ndiff --git a/lib/librte_ether/rte_ether.h b/lib/librte_ether/rte_ether.h\nindex 49f4576..a14308e 100644\n--- a/lib/librte_ether/rte_ether.h\n+++ b/lib/librte_ether/rte_ether.h\n@@ -277,7 +277,7 @@ static inline void ether_addr_copy(const struct ether_addr *ea_from,\n * A pointer to buffer contains the formatted MAC address.\n * @param size\n * The format buffer size.\n- * @param ea_to\n+ * @param eth_addr\n * A pointer to a ether_addr structure.\n */\n static inline void\ndiff --git a/lib/librte_kni/rte_kni.h b/lib/librte_kni/rte_kni.h\nindex fd2b78f..52ffdb7 100644\n--- a/lib/librte_kni/rte_kni.h\n+++ b/lib/librte_kni/rte_kni.h\n@@ -301,12 +301,7 @@ extern int rte_kni_register_handlers(struct rte_kni *kni,\n extern int rte_kni_unregister_handlers(struct rte_kni *kni);\n \n /**\n- * close KNI device.\n- *\n- * @param void\n- *\n- * @return\n- * void\n+ * Close KNI device.\n */\n extern void rte_kni_close(void);\n \ndiff --git a/lib/librte_mempool/rte_mempool.h b/lib/librte_mempool/rte_mempool.h\nindex a4a9610..bc2bae0 100644\n--- a/lib/librte_mempool/rte_mempool.h\n+++ b/lib/librte_mempool/rte_mempool.h\n@@ -1325,6 +1325,8 @@ struct rte_mempool *rte_mempool_lookup(const char *name);\n * The flags used for the mempool creation.\n * Consult rte_mempool_create() for more information about possible values.\n * The size of each element.\n+ * @param sz\n+ * The calculated detailed size the mempool object. May be NULL.\n * @return\n * Total size of the mempool object.\n */\ndiff --git a/lib/librte_power/rte_power.h b/lib/librte_power/rte_power.h\nindex 7d57359..67e0ec0 100644\n--- a/lib/librte_power/rte_power.h\n+++ b/lib/librte_power/rte_power.h\n@@ -68,19 +68,12 @@ int rte_power_set_env(enum power_management_env env);\n /**\n * Unset the global environment configuration.\n * This can only be called after all threads have completed.\n- *\n- * @param None.\n- *\n- * @return\n- * None.\n */\n void rte_power_unset_env(void);\n \n /**\n * Get the default power management implementation.\n *\n- * @param None.\n- *\n * @return\n * power_management_env The configured environment.\n */\n@@ -104,7 +97,6 @@ int rte_power_init(unsigned lcore_id);\n * Exit power management on a specific lcore. This will call the environment\n * dependent exit function.\n *\n- *\n * @param lcore_id\n * lcore id.\n *\n", "prefixes": [ "dpdk-dev" ] }