public inbox for linux-mtd@lists.infradead.org
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: linux-mtd@lists.infradead.org,
	Brian Norris <computersforpeace@gmail.com>,
	Boris BREZILLON <boris.brezillon@free-electrons.com>
Subject: struct nand_sdr_timings kernel-doc
Date: Sat, 16 Aug 2014 11:00:03 -0700	[thread overview]
Message-ID: <53EF9C23.1050006@infradead.org> (raw)

Hi,

Current DocBook complains as follows:

Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tALH_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tADL_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tALS_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tAR_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tCEA_max'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tCEH_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tCH_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tCHZ_max'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tCLH_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tCLR_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tCLS_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tCOH_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tCS_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tDH_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tDS_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tFEAT_max'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tIR_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tITC_max'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tRC_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tREA_max'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tREH_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tRHOH_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tRHW_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tRHZ_max'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tRLOH_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tRP_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tRR_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tRST_max'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tWB_max'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tWC_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tWH_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tWHR_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tWP_min'
Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tWW_min'


Please eliminate all of those warnings by:
a. adding kernel-doc notation for each struct field; or
b. changing the beginning /** to /*; or
c. add /* private */ before the first struct member so that each struct item
   does not need to be described; or
d. some other way that suits you.

Thanks.


-- 
~Randy

             reply	other threads:[~2014-08-16 18:00 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-08-16 18:00 Randy Dunlap [this message]
2014-08-17  8:16 ` struct nand_sdr_timings kernel-doc Boris BREZILLON

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=53EF9C23.1050006@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=boris.brezillon@free-electrons.com \
    --cc=computersforpeace@gmail.com \
    --cc=linux-mtd@lists.infradead.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