diff options
| author | Michael Brown | 2005-05-19 16:51:37 +0200 |
|---|---|---|
| committer | Michael Brown | 2005-05-19 16:51:37 +0200 |
| commit | d0c91839036ef33a96e50e8bb6490cc9e80aa3f9 (patch) | |
| tree | 066252a5d5a34ebe5dacf213f6e4dc29f6d3c43e /src/arch | |
| parent | errno.h now required in order to compile. (diff) | |
| download | ipxe-d0c91839036ef33a96e50e8bb6490cc9e80aa3f9.tar.gz ipxe-d0c91839036ef33a96e50e8bb6490cc9e80aa3f9.tar.xz ipxe-d0c91839036ef33a96e50e8bb6490cc9e80aa3f9.zip | |
Doxygenation
Diffstat (limited to 'src/arch')
| -rw-r--r-- | src/arch/i386/include/bochs.h | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/src/arch/i386/include/bochs.h b/src/arch/i386/include/bochs.h index 73f43c364..9d090fc12 100644 --- a/src/arch/i386/include/bochs.h +++ b/src/arch/i386/include/bochs.h @@ -1,9 +1,16 @@ #ifndef BOCHS_H #define BOCHS_H -/* - * This file defines "bochsbp", the magic breakpoint instruction that - * is incredibly useful when debugging under bochs. +/** @file + * + * bochs breakpoints + * + * This file defines @c bochsbp, the magic breakpoint instruction that + * is incredibly useful when debugging under bochs. This file should + * never be included in production code. + * + * Use the pseudo-instruction @c bochsbp in assembly code, or the + * bochsbp() function in C code. * */ @@ -15,7 +22,7 @@ #else /* ASSEMBLY */ -/* Breakpoint for when debugging under bochs */ +/** Breakpoint for when debugging under bochs */ static inline void bochsbp ( void ) { __asm__ __volatile__ ( "xchgw %bx, %bx" ); } |