* struct nand_sdr_timings kernel-doc
@ 2014-08-16 18:00 Randy Dunlap
2014-08-17 8:16 ` Boris BREZILLON
0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2014-08-16 18:00 UTC (permalink / raw)
To: linux-mtd, Brian Norris, Boris BREZILLON
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
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: struct nand_sdr_timings kernel-doc
2014-08-16 18:00 struct nand_sdr_timings kernel-doc Randy Dunlap
@ 2014-08-17 8:16 ` Boris BREZILLON
0 siblings, 0 replies; 2+ messages in thread
From: Boris BREZILLON @ 2014-08-17 8:16 UTC (permalink / raw)
To: Randy Dunlap; +Cc: Brian Norris, linux-mtd
Hi Randy,
On Sat, 16 Aug 2014 11:00:03 -0700
Randy Dunlap <rdunlap@infradead.org> wrote:
> 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
If you don't mind I'll go for this solution.
Brian, is that okay for you ?
> 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.
>
Best Regards,
Boris
--
Boris Brezillon, Free Electrons
Embedded Linux and Kernel engineering
http://free-electrons.com
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2014-08-17 8:17 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-08-16 18:00 struct nand_sdr_timings kernel-doc Randy Dunlap
2014-08-17 8:16 ` Boris BREZILLON
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox