[PATCH] kernel-doc for lib/crc*.c

Make kernel-doc corrections & additions to lib/crc*.c.  Add crc functions to
kernel-api.tmpl in DocBook.

Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>

diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl
index 428c217..82d0cdc 100644 (file)
--- a/Documentation/DocBook/kernel-api.tmpl
+++ b/Documentation/DocBook/kernel-api.tmpl
@@ -129,6 +129,12 @@ X!Ilib/string.c
      <sect1><title>Command-line Parsing</title>
 !Elib/cmdline.c
      </sect1>
+
+     <sect1><title>CRC Functions</title>
+!Elib/crc16.c
+!Elib/crc32.c
+!Elib/crc-ccitt.c
+     </sect1>
   </chapter>
 
   <chapter id="mm">

diff --git a/lib/crc-ccitt.c b/lib/crc-ccitt.c
index 115d149..7f6dd68 100644 (file)
--- a/lib/crc-ccitt.c
+++ b/lib/crc-ccitt.c
@@ -53,9 +53,9 @@ EXPORT_SYMBOL(crc_ccitt_table);
 
 /**
  *     crc_ccitt - recompute the CRC for the data buffer
- *     @crc - previous CRC value
- *     @buffer - data pointer
- *     @len - number of bytes in the buffer
+ *     @crc: previous CRC value
+ *     @buffer: data pointer
+ *     @len: number of bytes in the buffer
  */
 u16 crc_ccitt(u16 crc, u8 const *buffer, size_t len)
 {

diff --cc lib/crc16.c
Simple merge

diff --cc lib/crc32.c
Simple merge