summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/core/vsprintf.c4
-rw-r--r--src/drivers/bus/isapnp.c14
-rw-r--r--src/include/buffer.h10
-rw-r--r--src/include/compiler.h6
-rw-r--r--src/include/tables.h2
5 files changed, 19 insertions, 17 deletions
diff --git a/src/core/vsprintf.c b/src/core/vsprintf.c
index c8ba2c212..520b1feb1 100644
--- a/src/core/vsprintf.c
+++ b/src/core/vsprintf.c
@@ -22,7 +22,7 @@
* @ret 0 (if buf == NULL)
* @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().
*
*/
@@ -159,7 +159,7 @@ static int vsprintf(char *buf, const char *fmt, va_list args)
* @ret 0 (if buf == NULL)
* @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().
*
*/
diff --git a/src/drivers/bus/isapnp.c b/src/drivers/bus/isapnp.c
index 4888c6115..6f87a3259 100644
--- a/src/drivers/bus/isapnp.c
+++ b/src/drivers/bus/isapnp.c
@@ -52,8 +52,8 @@
* an ISAPnP device.
*
* External code (e.g. the ISAPnP ROM prefix) may already know the
- * read port address, in which case it can store it in @c
- * isapnp_read_port. Note that setting the read port address in this
+ * read port address, in which case it can store it in
+ * #isapnp_read_port. Note that setting the read port address in this
* way will prevent further isolation from taking place; you should
* set the read port address only if you know that devices have
* already been allocated CSNs.
@@ -332,7 +332,7 @@ static inline uint8_t isapnp_peek_byte ( void ) {
* @ret 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.
*
*/
@@ -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
* 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.
*
*/
@@ -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.
*
* @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
* @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.
*
*/
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) )