diff options
author | Ayush Awasthi <kolaveridi87@gmail.com> | 2013-01-04 13:09:14 -0600 |
---|---|---|
committer | Jennifer Averett <jennifer.averett@oarcorp.com> | 2013-01-04 13:09:14 -0600 |
commit | a163882dae2f2935e19ec96f0d2a85d1c652be35 (patch) | |
tree | 8b2ea781569d24496f99d805bd0a04a88b7a29fc /cpukit/libmisc/fb | |
parent | posix: Doxygen Clean Up Task #2 (diff) | |
download | rtems-a163882dae2f2935e19ec96f0d2a85d1c652be35.tar.bz2 |
libmisc: Doxygen Clean Up Task #1
Conflicts occured durning this patch and modifications in
the repo were favored over the patch.
Diffstat (limited to 'cpukit/libmisc/fb')
-rw-r--r-- | cpukit/libmisc/fb/fb.h | 8 | ||||
-rw-r--r-- | cpukit/libmisc/fb/mw_uid.h | 60 |
2 files changed, 38 insertions, 30 deletions
diff --git a/cpukit/libmisc/fb/fb.h b/cpukit/libmisc/fb/fb.h index 5a896e19db..2304405a95 100644 --- a/cpukit/libmisc/fb/fb.h +++ b/cpukit/libmisc/fb/fb.h @@ -1,4 +1,10 @@ -/** @file rtems/fb.h +/** + * @file rtems/fb.h + * + * @defgroup libmisc_fb Device Driver + * + * @ingroup libmisc + * @brief Frame Buffer Device Driver * * This file defines the interface to a frame buffer device driver. */ diff --git a/cpukit/libmisc/fb/mw_uid.h b/cpukit/libmisc/fb/mw_uid.h index 794378b70b..8a10a8f38c 100644 --- a/cpukit/libmisc/fb/mw_uid.h +++ b/cpukit/libmisc/fb/mw_uid.h @@ -1,11 +1,13 @@ /** * @file rtems/mw_uid.h * - * @brief Input device Interface for MicroWindows in an - * Embedded System Enviroment + * @defgroup libmisc_fb_mw Input Devices for MicroWindows * - * This file defines the interface for input devices used by - * MicroWindows in an embedded system environment. + * @ingroup libmisc + * @brief Input Devices for MicroWindows + * + * This file defines the interface for input devices used by MicroWindows + * in an embedded system environment. */ /* @@ -112,43 +114,43 @@ struct MW_UID_MESSAGE { */ /** - * This method creates the message queue that holds events from the - * input devices. + * This method creates the message queue that holds events from the + * input devices. * - * @param[in] q_name is the name of the message queue - * @param[in] flags controls the behaviour of the queue - * @param[in] max_msgs specifies the maximum number of pending messages + * @param[in] q_name is the name of the message queue + * @param[in] flags controls the behaviour of the queue + * @param[in] max_msgs specifies the maximum number of pending messages * - * @note The message queue is from the Classic API. + * @note The message queue is from the Classic API. * - * @return This method returns 0 on success and -1 on error. + * @retval This method returns 0 on success and -1 on error. */ extern int uid_open_queue( const char *q_name, int flags, size_t max_msgs ); /** - * This method closes the message queue and deletes it. + * This method closes the message queue and deletes it. * - * @return This method returns 0 on success and -1 on error. + * @retval This method returns 0 on success and -1 on error. */ extern int uid_close_queue( void ); /** - * This method reads a message from the queue. It waits up to the specified - * timeout in miliseconds. A @a timeout of 0 is a poll. + * This method reads a message from the queue. It waits up to the specified + * timeout in miliseconds. A @a timeout of 0 is a poll. * - * @param[in] m will be filled in with the received message - * @param[in] timeout is the maximum number of mulliseconds to wait + * @param[in] m will be filled in with the received message + * @param[in] timeout is the maximum number of mulliseconds to wait * - * @return This method returns 0 on success and -1 on error. + * @retval This method returns 0 on success and -1 on error. */ extern int uid_read_message( struct MW_UID_MESSAGE *m, unsigned long timeout ); /** - * This methods writes a message to the queue. + * This methods writes a message to the queue. * - * @param[in] m is the message to send + * @param[in] m is the message to send * - * @return This method returns 0 on success and -1 on error. + * @retval This method returns 0 on success and -1 on error. */ extern int uid_send_message( struct MW_UID_MESSAGE *m ); @@ -165,22 +167,22 @@ extern int uid_unregister_device( int fd ); extern int uid_set_kbd_mode( int fd, int mode, int *old_mode ); /** - * This methods prints the specified UID message using printk + * This methods prints the specified UID message using printk * - * @param[in] uid points to the message to print + * @param[in] uid points to the message to print */ void uid_print_message( struct MW_UID_MESSAGE *uid ); /** - * This methods prints the specified UID message using your fprintf - * style method of choice. + * This methods prints the specified UID message using your fprintf + * style method of choice. * - * @param[in] context is a pointer to a data area which may be - * used by some print handlers - * @param[in] handler is the fprintf style method to invoke - * @param[in] uid points to the message to print + * @param[in] context is a pointer to a data area which may be + * used by some print handlers + * @param[in] handler is the fprintf style method to invoke + * @param[in] uid points to the message to print */ void uid_print_message_with_plugin( void *context, |