forked from Imagelibrary/rtems
Header File Doxygen Enhancement Task #7
This commit is contained in:
committed by
Jennifer Averett
parent
4ce0d45a06
commit
c5782a26b3
@@ -1,6 +1,8 @@
|
||||
/**
|
||||
* @file rtems/ringbuf.h
|
||||
*
|
||||
* @brief Simple Ring Buffer Functionality
|
||||
*
|
||||
* This file provides simple ring buffer functionality.
|
||||
*/
|
||||
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
/**
|
||||
* @file rtems/assoc.h
|
||||
*
|
||||
* @brief RTEMS Associativity Routines
|
||||
*
|
||||
* RTEMS associativity routines. Mainly used to convert a value from
|
||||
* one space to another (eg: our errno's to host errno's and vice-versa)
|
||||
*/
|
||||
@@ -139,7 +141,7 @@ const rtems_assoc_t *rtems_assoc_ptr_by_local(
|
||||
|
||||
/**
|
||||
* @brief RTEMS Associate Bad Name
|
||||
*
|
||||
*
|
||||
* what to return if a value is not found
|
||||
* this is not reentrant, but it really shouldn't be invoked anyway
|
||||
*/
|
||||
|
||||
@@ -1,10 +1,12 @@
|
||||
/**
|
||||
* @file rtems/error.h
|
||||
*
|
||||
* @brief RTEMS Error Reporting
|
||||
*
|
||||
* Defines and externs for rtems error reporting
|
||||
*
|
||||
*
|
||||
* Currently just used by RTEMS monitor.
|
||||
*
|
||||
*
|
||||
* These routines provide general purpose error reporting.
|
||||
* rtems_error reports an error to stderr and allows use of
|
||||
* printf style formatting. A newline is appended to all messages.
|
||||
@@ -53,9 +55,9 @@ extern "C" {
|
||||
* @defgroup ErrorPanicSupport Error And Panic Support
|
||||
*
|
||||
* @ingroup libcsupport
|
||||
*
|
||||
*
|
||||
* @brief Defines and externs for rtems error reporting
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
typedef Internal_errors_t rtems_error_code_t;
|
||||
@@ -82,13 +84,13 @@ const char *rtems_status_text(rtems_status_code sc);
|
||||
|
||||
/**
|
||||
* @brief Report an Error
|
||||
*
|
||||
*
|
||||
* @param[in] error_code can be specified as any of the following:
|
||||
* RTEMS_ERROR_ERRNO -- include errno text in output
|
||||
* RTEMS_ERROR_PANIC -- halts local system after output
|
||||
* RTEMS_ERROR_ABORT -- abort after output
|
||||
*
|
||||
* @param[in] printf_format is a normal printf(3) format string,
|
||||
*
|
||||
* @param[in] printf_format is a normal printf(3) format string,
|
||||
* with its concommitant arguments
|
||||
*
|
||||
* @return the number of characters written.
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
/**
|
||||
* @file rtems/framebuffer.h
|
||||
*
|
||||
* @brief Frame Buffer Device Driver for all Boards
|
||||
*
|
||||
* This file describes the Frame Buffer Device Driver for all boards.
|
||||
*/
|
||||
|
||||
|
||||
@@ -3,8 +3,8 @@
|
||||
*
|
||||
* @ingroup LibIO
|
||||
*
|
||||
* @brief Basic IO API.
|
||||
*
|
||||
* @brief Basic IO API
|
||||
*
|
||||
* This file contains the support infrastructure used to manage the
|
||||
* table of integer style file descriptors used by the low level
|
||||
* POSIX system calls like open(), read, fstat(), etc.
|
||||
@@ -1257,7 +1257,7 @@ typedef struct {
|
||||
|
||||
/**
|
||||
* @brief RTEMS LibIO Initialization
|
||||
*
|
||||
*
|
||||
* Called by BSP startup code to initialize the libio subsystem.
|
||||
*/
|
||||
void rtems_libio_init(void);
|
||||
@@ -1384,7 +1384,7 @@ static inline rtems_device_minor_number rtems_filesystem_dev_minor_t(
|
||||
|
||||
/**
|
||||
* @brief Base File System Initialization
|
||||
*
|
||||
*
|
||||
* Initialize the foundation of the file system. This is specified
|
||||
* by the structure rtems_filesystem_mount_table. The usual
|
||||
* configuration is a single instantiation of the IMFS or miniIMFS with
|
||||
|
||||
Reference in New Issue
Block a user