Use "#var" rather than "@c var" for doxygen.

This commit is contained in:
Michael Brown
2005-05-20 10:27:02 +00:00
parent bf32da87f0
commit a96759f9c8
5 changed files with 19 additions and 17 deletions

View File

@@ -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 {

View File

@@ -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 ))

View File

@@ -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) )