kernel-doc: fix fs/pipe.c notation

Fix several kernel-doc notation errors in fs/pipe.c.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Cc: Jens Axboe <jens.axboe@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Randy Dunlap 2008-02-13 15:03:22 -08:00 committed by Linus Torvalds
parent 55265b00ad
commit b51d63c6d3

View File

@ -171,7 +171,7 @@ static void anon_pipe_buf_release(struct pipe_inode_info *pipe,
* *
* Description: * Description:
* This function returns a kernel virtual address mapping for the * This function returns a kernel virtual address mapping for the
* passed in @pipe_buffer. If @atomic is set, an atomic map is provided * pipe_buffer passed in @buf. If @atomic is set, an atomic map is provided
* and the caller has to be careful not to fault before calling * and the caller has to be careful not to fault before calling
* the unmap function. * the unmap function.
* *
@ -208,15 +208,15 @@ void generic_pipe_buf_unmap(struct pipe_inode_info *pipe,
} }
/** /**
* generic_pipe_buf_steal - attempt to take ownership of a @pipe_buffer * generic_pipe_buf_steal - attempt to take ownership of a &pipe_buffer
* @pipe: the pipe that the buffer belongs to * @pipe: the pipe that the buffer belongs to
* @buf: the buffer to attempt to steal * @buf: the buffer to attempt to steal
* *
* Description: * Description:
* This function attempts to steal the @struct page attached to * This function attempts to steal the &struct page attached to
* @buf. If successful, this function returns 0 and returns with * @buf. If successful, this function returns 0 and returns with
* the page locked. The caller may then reuse the page for whatever * the page locked. The caller may then reuse the page for whatever
* he wishes, the typical use is insertion into a different file * he wishes; the typical use is insertion into a different file
* page cache. * page cache.
*/ */
int generic_pipe_buf_steal(struct pipe_inode_info *pipe, int generic_pipe_buf_steal(struct pipe_inode_info *pipe,
@ -238,7 +238,7 @@ int generic_pipe_buf_steal(struct pipe_inode_info *pipe,
} }
/** /**
* generic_pipe_buf_get - get a reference to a @struct pipe_buffer * generic_pipe_buf_get - get a reference to a &struct pipe_buffer
* @pipe: the pipe that the buffer belongs to * @pipe: the pipe that the buffer belongs to
* @buf: the buffer to get a reference to * @buf: the buffer to get a reference to
* *