struct nand_sdr_timings kernel-doc

[Boris BREZILLON]

Hi Randy,

On Sat, 16 Aug 2014 11:00:03 -0700
Randy Dunlap <rdunlap at 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