DPDK patches and discussions
 help / color / mirror / Atom feed
From: Thomas Monjalon <thomas@monjalon.net>
To: Anoob Joseph <anoobj@marvell.com>
Cc: Radu Nicolau <radu.nicolau@intel.com>,
	"dev@dpdk.org" <dev@dpdk.org>,
	"akhil.goyal@nxp.com" <akhil.goyal@nxp.com>,
	"konstantin.ananyev@intel.com" <konstantin.ananyev@intel.com>,
	"bernard.iremonger@intel.com" <bernard.iremonger@intel.com>,
	"declan.doherty@intel.com" <declan.doherty@intel.com>,
	"stephen@networkplumber.org" <stephen@networkplumber.org>,
	ferruh.yigit@intel.com
Subject: Re: [dpdk-dev] [EXT] [PATCH] security: update doxygen fields
Date: Wed, 04 Sep 2019 09:46:42 +0200	[thread overview]
Message-ID: <18019128.8lTUtv1f9t@xps> (raw)
In-Reply-To: <MN2PR18MB287767C0B84670901EBBD1B9DFB80@MN2PR18MB2877.namprd18.prod.outlook.com>

04/09/2019 05:41, Anoob Joseph:
> Hi Radu,
> 
> Most parts of the file(rte_security.h) follows 'description after item' methodology. Do you think we should stick to that?
> 
> @Akhil, @Thomas, what is the recommended way of documenting individual members of structure? Is it 'description after the item' or 'description before the item'?

In general, it is better to have the description before.
The description "after" is preferred for short descriptions
of struct items which fit on the same line with the item.



  reply	other threads:[~2019-09-04  7:46 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-09-03 12:57 [dpdk-dev] " Radu Nicolau
2019-09-04  3:41 ` [dpdk-dev] [EXT] " Anoob Joseph
2019-09-04  7:46   ` Thomas Monjalon [this message]
2019-09-04  9:27   ` Akhil Goyal
2019-09-04  9:18 ` [dpdk-dev] " Akhil Goyal
2019-09-04  9:27 ` [dpdk-dev] [EXT] " Anoob Joseph
2019-09-04 11:03 ` [dpdk-dev] [PATCH v2] " Radu Nicolau
2019-09-19 15:10   ` Akhil Goyal

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=18019128.8lTUtv1f9t@xps \
    --to=thomas@monjalon.net \
    --cc=akhil.goyal@nxp.com \
    --cc=anoobj@marvell.com \
    --cc=bernard.iremonger@intel.com \
    --cc=declan.doherty@intel.com \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@intel.com \
    --cc=konstantin.ananyev@intel.com \
    --cc=radu.nicolau@intel.com \
    --cc=stephen@networkplumber.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).