[MTD] [NAND] S3C2410: Added a kerneldoc for s3c2410_nand_set

[Linux-MTD Mailing List]

Gitweb:     http://git.infradead.org/?p=mtd-2.6.git;a=commit;h=a4536b19df92adda215f6fc225b52dc4cee4cf83
Commit:     a4536b19df92adda215f6fc225b52dc4cee4cf83
Parent:     ed27f0287062236d50190d7447f6377ff4acdfad
Author:     Michel Pollet <buserror at gmail.com>
AuthorDate: Wed May 13 16:54:13 2009 +0100
Committer:  Ben Dooks <ben-linux at fluff.org>
CommitDate: Mon Jun 8 12:10:29 2009 +0100

    [MTD] [NAND] S3C2410: Added a kerneldoc for s3c2410_nand_set
    
    Converted the old comnent to kerneldoc.
    
    Signed-off-by: Michel Pollet <buserror at gmail.com>
    [ben-linux at fluff.org: updated subject, spello fix]
    Signed-off-by: Ben Dooks <ben-linux at fluff.org>
---
 arch/arm/plat-s3c/include/plat/nand.h |   22 ++++++++++++----------
 1 files changed, 12 insertions(+), 10 deletions(-)

diff --git a/arch/arm/plat-s3c/include/plat/nand.h b/arch/arm/plat-s3c/include/plat/nand.h
index 9855467..9356516 100644
--- a/arch/arm/plat-s3c/include/plat/nand.h
+++ b/arch/arm/plat-s3c/include/plat/nand.h
@@ -10,17 +10,19 @@
  * published by the Free Software Foundation.
 */
 
-/* struct s3c2410_nand_set
+/**
+ * struct s3c2410_nand_set - define a set of one or more nand chips
+ * @disable_ecc:	Entirely disable ECC - Dangerous
+ * @nr_chips:		Number of chips in this set
+ * @nr_partitions:	Number of partitions pointed to by @partitions
+ * @name:		Name of set (optional)
+ * @nr_map:		Map for low-layer logical to physical chip numbers (option)
+ * @partitions:		The mtd partition list
  *
- * define an set of one or more nand chips registered with an unique mtd
- *
- * nr_chips	 = number of chips in this set
- * nr_partitions = number of partitions pointed to be partitoons (or zero)
- * name		 = name of set (optional)
- * nr_map	 = map for low-layer logical to physical chip numbers (option)
- * partitions	 = mtd partition list
-*/
-
+ * define a set of one or more nand chips registered with an unique mtd. Also
+ * allows to pass flag to the underlying NAND layer. 'disable_ecc' will trigger
+ * a warning at boot time.
+ */
 struct s3c2410_nand_set {
 	unsigned int		disable_ecc:1;