mtd: nand: fix htmldocs warnings

Linux-MTD Mailing List linux-mtd at lists.infradead.org
Thu Sep 24 10:59:01 EDT 2009


Gitweb:     http://git.infradead.org/?p=mtd-2.6.git;a=commit;h=58475fb908485ab38860d6970a8063987fe1d619
Commit:     58475fb908485ab38860d6970a8063987fe1d619
Parent:     a7c367b95a9d8e65e0f0e7da31f700a556794efb
Author:     Jaswinder Singh Rajput <jaswinder at kernel.org>
AuthorDate: Thu Sep 24 13:04:53 2009 +0100
Committer:  David Woodhouse <David.Woodhouse at intel.com>
CommitDate: Thu Sep 24 07:46:25 2009 -0700

    mtd: nand: fix htmldocs warnings
    
    Fixed following htmldocs warnings:
    
      DOCPROC Documentation/DocBook/mtdnand.xml
      Warning(drivers/mtd/nand/nand_base.c:769): No description found for parameter 'page'
      Warning(drivers/mtd/nand/nand_base.c:785): No description found for parameter 'page'
      Warning(drivers/mtd/nand/nand_base.c:824): No description found for parameter 'page'
      Warning(drivers/mtd/nand/nand_base.c:947): No description found for parameter 'page'
      Warning(drivers/mtd/nand/nand_base.c:996): No description found for parameter 'page'
      Warning(drivers/mtd/nand/nand_base.c:1040): No description found for parameter 'page'
    
    Signed-off-by: Jaswinder Singh Rajput <jaswinderrajput at gmail.com>
    Signed-off-by: David Woodhouse <David.Woodhouse at intel.com>
---
 drivers/mtd/nand/nand_base.c |    6 ++++++
 1 files changed, 6 insertions(+), 0 deletions(-)

diff --git a/drivers/mtd/nand/nand_base.c b/drivers/mtd/nand/nand_base.c
index 2211386..2957cc7 100644
--- a/drivers/mtd/nand/nand_base.c
+++ b/drivers/mtd/nand/nand_base.c
@@ -761,6 +761,7 @@ static int nand_wait(struct mtd_info *mtd, struct nand_chip *chip)
  * @mtd:	mtd info structure
  * @chip:	nand chip info structure
  * @buf:	buffer to store read data
+ * @page:	page number to read
  *
  * Not for syndrome calculating ecc controllers, which use a special oob layout
  */
@@ -777,6 +778,7 @@ static int nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
  * @mtd:	mtd info structure
  * @chip:	nand chip info structure
  * @buf:	buffer to store read data
+ * @page:	page number to read
  *
  * We need a special oob layout and handling even when OOB isn't used.
  */
@@ -818,6 +820,7 @@ static int nand_read_page_raw_syndrome(struct mtd_info *mtd, struct nand_chip *c
  * @mtd:	mtd info structure
  * @chip:	nand chip info structure
  * @buf:	buffer to store read data
+ * @page:	page number to read
  */
 static int nand_read_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
 				uint8_t *buf, int page)
@@ -939,6 +942,7 @@ static int nand_read_subpage(struct mtd_info *mtd, struct nand_chip *chip, uint3
  * @mtd:	mtd info structure
  * @chip:	nand chip info structure
  * @buf:	buffer to store read data
+ * @page:	page number to read
  *
  * Not for syndrome calculating ecc controllers which need a special oob layout
  */
@@ -983,6 +987,7 @@ static int nand_read_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
  * @mtd:	mtd info structure
  * @chip:	nand chip info structure
  * @buf:	buffer to store read data
+ * @page:	page number to read
  *
  * Hardware ECC for large page chips, require OOB to be read first.
  * For this ECC mode, the write_page method is re-used from ECC_HW.
@@ -1031,6 +1036,7 @@ static int nand_read_page_hwecc_oob_first(struct mtd_info *mtd,
  * @mtd:	mtd info structure
  * @chip:	nand chip info structure
  * @buf:	buffer to store read data
+ * @page:	page number to read
  *
  * The hw generator calculates the error syndrome automatically. Therefor
  * we need a special oob layout and handling.



More information about the linux-mtd-cvs mailing list