Standardization of some function headers.

This commit is contained in:
Gregory Nutt
2018-03-13 09:52:27 -06:00
parent c268288c17
commit b54ffe858a
488 changed files with 2008 additions and 2007 deletions
+1 -1
View File
@@ -76,7 +76,7 @@
* support simulation of memory mapped files by copying files whole
* into RAM.
*
* Parameters:
* Input Parameters:
* start A hint at where to map the memory -- ignored. The address
* of the underlying media is fixed and cannot be re-mapped without
* MMU support.
+1 -1
View File
@@ -95,7 +95,7 @@
* into RAM. munmap() is required in this case to free the allocated
* memory holding the shared copy of the file.
*
* Parameters:
* Input Parameters:
* start The start address of the mapping to delete. For this
* simplified munmap() implementation, the *must* be the start
* address of the memory region (the same address returned by
+1 -1
View File
@@ -96,7 +96,7 @@ void rammap_initialize(void)
* Description:
* Support simulation of memory mapped files by copying files into RAM.
*
* Parameters:
* Input Parameters:
* fd file descriptor of the backing file -- required.
* length The length of the mapping. For exception #1 above, this length
* ignored: The entire underlying media is always accessible.
+1 -1
View File
@@ -121,7 +121,7 @@ void rammap_initialize(void);
* Description:
* Support simulation of memory mapped files by copying files into RAM.
*
* Parameters:
* Input Parameters:
* fd file descriptor of the backing file -- required.
* length The length of the mapping. For exception #1 above, this length
* ignored: The entire underlying media is always accessible.
+3 -3
View File
@@ -63,7 +63,7 @@
* deallocates any system resources allocated by the system for use by
* this task for its message queue.
*
* Parameters:
* Input Parameters:
* mqdes - Message queue descriptor.
* group - Group that has the open descriptor.
*
@@ -122,7 +122,7 @@ int nxmq_close_group(mqd_t mqdes, FAR struct task_group_s *group)
* via this mqdes, this attachment will be removed and the message queue
* is available for another process to attach a notification.
*
* Parameters:
* Input Parameters:
* mqdes - Message queue descriptor.
*
* Returned Value:
@@ -173,7 +173,7 @@ int mq_close(mqd_t mqdes)
* Description:
* Release a reference count on a message queue inode.
*
* Parameters:
* Input Parameters:
* inode - The message queue inode
*
* Returned Value:
+1 -1
View File
@@ -67,7 +67,7 @@
* message queue remains usable until it is closed by a successful call to
* mq_close().
*
* Parameters:
* Input Parameters:
* mq_name - Name of the queue to open
* oflags - open flags
* Optional parameters. When the O_CREAT flag is specified, two optional
+1 -1
View File
@@ -63,7 +63,7 @@
* removal of the message queue is postponed until all references to the
* message queue have been closed.
*
* Parameters:
* Input Parameters:
* mq_name - Name of the message queue
*
* Returned Value:
+1 -1
View File
@@ -77,7 +77,7 @@ extern "C"
* Description:
* Release a reference count on a message queue inode.
*
* Parameters:
* Input Parameters:
* inode - The message queue inode
*
* Returned Value:
+1 -1
View File
@@ -68,7 +68,7 @@
* named semaphore has been fully unlinked, the semaphore will vanish when
* the last task closes it.
*
* Parameters:
* Input Parameters:
* sem - semaphore descriptor
*
* Returned Value:
+1 -1
View File
@@ -77,7 +77,7 @@
* the same semaphore address is returned (provided there have been no
* calls to sem_unlink()).
*
* Parameters:
* Input Parameters:
* name - Semaphore name
* oflags - Semaphore creation options. This may either or both of the
* following bit settings.
+1 -1
View File
@@ -67,7 +67,7 @@
* called, destruction of the semaphore will be postponed until all
* references to the semaphore have been destroyed by calls of sem_close().
*
* Parameters:
* Input Parameters:
* name - Semaphore name
*
* Returned Value:
+1 -1
View File
@@ -69,7 +69,7 @@
* associated with it are freed; if the descriptor was the last reference
* to a file which has been removed using unlink(2) the file is deleted.
*
* Parameters:
* Input Parameters:
* fd file descriptor to close
*
* Returned Value:
+2 -2
View File
@@ -63,7 +63,7 @@
* Description:
* Perform device specific operations.
*
* Parameters:
* Input Parameters:
* file File structure instance
* req The ioctl command
* arg The argument of the ioctl cmd
@@ -109,7 +109,7 @@ int file_ioctl(FAR struct file *filep, int req, unsigned long arg)
* Description:
* Perform device specific operations.
*
* Parameters:
* Input Parameters:
* fd File/socket descriptor of device
* req The ioctl command
* arg The argument of the ioctl cmd
+2 -2
View File
@@ -60,7 +60,7 @@
* This is the internal implementation of lseek. See the comments in
* lseek() for further information.
*
* Parameters:
* Input Parameters:
* file File structure instance
* offset Defines the offset to position to
* whence Defines how to use offset
@@ -143,7 +143,7 @@ off_t file_seek(FAR struct file *filep, off_t offset, int whence)
* at this point, subsequent reads of the data in the gap (a "hole") return null
* bytes ('\0') until data is actually written into the gap.
*
* Parameters:
* Input Parameters:
* fd File descriptor of device
* offset Defines the offset to position to
* whence Defines how to use offset
+1 -1
View File
@@ -123,7 +123,7 @@ ssize_t file_pread(FAR struct file *filep, FAR void *buf, size_t nbytes,
* require four system calls. If it is implemented within the kernel,
* only three.
*
* Parameters:
* Input Parameters:
* file File structure instance
* buf User-provided to save the data
* nbytes The maximum size of the user-provided buffer
+1 -1
View File
@@ -121,7 +121,7 @@ ssize_t file_pwrite(FAR struct file *filep, FAR const void *buf,
* require four system calls. If it is implemented within the kernel,
* only three.
*
* Parameters:
* Input Parameters:
* fd file descriptor (or socket descriptor) to write to
* buf Data to write
* nbytes Length of data to write