Browse Source

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

tags/v0.9.3
Michael Brown 19 years ago
parent
commit
a96759f9c8
5 changed files with 19 additions and 17 deletions
  1. 2
    2
      src/core/vsprintf.c
  2. 7
    7
      src/drivers/bus/isapnp.c
  3. 5
    5
      src/include/buffer.h
  4. 3
    3
      src/include/compiler.h
  5. 2
    0
      src/include/tables.h

+ 2
- 2
src/core/vsprintf.c View File

@@ -22,7 +22,7 @@
22 22
  * @ret	0		(if buf == NULL)
23 23
  * @err None
24 24
  *
25
- * If @c buf==NULL, then the string will be written to the console
25
+ * If #buf==NULL, then the string will be written to the console
26 26
  * directly using putchar().
27 27
  *
28 28
  */
@@ -159,7 +159,7 @@ static int vsprintf(char *buf, const char *fmt, va_list args)
159 159
  * @ret	0		(if buf == NULL)
160 160
  * @err None
161 161
  *
162
- * If @c buf==NULL, then the string will be written to the console
162
+ * If #buf==NULL, then the string will be written to the console
163 163
  * directly using putchar().
164 164
  *
165 165
  */

+ 7
- 7
src/drivers/bus/isapnp.c View File

@@ -52,8 +52,8 @@
52 52
  * an ISAPnP device.
53 53
  *
54 54
  * External code (e.g. the ISAPnP ROM prefix) may already know the
55
- * read port address, in which case it can store it in @c
56
- * isapnp_read_port.  Note that setting the read port address in this
55
+ * read port address, in which case it can store it in
56
+ * #isapnp_read_port.  Note that setting the read port address in this
57 57
  * way will prevent further isolation from taking place; you should
58 58
  * set the read port address only if you know that devices have
59 59
  * already been allocated CSNs.
@@ -332,7 +332,7 @@ static inline uint8_t isapnp_peek_byte ( void ) {
332 332
  * @ret None
333 333
  * @err None
334 334
  *
335
- * Resource data is read from the current location.  If @c buf is NULL,
335
+ * Resource data is read from the current location.  If #buf is NULL,
336 336
  * the data is discarded.
337 337
  *
338 338
  */
@@ -359,7 +359,7 @@ static void isapnp_peek ( uint8_t *buf, size_t bytes ) {
359 359
  *
360 360
  * Scan through the resource data until we find a particular tag, and
361 361
  * read its contents into a buffer.  It is the caller's responsibility
362
- * to ensure that @c buf is large enough to contain a tag of the
362
+ * to ensure that #buf is large enough to contain a tag of the
363 363
  * requested size.
364 364
  *
365 365
  */
@@ -544,15 +544,15 @@ static void isapnp_isolate ( void ) {
544 544
 }
545 545
 
546 546
 /**
547
- * Increment a @c bus_loc structure to the next possible ISAPnP
547
+ * Increment a #bus_loc structure to the next possible ISAPnP
548 548
  * location.
549 549
  *
550 550
  * @v bus_loc		Bus location
551
- * @ret True		@c bus_loc contains a valid ISAPnP location
551
+ * @ret True		#bus_loc contains a valid ISAPnP location
552 552
  * @ret False		There are no more valid ISAPnP locations
553 553
  * @err None
554 554
  *
555
- * If there are no more valid locations, the @c bus_loc structure will
555
+ * If there are no more valid locations, the #bus_loc structure will
556 556
  * be zeroed.
557 557
  *
558 558
  */

+ 5
- 5
src/include/buffer.h View File

@@ -1,7 +1,7 @@
1 1
 #ifndef BUFFER_H
2 2
 #define BUFFER_H
3 3
 
4
-#include "compiler.h"
4
+#include "compiler.h" /* for doxygen */
5 5
 #include "stdint.h"
6 6
 
7 7
 /** @file
@@ -62,10 +62,10 @@
62 62
 /**
63 63
  * A buffer
64 64
  *
65
- * @c start and @c end denote the real boundaries of the buffer, and
66
- * are physical addresses.  @c fill denotes the offset to the first
67
- * free block in the buffer.  (If the buffer is full, @c fill will
68
- * equal @c end-start.)
65
+ * #start and #end denote the real boundaries of the buffer, and are
66
+ * physical addresses.  #fill denotes the offset to the first free
67
+ * block in the buffer.  (If the buffer is full, #fill will equal
68
+ * #end-#start.)
69 69
  *
70 70
  */
71 71
 struct buffer {

+ 3
- 3
src/include/compiler.h View File

@@ -165,7 +165,7 @@ __asm__ ( ".equ\tDEBUG_LEVEL, " DEBUG_SYMBOL_STR );
165 165
 /** 
166 166
  * Declare a variable or data structure as unused.
167 167
  *
168
- * Note that using @c __unused on a static global variable (such as a
168
+ * Note that using #__unused on a static global variable (such as a
169 169
  * table structure as mentioned in tables.h) is necessary in order to
170 170
  * inhibit compiler warnings.
171 171
  *
@@ -176,8 +176,8 @@ __asm__ ( ".equ\tDEBUG_LEVEL, " DEBUG_SYMBOL_STR );
176 176
  * Declare a function as used.
177 177
  *
178 178
  * Necessary only if the function is called only from assembler code.
179
- * You cannot use this attribute for static global variables; use @c
180
- * __unused instead.
179
+ * You cannot use this attribute for static global variables; use
180
+ * #__unused instead.
181 181
  *
182 182
  */
183 183
 #define __used __attribute__ (( used ))

+ 2
- 0
src/include/tables.h View File

@@ -164,6 +164,8 @@
164 164
  *
165 165
  */
166 166
 
167
+#include "compiler.h" /* for doxygen */
168
+
167 169
 #define __table_str(x) #x
168 170
 #define __table_section(table,idx) \
169 171
 	__section__ ( ".tbl." __table_str(table) "." __table_str(idx) )

Loading…
Cancel
Save