Make sure that labeling is used consistently in all function headers.

This commit is contained in:
Gregory Nutt
2018-02-01 10:00:02 -06:00
parent a096bc1266
commit 7cf88d7dbd
1171 changed files with 3042 additions and 3039 deletions
+2 -1
View File
@@ -54,7 +54,8 @@
/****************************************************************************
* Name: fstatfs
*
* Return: Zero on success; -1 on failure with errno set:
* Returned Value:
* Zero on success; -1 on failure with errno set:
*
* EACCES Search permission is denied for one of the directories in the
* path prefix of path.
+2 -2
View File
@@ -68,7 +68,7 @@
* req The ioctl command
* arg The argument of the ioctl cmd
*
* Return:
* Returned Value:
* Returns a non-negative number on success; A negated errno value is
* returned on any failure (see comments ioctl() for a list of appropriate
* errno values).
@@ -114,7 +114,7 @@ int file_ioctl(FAR struct file *filep, int req, unsigned long arg)
* req The ioctl command
* arg The argument of the ioctl cmd
*
* Return:
* Returned Value:
* >=0 on success (positive non-zero values are cmd-specific)
* -1 on failure with errno set properly:
*
+2 -2
View File
@@ -65,7 +65,7 @@
* offset Defines the offset to position to
* whence Defines how to use offset
*
* Return:
* Returned Value:
* The resulting offset on success. A negated errno value is returned on
* any failure (see lseek comments).
*
@@ -146,7 +146,7 @@ off_t file_seek(FAR struct file *filep, off_t offset, int whence)
* offset Defines the offset to position to
* whence Defines how to use offset
*
* Return:
* Returned Value:
* The resulting offset on success. -1 on failure withi errno set properly:
*
* EBADF fd is not an open file descriptor.
+2 -2
View File
@@ -357,14 +357,14 @@ int fdesc_poll(int fd, FAR struct pollfd *fds, bool setup)
* occurred for any of the file descriptors, then poll() blocks until
* one of the events occurs.
*
* Inputs:
* Input Parameters:
* fds - List of structures describing file descriptors to be monitored
* nfds - The number of entries in the list
* timeout - Specifies an upper limit on the time for which poll() will
* block in milliseconds. A negative value of timeout means an infinite
* timeout.
*
* Return:
* Returned Value:
* On success, the number of structures that have non-zero revents fields.
* A value of 0 indicates that the call timed out and no file descriptors
* were ready. On error, -1 is returned, and errno is set appropriately:
+1 -1
View File
@@ -129,7 +129,7 @@ ssize_t file_pread(FAR struct file *filep, FAR void *buf, size_t nbytes,
* nbytes The maximum size of the user-provided buffer
* offset The file offset
*
* Return:
* Returned Value:
* The positive non-zero number of bytes read on success, 0 on if an
* end-of-file condition, or -1 on failure with errno set appropriately.
* See read() return values
+1 -1
View File
@@ -126,7 +126,7 @@ ssize_t file_pwrite(FAR struct file *filep, FAR const void *buf,
* buf Data to write
* nbytes Length of data to write
*
* Return:
* Returned Value:
* The positive non-zero number of bytes read on success, 0 on if an
* end-of-file condition, or -1 on failure with errno set appropriately.
* See write() return values
+2 -2
View File
@@ -84,7 +84,7 @@
* is more wasteful of resources and poll() is the recommended API to be
* used.
*
* Input parameters:
* Input Parameters:
* nfds - the maximum fd number (+1) of any descriptor in any of the
* three sets.
* readfds - the set of descriptions to monitor for read-ready events
@@ -93,7 +93,7 @@
* timeout - Return at this time if none of these events of interest
* occur.
*
* Return:
* Returned Value:
* 0: Timer expired
* >0: The number of bits set in the three sets of descriptors
* -1: An error occurred (errno will be set appropriately)
+1 -1
View File
@@ -74,7 +74,7 @@
* different semantics and prototypes. sendfile() should not be used
* in portable programs.
*
* Input Parmeters:
* Input Parameters:
* infd - A file (or socket) descriptor opened for reading
* outfd - A descriptor opened for writing.
* offset - If 'offset' is not NULL, then it points to a variable
+2 -1
View File
@@ -70,7 +70,8 @@ static int statpseudofs(FAR struct inode *inode, FAR struct statfs *buf)
/****************************************************************************
* Name: statfs
*
* Return: Zero on success; -1 on failure with errno set:
* Returned Value:
* Zero on success; -1 on failure with errno set:
*
* EACCES Search permission is denied for one of the directories in the
* path prefix of path.