mirror of https://github.com/ipxe/ipxe.git
Use "#var" rather than "@c var" for doxygen.
parent
bf32da87f0
commit
a96759f9c8
|
@ -22,7 +22,7 @@
|
||||||
* @ret 0 (if buf == NULL)
|
* @ret 0 (if buf == NULL)
|
||||||
* @err None
|
* @err None
|
||||||
*
|
*
|
||||||
* If @c buf==NULL, then the string will be written to the console
|
* If #buf==NULL, then the string will be written to the console
|
||||||
* directly using putchar().
|
* directly using putchar().
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -159,7 +159,7 @@ static int vsprintf(char *buf, const char *fmt, va_list args)
|
||||||
* @ret 0 (if buf == NULL)
|
* @ret 0 (if buf == NULL)
|
||||||
* @err None
|
* @err None
|
||||||
*
|
*
|
||||||
* If @c buf==NULL, then the string will be written to the console
|
* If #buf==NULL, then the string will be written to the console
|
||||||
* directly using putchar().
|
* directly using putchar().
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -52,8 +52,8 @@
|
||||||
* an ISAPnP device.
|
* an ISAPnP device.
|
||||||
*
|
*
|
||||||
* External code (e.g. the ISAPnP ROM prefix) may already know the
|
* External code (e.g. the ISAPnP ROM prefix) may already know the
|
||||||
* read port address, in which case it can store it in @c
|
* read port address, in which case it can store it in
|
||||||
* isapnp_read_port. Note that setting the read port address in this
|
* #isapnp_read_port. Note that setting the read port address in this
|
||||||
* way will prevent further isolation from taking place; you should
|
* way will prevent further isolation from taking place; you should
|
||||||
* set the read port address only if you know that devices have
|
* set the read port address only if you know that devices have
|
||||||
* already been allocated CSNs.
|
* already been allocated CSNs.
|
||||||
|
@ -332,7 +332,7 @@ static inline uint8_t isapnp_peek_byte ( void ) {
|
||||||
* @ret None
|
* @ret None
|
||||||
* @err None
|
* @err None
|
||||||
*
|
*
|
||||||
* Resource data is read from the current location. If @c buf is NULL,
|
* Resource data is read from the current location. If #buf is NULL,
|
||||||
* the data is discarded.
|
* the data is discarded.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -359,7 +359,7 @@ static void isapnp_peek ( uint8_t *buf, size_t bytes ) {
|
||||||
*
|
*
|
||||||
* Scan through the resource data until we find a particular tag, and
|
* Scan through the resource data until we find a particular tag, and
|
||||||
* read its contents into a buffer. It is the caller's responsibility
|
* read its contents into a buffer. It is the caller's responsibility
|
||||||
* to ensure that @c buf is large enough to contain a tag of the
|
* to ensure that #buf is large enough to contain a tag of the
|
||||||
* requested size.
|
* requested size.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -544,15 +544,15 @@ static void isapnp_isolate ( void ) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Increment a @c bus_loc structure to the next possible ISAPnP
|
* Increment a #bus_loc structure to the next possible ISAPnP
|
||||||
* location.
|
* location.
|
||||||
*
|
*
|
||||||
* @v bus_loc Bus location
|
* @v bus_loc Bus location
|
||||||
* @ret True @c bus_loc contains a valid ISAPnP location
|
* @ret True #bus_loc contains a valid ISAPnP location
|
||||||
* @ret False There are no more valid ISAPnP locations
|
* @ret False There are no more valid ISAPnP locations
|
||||||
* @err None
|
* @err None
|
||||||
*
|
*
|
||||||
* If there are no more valid locations, the @c bus_loc structure will
|
* If there are no more valid locations, the #bus_loc structure will
|
||||||
* be zeroed.
|
* be zeroed.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#ifndef BUFFER_H
|
#ifndef BUFFER_H
|
||||||
#define BUFFER_H
|
#define BUFFER_H
|
||||||
|
|
||||||
#include "compiler.h"
|
#include "compiler.h" /* for doxygen */
|
||||||
#include "stdint.h"
|
#include "stdint.h"
|
||||||
|
|
||||||
/** @file
|
/** @file
|
||||||
|
@ -62,10 +62,10 @@
|
||||||
/**
|
/**
|
||||||
* A buffer
|
* A buffer
|
||||||
*
|
*
|
||||||
* @c start and @c end denote the real boundaries of the buffer, and
|
* #start and #end denote the real boundaries of the buffer, and are
|
||||||
* are physical addresses. @c fill denotes the offset to the first
|
* physical addresses. #fill denotes the offset to the first free
|
||||||
* free block in the buffer. (If the buffer is full, @c fill will
|
* block in the buffer. (If the buffer is full, #fill will equal
|
||||||
* equal @c end-start.)
|
* #end-#start.)
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
struct buffer {
|
struct buffer {
|
||||||
|
|
|
@ -165,7 +165,7 @@ __asm__ ( ".equ\tDEBUG_LEVEL, " DEBUG_SYMBOL_STR );
|
||||||
/**
|
/**
|
||||||
* Declare a variable or data structure as unused.
|
* Declare a variable or data structure as unused.
|
||||||
*
|
*
|
||||||
* Note that using @c __unused on a static global variable (such as a
|
* Note that using #__unused on a static global variable (such as a
|
||||||
* table structure as mentioned in tables.h) is necessary in order to
|
* table structure as mentioned in tables.h) is necessary in order to
|
||||||
* inhibit compiler warnings.
|
* inhibit compiler warnings.
|
||||||
*
|
*
|
||||||
|
@ -176,8 +176,8 @@ __asm__ ( ".equ\tDEBUG_LEVEL, " DEBUG_SYMBOL_STR );
|
||||||
* Declare a function as used.
|
* Declare a function as used.
|
||||||
*
|
*
|
||||||
* Necessary only if the function is called only from assembler code.
|
* Necessary only if the function is called only from assembler code.
|
||||||
* You cannot use this attribute for static global variables; use @c
|
* You cannot use this attribute for static global variables; use
|
||||||
* __unused instead.
|
* #__unused instead.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
#define __used __attribute__ (( used ))
|
#define __used __attribute__ (( used ))
|
||||||
|
|
|
@ -164,6 +164,8 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
#include "compiler.h" /* for doxygen */
|
||||||
|
|
||||||
#define __table_str(x) #x
|
#define __table_str(x) #x
|
||||||
#define __table_section(table,idx) \
|
#define __table_section(table,idx) \
|
||||||
__section__ ( ".tbl." __table_str(table) "." __table_str(idx) )
|
__section__ ( ".tbl." __table_str(table) "." __table_str(idx) )
|
||||||
|
|
Loading…
Reference in New Issue