mtd: nand: fix DocBook warnings on nand_sdr_timings doc

[Linux-MTD Mailing List]

Gitweb:     http://git.infradead.org/?p=mtd-2.6.git;a=commit;h=b25046b1e5e3f1423434da77ccc859f2f779d1ce
Commit:     b25046b1e5e3f1423434da77ccc859f2f779d1ce
Parent:     5d20bad19d25bb25d9e831dd342c7c714d872b53
Author:     Boris BREZILLON <boris.brezillon at free-electrons.com>
AuthorDate: Sun Aug 17 10:29:42 2014 +0200
Committer:  Brian Norris <computersforpeace at gmail.com>
CommitDate: Tue Aug 19 11:55:38 2014 -0700

    mtd: nand: fix DocBook warnings on nand_sdr_timings doc
    
    Change the comment type (from /** to /*) to prevent DocBook from
    complaining about missing description for nand_sdr_timings fields.
    
    There is currently no need in documenting those fields because they are
    fully described in the ONFI specification (which is pointed out in the
    comment).
    
    Signed-off-by: Boris BREZILLON <boris.brezillon at free-electrons.com>
    Reported-by: Randy Dunlap <rdunlap at infradead.org>
    Acked-by: Randy Dunlap <rdunlap at infradead.org>
    Tested-by: Randy Dunlap <rdunlap at infradead.org>
    Signed-off-by: Brian Norris <computersforpeace at gmail.com>
---
 include/linux/mtd/nand.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/mtd/nand.h b/include/linux/mtd/nand.h
index 3083c53..c300db3 100644
--- a/include/linux/mtd/nand.h
+++ b/include/linux/mtd/nand.h
@@ -949,7 +949,7 @@ static inline int jedec_feature(struct nand_chip *chip)
 		: 0;
 }
 
-/**
+/*
  * struct nand_sdr_timings - SDR NAND chip timings
  *
  * This struct defines the timing requirements of a SDR NAND chip.