summaryrefslogtreecommitdiff
path: root/lib/crc16.c
diff options
context:
space:
mode:
authorRandy Dunlap <rdunlap@xenotime.net>2006-06-25 05:48:59 -0700
committerLinus Torvalds <torvalds@g5.osdl.org>2006-06-25 10:01:20 -0700
commit2f72100c01dd31d769097c58874e8ab1e70b2518 (patch)
treee8f654f519f56ac37de88533e3d93a3e80cb6454 /lib/crc16.c
parent28e83baac20e3fe624af89a55eb06c2a7cab6828 (diff)
downloadlinux-3.10-2f72100c01dd31d769097c58874e8ab1e70b2518.tar.gz
linux-3.10-2f72100c01dd31d769097c58874e8ab1e70b2518.tar.bz2
linux-3.10-2f72100c01dd31d769097c58874e8ab1e70b2518.zip
[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>
Diffstat (limited to 'lib/crc16.c')
-rw-r--r--lib/crc16.c10
1 files changed, 5 insertions, 5 deletions
diff --git a/lib/crc16.c b/lib/crc16.c
index 011fe573c66..8737b084d1f 100644
--- a/lib/crc16.c
+++ b/lib/crc16.c
@@ -47,12 +47,12 @@ u16 const crc16_table[256] = {
EXPORT_SYMBOL(crc16_table);
/**
- * Compute the CRC-16 for the data buffer
+ * crc16 - compute the CRC-16 for the data buffer
+ * @crc: previous CRC value
+ * @buffer: data pointer
+ * @len: number of bytes in the buffer
*
- * @param crc previous CRC value
- * @param buffer data pointer
- * @param len number of bytes in the buffer
- * @return the updated CRC value
+ * Returns the updated CRC value.
*/
u16 crc16(u16 crc, u8 const *buffer, size_t len)
{