Messages in this thread | | | Date | Mon, 12 Jun 2006 10:39:54 -0700 | From | "Randy.Dunlap" <> | Subject | Re: [PATCH] CRC ITU-T V.41 |
| |
On Mon, 12 Jun 2006 19:32:34 +0200 Ivo van Doorn wrote:
> On Monday 12 June 2006 19:09, Randy.Dunlap wrote: > > On Mon, 12 Jun 2006 16:17:04 +0200 Ivo van Doorn wrote: > > > > > > +/** > > > + * Compute the CRC-ITU-T for the data buffer > > > > Please use Linux kernel-doc format. See > > Documentation/kernel-doc-nano-HOWTO.txt. Basically: > > Ah ok. I just followed the crc16 approach.
OK, I'll plan to fix that file's kernel-doc then.
> > * crc_itu_t - compute the CRC-ITU-T for the data buffer > > > > and make parameter changes below: > > > > > + * > > > + * @param crc previous CRC value > > > + * @param buffer data pointer > > > + * @param len number of bytes in the buffer > > > > * @crc: previous CRC value > > * @buffer: data pointer > > * @len: number of bytes in the buffer > > * > > * Returns the updated CRC value. > > > > > + * @return the updated CRC value > > > + */ > > > +u16 crc_itu_t(u16 crc, const u8 *buffer, size_t len) > > > +{ > > The updated patch would then become: > > Signed-off-by Ivo van Doorn <IvDoorn@gmail.com> > > --- > > +/** > + * crc_itu_t - Compute the CRC-ITU-T for the data buffer > + * > + * @crc previous CRC value > + * @buffer data pointer > + * @len number of bytes in the buffer
The kernel-doc doc. says to put a colon after each parameter name, so please do that too. Otherwise looks good, thanks.
> + * > + * Returns the updated CRC value > + */ > +u16 crc_itu_t(u16 crc, const u8 *buffer, size_t len) > +{
--- ~Randy - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
| |