Add doxygen documentation

pull/1/head
Michael Brown 2005-05-18 14:44:38 +00:00
parent 127362581f
commit d04b607eb9
1 changed files with 25 additions and 4 deletions

View File

@ -1,17 +1,38 @@
#include "etherboot.h"
#include "errno.h" #include "errno.h"
#include "vsprintf.h" #include "vsprintf.h"
/* Global "last error" number */ /** @file
*
* Error codes and descriptions.
*
* This file provides the global variable errno
*
*/
/**
* Global "last error" number.
*
* This is valid only when a function has just returned indicating a
* failure.
*
*/
int errno; int errno;
static struct errortab errortab_start[0] __table_start(errortab); static struct errortab errortab_start[0] __table_start(errortab);
static struct errortab errortab_end[0] __table_end(errortab); static struct errortab errortab_end[0] __table_end(errortab);
/* /**
* Retrieve string representation of error number. * Retrieve string representation of error number.
* *
* If error not found in the error table, generate a generic "Error * @v errno Error number
* 0x0000" message. * @ret strerror Pointer to error text
*
* If the error is not found in the linked-in error tables, generates
* a generic "Error 0x0000" message.
*
* The pointer returned by strerror() is valid only until the next
* call to strerror().
* *
*/ */
const char * strerror ( int errno ) { const char * strerror ( int errno ) {