mirror of
https://github.com/xcat2/xNBA.git
synced 2025-01-18 21:43:14 +00:00
More doxygen docs
This commit is contained in:
parent
b115d1655c
commit
0e921cdd9e
@ -6,7 +6,18 @@
|
||||
*
|
||||
* Error codes and descriptions.
|
||||
*
|
||||
* This file provides the global variable errno
|
||||
* This file provides the global variable #errno and the function
|
||||
* strerror(). These function much like their standard C library
|
||||
* equivalents.
|
||||
*
|
||||
* The error numbers used by Etherboot are a superset of those defined
|
||||
* by the PXE specification version 2.1. See errno.h for a listing of
|
||||
* the error values.
|
||||
*
|
||||
* To save space in ROM images, error string tables are optional. Use
|
||||
* the ERRORMSG_XXX options in config.h to select which error string
|
||||
* tables you want to include. If an error string table is omitted,
|
||||
* strerror() will simply return the text "Error 0x<errno>".
|
||||
*
|
||||
*/
|
||||
|
||||
@ -29,7 +40,7 @@ static struct errortab errortab_end[0] __table_end(errortab);
|
||||
* @ret strerror Pointer to error text
|
||||
*
|
||||
* If the error is not found in the linked-in error tables, generates
|
||||
* a generic "Error 0x0000" message.
|
||||
* a generic "Error 0x<errno>" message.
|
||||
*
|
||||
* The pointer returned by strerror() is valid only until the next
|
||||
* call to strerror().
|
||||
|
@ -1,11 +1,9 @@
|
||||
#ifndef ERRNO_H
|
||||
#define ERRNO_H
|
||||
|
||||
/*
|
||||
* We define error codes that are a superset of those mentioned in the
|
||||
* PXE specification. Various error string tables may be compiled in
|
||||
* if required; if not compiled in, strerror(errno) will produce the
|
||||
* text "error 0x<errno>".
|
||||
/** @file
|
||||
*
|
||||
* Error codes
|
||||
*
|
||||
*/
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user