Commit a871773f authored by Ian Abbott's avatar Ian Abbott Committed by Greg Kroah-Hartman

staging: comedi: comedidev.h: tweak kernel-doc for struct comedi_async

Tweak the formatting of the kernel-doc formatted comment for `struct
comedi_async` in order to stop it generating bogus headings for text
before a colon.
Signed-off-by: default avatarIan Abbott <abbotti@mev.co.uk>
Reviewed-by: default avatarH Hartley Sweeten <hsweeten@visionengravers.com>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 251a16ab
...@@ -136,31 +136,36 @@ struct comedi_buf_map { ...@@ -136,31 +136,36 @@ struct comedi_buf_map {
* *
* Think of the _Count values being integers of unlimited size, indexing * Think of the _Count values being integers of unlimited size, indexing
* into a buffer of infinite length (though only an advancing portion * into a buffer of infinite length (though only an advancing portion
* of the buffer of fixed length prealloc_bufsz is accessible at any time). * of the buffer of fixed length prealloc_bufsz is accessible at any
* Then: * time). Then:
* *
* Buf_Read_Count <= Buf_Read_Alloc_Count <= Munge_Count <= * Buf_Read_Count <= Buf_Read_Alloc_Count <= Munge_Count <=
* Buf_Write_Count <= Buf_Write_Alloc_Count <= * Buf_Write_Count <= Buf_Write_Alloc_Count <=
* (Buf_Read_Count + prealloc_bufsz) * (Buf_Read_Count + prealloc_bufsz)
* *
* (Those aren't the actual members, apart from prealloc_bufsz.) When * (Those aren't the actual members, apart from prealloc_bufsz.) When the
* the buffer is reset, those _Count values start at 0 and only increase * buffer is reset, those _Count values start at 0 and only increase in value,
* in value, maintaining the above inequalities until the next time the * maintaining the above inequalities until the next time the buffer is
* buffer is reset. The buffer is divided into the following regions by * reset. The buffer is divided into the following regions by the inequalities:
* the inequalities:
* *
* [0, Buf_Read_Count): * [0, Buf_Read_Count):
* old region no longer accessible * old region no longer accessible
*
* [Buf_Read_Count, Buf_Read_Alloc_Count): * [Buf_Read_Count, Buf_Read_Alloc_Count):
* filled and munged region allocated for reading but not yet read * filled and munged region allocated for reading but not yet read
*
* [Buf_Read_Alloc_Count, Munge_Count): * [Buf_Read_Alloc_Count, Munge_Count):
* filled and munged region not yet allocated for reading * filled and munged region not yet allocated for reading
*
* [Munge_Count, Buf_Write_Count): * [Munge_Count, Buf_Write_Count):
* filled region not yet munged * filled region not yet munged
*
* [Buf_Write_Count, Buf_Write_Alloc_Count): * [Buf_Write_Count, Buf_Write_Alloc_Count):
* unfilled region allocated for writing but not yet written * unfilled region allocated for writing but not yet written
*
* [Buf_Write_Alloc_Count, Buf_Read_Count + prealloc_bufsz): * [Buf_Write_Alloc_Count, Buf_Read_Count + prealloc_bufsz):
* unfilled region not yet allocated for writing * unfilled region not yet allocated for writing
*
* [Buf_Read_Count + prealloc_bufsz, infinity): * [Buf_Read_Count + prealloc_bufsz, infinity):
* unfilled region not yet accessible * unfilled region not yet accessible
* *
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment