diff options
| author | Michael Brown | 2005-05-20 12:27:02 +0200 |
|---|---|---|
| committer | Michael Brown | 2005-05-20 12:27:02 +0200 |
| commit | a96759f9c806c90070d99cddc496141b701b433e (patch) | |
| tree | 14935da2145916b81a08790c575b5bab9ce7a446 /src/include | |
| parent | Doxygenation (diff) | |
| download | ipxe-a96759f9c806c90070d99cddc496141b701b433e.tar.gz ipxe-a96759f9c806c90070d99cddc496141b701b433e.tar.xz ipxe-a96759f9c806c90070d99cddc496141b701b433e.zip | |
Use "#var" rather than "@c var" for doxygen.
Diffstat (limited to 'src/include')
| -rw-r--r-- | src/include/buffer.h | 10 | ||||
| -rw-r--r-- | src/include/compiler.h | 6 | ||||
| -rw-r--r-- | src/include/tables.h | 2 |
3 files changed, 10 insertions, 8 deletions
diff --git a/src/include/buffer.h b/src/include/buffer.h index da8b961ca..ecd7b4813 100644 --- a/src/include/buffer.h +++ b/src/include/buffer.h @@ -1,7 +1,7 @@ #ifndef BUFFER_H #define BUFFER_H -#include "compiler.h" +#include "compiler.h" /* for doxygen */ #include "stdint.h" /** @file @@ -62,10 +62,10 @@ /** * A buffer * - * @c start and @c end denote the real boundaries of the buffer, and - * are physical addresses. @c fill denotes the offset to the first - * free block in the buffer. (If the buffer is full, @c fill will - * equal @c end-start.) + * #start and #end denote the real boundaries of the buffer, and are + * physical addresses. #fill denotes the offset to the first free + * block in the buffer. (If the buffer is full, #fill will equal + * #end-#start.) * */ struct buffer { diff --git a/src/include/compiler.h b/src/include/compiler.h index c7708949f..79781bc72 100644 --- a/src/include/compiler.h +++ b/src/include/compiler.h @@ -165,7 +165,7 @@ __asm__ ( ".equ\tDEBUG_LEVEL, " DEBUG_SYMBOL_STR ); /** * 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 * inhibit compiler warnings. * @@ -176,8 +176,8 @@ __asm__ ( ".equ\tDEBUG_LEVEL, " DEBUG_SYMBOL_STR ); * Declare a function as used. * * Necessary only if the function is called only from assembler code. - * You cannot use this attribute for static global variables; use @c - * __unused instead. + * You cannot use this attribute for static global variables; use + * #__unused instead. * */ #define __used __attribute__ (( used )) diff --git a/src/include/tables.h b/src/include/tables.h index 9d74df6bd..c3e05e55e 100644 --- a/src/include/tables.h +++ b/src/include/tables.h @@ -164,6 +164,8 @@ * */ +#include "compiler.h" /* for doxygen */ + #define __table_str(x) #x #define __table_section(table,idx) \ __section__ ( ".tbl." __table_str(table) "." __table_str(idx) ) |