From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm1-f68.google.com (mail-wm1-f68.google.com [209.85.128.68]) by dpdk.org (Postfix) with ESMTP id EF4131BDB1 for ; Thu, 20 Dec 2018 18:07:23 +0100 (CET) Received: by mail-wm1-f68.google.com with SMTP id f81so3004218wmd.4 for ; Thu, 20 Dec 2018 09:07:23 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=PdVUbYdVmLlIKxvlsWpjolkRTGhn88OQckZovHVie98=; b=1MKNg0Qf8Adbq0OMJffc3GVGLzvpgEEXuQq6v25CnRMRzpqFDcxglCoqw/S2GvbwfT rDp54e9mPpG2tMlDBvuIRN5MYxJx0hRhtODH0tiKTd+NCr4nVvSknCe0vB6EIBKBRD1i GOmo2CR/kSEPNfW0V6E5Yu3LOEFhUkPTirVQLFxrt0+knEoEJZTStpCyDCnu0Kyr0XuK bMllB7K1nJemLzMp15BhQevjHCylkd1A7B76ETc9T3akf1MdnMgl+nXMnuXIqEZg9nTI KDpyWie3Jnv7g9zlIL39T8Ygu6kc2NDISgjZ7y5IwcAVt+ONF0ck3dGqOWkwd4sfbcVF huiw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=PdVUbYdVmLlIKxvlsWpjolkRTGhn88OQckZovHVie98=; b=BenO2Mu1dRfHCpoD/sEMh3veFRbtHgM8r2GwlCgpl5O9q631oJ4oX2X4DT7aNHcaQt t99yDWRBlkjc50S93mMpWOdSjA+fmSg4Qlc9xzglGVlnRuWj60gD0f602qd05uS4tySM /rZk7HmaTqS5OAO9KgkaGUnYrFy/w3LtCZtFuHJMFPUTiRw28zR48nXfZt9oUIIcg+ab qToBFCn/F/94QDF0pLt7zmqqtwaMXtR68yd02vOHyOCRWRzIZGXPNE7mIDLGWvzBxwjQ aFwKl0sRnt6RNWs8AftszdEGfxDJR2CyhZQ+7NYU2MOomTGCavpXvF1yFd3+wnTYK1YL Y8LA== X-Gm-Message-State: AA+aEWYcpB8z/dMdhxXJ9VPhZ+Ma9r0rHDrmTVz8siqSqRbk+nQ7RlMX 6MbthEy+r4KJMWB7faCWd4j5hWUmKUU= X-Google-Smtp-Source: AFSGD/UgzjOim4tnBuLgyu6v4HSevCgUDCSc7xFvXf3Wt6H51PBVkVppjvdMjC6LsmFMwOF8gtnKow== X-Received: by 2002:a7b:c4cb:: with SMTP id g11mr12347562wmk.149.1545325643333; Thu, 20 Dec 2018 09:07:23 -0800 (PST) Received: from bidouze.dev.6wind.com. (host.78.145.23.62.rev.coltfrance.com. [62.23.145.78]) by smtp.gmail.com with ESMTPSA id n5sm11951688wrr.94.2018.12.20.09.07.22 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 20 Dec 2018 09:07:22 -0800 (PST) From: Gaetan Rivet To: dev@dpdk.org Cc: Gaetan Rivet Date: Thu, 20 Dec 2018 18:06:46 +0100 Message-Id: <7f6edf0902fe095391db3f090533a66b9f9e9507.1545325395.git.gaetan.rivet@6wind.com> X-Mailer: git-send-email 2.19.1 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v1 7/8] option: improve library documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 20 Dec 2018 17:07:24 -0000 Use doxygen to describe the main structure and describe a little more why it exists. Signed-off-by: Gaetan Rivet --- lib/librte_eal/common/include/rte_option.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/lib/librte_eal/common/include/rte_option.h b/lib/librte_eal/common/include/rte_option.h index eea95e477..20be47d91 100644 --- a/lib/librte_eal/common/include/rte_option.h +++ b/lib/librte_eal/common/include/rte_option.h @@ -29,8 +29,12 @@ extern "C" { typedef int (*rte_option_cb)(void); -/* - * Structure describing the EAL command line option being registered. +/** + * Structure describing an EAL command line option dynamically registered. + * + * Common EAL options are mostly statically defined. + * Some libraries need additional options to be dynamically added. + * This structure describes such options. */ struct rte_option { TAILQ_ENTRY(rte_option) next; /**< Next entry in the list. */ -- 2.19.1