Browse Source

Some versions of doxygen seem to object to "@ret None" or similar.

tags/v0.9.3
Michael Brown 19 years ago
parent
commit
0e494614b5

+ 2
- 2
src/arch/i386/prefix/int19exit.c View File

15
  * Exit via INT19
15
  * Exit via INT19
16
  *
16
  *
17
  * @v ix86		i386 register values to be loaded on exit
17
  * @v ix86		i386 register values to be loaded on exit
18
- * @ret Never
19
- * @err None
18
+ * @ret Never		-
19
+ * @err None		-
20
  *
20
  *
21
  * Exit back to the BIOS by switching to real mode, reloading the
21
  * Exit back to the BIOS by switching to real mode, reloading the
22
  * registers as they were before Etherboot started, and executing INT
22
  * registers as they were before Etherboot started, and executing INT

+ 6
- 6
src/core/buffer.c View File

48
  * Initialise a buffer.
48
  * Initialise a buffer.
49
  *
49
  *
50
  * @v buffer		The buffer to be initialised
50
  * @v buffer		The buffer to be initialised
51
- * @ret None
52
- * @err None
51
+ * @ret None		-
52
+ * @err None		-
53
  *
53
  *
54
  * Set @c buffer->start and @c buffer->end before calling init_buffer().
54
  * Set @c buffer->start and @c buffer->end before calling init_buffer().
55
  * init_buffer() will initialise the buffer to the state of being
55
  * init_buffer() will initialise the buffer to the state of being
72
  * @v desc		A descriptor for the free block
72
  * @v desc		A descriptor for the free block
73
  * @v block		Start address of the block
73
  * @v block		Start address of the block
74
  * @v split		Address at which to split the block
74
  * @v split		Address at which to split the block
75
- * @ret None
76
- * @err None
75
+ * @ret None		-
76
+ * @err None		-
77
  *
77
  *
78
  * Split a free block into two separate free blocks.  If the split
78
  * Split a free block into two separate free blocks.  If the split
79
  * point lies outside the block, no action is taken; this is not an
79
  * point lies outside the block, no action is taken; this is not an
120
  * @v buffer		The buffer containing the block
120
  * @v buffer		The buffer containing the block
121
  * @v desc		A descriptor for the free block
121
  * @v desc		A descriptor for the free block
122
  * @v prev_block	Address of the previous block
122
  * @v prev_block	Address of the previous block
123
- * @ret None
124
- * @err None
123
+ * @ret None		-
124
+ * @err None		-
125
  *
125
  *
126
  * Marks a free block as used, i.e. removes it from the free list.
126
  * Marks a free block as used, i.e. removes it from the free list.
127
  *
127
  *

+ 8
- 8
src/core/console.c View File

12
  * Write a single character to each console device.
12
  * Write a single character to each console device.
13
  *
13
  *
14
  * @v character		Character to be written
14
  * @v character		Character to be written
15
- * @ret None
16
- * @err None
15
+ * @ret None		-
16
+ * @err None		-
17
  *
17
  *
18
  * The character is written out to all enabled console devices, using
18
  * The character is written out to all enabled console devices, using
19
  * each device's console_driver::putchar() method.
19
  * each device's console_driver::putchar() method.
36
 /**
36
 /**
37
  * Check to see if any input is available on any console.
37
  * Check to see if any input is available on any console.
38
  *
38
  *
39
- * @v None
39
+ * @v None		-
40
  * @ret console		Console device that has input available, if any.
40
  * @ret console		Console device that has input available, if any.
41
  * @ret NULL		No console device has input available.
41
  * @ret NULL		No console device has input available.
42
- * @err None
42
+ * @err None		-
43
  *
43
  *
44
  * All enabled console devices are checked once for available input
44
  * All enabled console devices are checked once for available input
45
  * using each device's console_driver::iskey() method.  The first
45
  * using each device's console_driver::iskey() method.  The first
62
 /**
62
 /**
63
  * Read a single character from any console.
63
  * Read a single character from any console.
64
  *
64
  *
65
- * @v None
65
+ * @v None		-
66
  * @ret character	Character read from a console.
66
  * @ret character	Character read from a console.
67
- * @err None
67
+ * @err None		-
68
  *
68
  *
69
  * A character will be read from the first enabled console device that
69
  * A character will be read from the first enabled console device that
70
  * has input available using that console's console_driver::getchar()
70
  * has input available using that console's console_driver::getchar()
112
 
112
 
113
 /** Check for available input on any console.
113
 /** Check for available input on any console.
114
  *
114
  *
115
- * @v None
115
+ * @v None		-
116
  * @ret True		Input is available on a console
116
  * @ret True		Input is available on a console
117
  * @ret False		Input is not available on any console
117
  * @ret False		Input is not available on any console
118
- * @err None
118
+ * @err None		-
119
  *
119
  *
120
  * All enabled console devices are checked once for available input
120
  * All enabled console devices are checked once for available input
121
  * using each device's console_driver::iskey() method.  If any console
121
  * using each device's console_driver::iskey() method.  If any console

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

20
  * @v args		Arguments corresponding to the format string
20
  * @v args		Arguments corresponding to the format string
21
  * @ret len		Length of string written to buffer (if buf != NULL)
21
  * @ret len		Length of string written to buffer (if buf != NULL)
22
  * @ret	0		(if buf == NULL)
22
  * @ret	0		(if buf == NULL)
23
- * @err None
23
+ * @err None		-
24
  *
24
  *
25
  * If #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
  * directly using putchar().
26
  * directly using putchar().
157
  * @v ...		Arguments corresponding to the format string
157
  * @v ...		Arguments corresponding to the format string
158
  * @ret len		Length of string written to buffer (if buf != NULL)
158
  * @ret len		Length of string written to buffer (if buf != NULL)
159
  * @ret	0		(if buf == NULL)
159
  * @ret	0		(if buf == NULL)
160
- * @err None
160
+ * @err None		-
161
  *
161
  *
162
  * If #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
  * directly using putchar().
163
  * directly using putchar().
178
  *
178
  *
179
  * @v fmt		Format string
179
  * @v fmt		Format string
180
  * @v ...		Arguments corresponding to the format string
180
  * @v ...		Arguments corresponding to the format string
181
- * @ret	None
182
- * @err None
181
+ * @ret	None		-
182
+ * @err None		-
183
  *
183
  *
184
  */
184
  */
185
 void printf(const char *fmt, ...)
185
 void printf(const char *fmt, ...)

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

172
  * Place a specified card into the Config state.
172
  * Place a specified card into the Config state.
173
  *
173
  *
174
  * @v csn		Card Select Number
174
  * @v csn		Card Select Number
175
- * @ret None
176
- * @err None
175
+ * @ret None		-
176
+ * @err None		-
177
  *
177
  *
178
  * Only cards currently in the Sleep, Isolation, or Config states will
178
  * Only cards currently in the Sleep, Isolation, or Config states will
179
  * respond to this command.  The card that has the specified CSN will
179
  * respond to this command.  The card that has the specified CSN will
196
  * Assign a Card Select Number to a card, and enter the Config state.
196
  * Assign a Card Select Number to a card, and enter the Config state.
197
  *
197
  *
198
  * @v csn		Card Select Number
198
  * @v csn		Card Select Number
199
- * @ret None
200
- * @err None
199
+ * @ret None		-
200
+ * @err None		-
201
  *
201
  *
202
  * Only cards in the Isolation state will respond to this command.
202
  * Only cards in the Isolation state will respond to this command.
203
  * The isolation protocol is designed so that only one card will
203
  * The isolation protocol is designed so that only one card will
241
  * @v lfsr		Current value of the LFSR
241
  * @v lfsr		Current value of the LFSR
242
  * @v input_bit		Current input bit to the LFSR
242
  * @v input_bit		Current input bit to the LFSR
243
  * @ret lfsr		Next value of the LFSR
243
  * @ret lfsr		Next value of the LFSR
244
- * @err None
244
+ * @err None		-
245
  *
245
  *
246
  * This routine implements the linear feedback shift register as
246
  * This routine implements the linear feedback shift register as
247
  * described in Appendix B of the PnP ISA spec.  The hardware
247
  * described in Appendix B of the PnP ISA spec.  The hardware
286
  *
286
  *
287
  * @v identifier		ISAPnP identifier
287
  * @v identifier		ISAPnP identifier
288
  * @ret checksum		Expected checksum value
288
  * @ret checksum		Expected checksum value
289
- * @err None
289
+ * @err None			-
290
  *
290
  *
291
  */
291
  */
292
 static uint8_t isapnp_checksum ( struct isapnp_identifier *identifier ) {
292
 static uint8_t isapnp_checksum ( struct isapnp_identifier *identifier ) {
329
  *
329
  *
330
  * @v buf		Buffer in which to store data, or NULL
330
  * @v buf		Buffer in which to store data, or NULL
331
  * @v bytes		Number of bytes to read
331
  * @v bytes		Number of bytes to read
332
- * @ret None
333
- * @err None
332
+ * @ret None		-
333
+ * @err None		-
334
  *
334
  *
335
  * Resource data is read from the current location.  If #buf is NULL,
335
  * Resource data is read from the current location.  If #buf is NULL,
336
  * the data is discarded.
336
  * the data is discarded.
355
  * @v buf		Buffer in which to store the tag's contents
355
  * @v buf		Buffer in which to store the tag's contents
356
  * @ret True		Tag was found
356
  * @ret True		Tag was found
357
  * @ret False		Tag was not found
357
  * @ret False		Tag was not found
358
- * @err None
358
+ * @err None		-
359
  *
359
  *
360
  * Scan through the resource data until we find a particular tag, and
360
  * Scan through the resource data until we find a particular tag, and
361
  * read its contents into a buffer.  It is the caller's responsibility
361
  * read its contents into a buffer.  It is the caller's responsibility
396
  * @ret \>0		Number of ISAPnP cards found
396
  * @ret \>0		Number of ISAPnP cards found
397
  * @ret 0		There are no ISAPnP cards in the system
397
  * @ret 0		There are no ISAPnP cards in the system
398
  * @ret \<0		A conflict was detected; try a new read port
398
  * @ret \<0		A conflict was detected; try a new read port
399
- * @err None
399
+ * @err None		-
400
  *
400
  *
401
  * The state diagram on page 18 (PDF page 24) of the PnP ISA spec
401
  * The state diagram on page 18 (PDF page 24) of the PnP ISA spec
402
  * gives the best overview of what happens here.
402
  * gives the best overview of what happens here.
550
  * @v bus_loc		Bus location
550
  * @v bus_loc		Bus location
551
  * @ret True		#bus_loc contains a valid ISAPnP location
551
  * @ret True		#bus_loc contains a valid ISAPnP location
552
  * @ret False		There are no more valid ISAPnP locations
552
  * @ret False		There are no more valid ISAPnP locations
553
- * @err None
553
+ * @err None		-
554
  *
554
  *
555
  * If there are no more valid locations, the #bus_loc structure will
555
  * If there are no more valid locations, the #bus_loc structure will
556
  * be zeroed.
556
  * be zeroed.
578
  * @v bus_loc		Bus location as filled in by isapnp_next_location()
578
  * @v bus_loc		Bus location as filled in by isapnp_next_location()
579
  * @ret True		A device is present at this location
579
  * @ret True		A device is present at this location
580
  * @ret False		No device is present at this location
580
  * @ret False		No device is present at this location
581
- * @err None
581
+ * @err None		-
582
  *
582
  *
583
  */
583
  */
584
 static int isapnp_fill_device ( struct bus_dev *bus_dev,
584
 static int isapnp_fill_device ( struct bus_dev *bus_dev,
677
  * @v device_driver	Device driver
677
  * @v device_driver	Device driver
678
  * @ret True		Driver is capable of driving this device
678
  * @ret True		Driver is capable of driving this device
679
  * @ret False		Driver is not capable of driving this device
679
  * @ret False		Driver is not capable of driving this device
680
- * @err None
680
+ * @err None		-
681
  *
681
  *
682
  */
682
  */
683
 static int isapnp_check_driver ( struct bus_dev *bus_dev,
683
 static int isapnp_check_driver ( struct bus_dev *bus_dev,
713
  *
713
  *
714
  * @v bus_dev		Bus device as filled in by isapnp_fill_device()
714
  * @v bus_dev		Bus device as filled in by isapnp_fill_device()
715
  * @ret string		Printable string describing the device
715
  * @ret string		Printable string describing the device
716
- * @err None
716
+ * @err None		-
717
  *
717
  *
718
  * The string returned by isapnp_describe_device() is valid only until
718
  * The string returned by isapnp_describe_device() is valid only until
719
  * the next call to isapnp_describe_device().
719
  * the next call to isapnp_describe_device().
733
  *
733
  *
734
  * @v bus_dev		Bus device as filled in by isapnp_fill_device()
734
  * @v bus_dev		Bus device as filled in by isapnp_fill_device()
735
  * @ret string		Printable string naming the device
735
  * @ret string		Printable string naming the device
736
- * @err None
736
+ * @err None		-
737
  *
737
  *
738
  * The string returned by isapnp_name_device() is valid only until the
738
  * The string returned by isapnp_name_device() is valid only until the
739
  * next call to isapnp_name_device().
739
  * next call to isapnp_name_device().
763
  *
763
  *
764
  * @v isapnp		ISAPnP device
764
  * @v isapnp		ISAPnP device
765
  * @v activation	True to enable, False to disable the device
765
  * @v activation	True to enable, False to disable the device
766
- * @ret None
767
- * @err None
766
+ * @ret None		-
767
+ * @err None		-
768
  *
768
  *
769
  * This routine simply activates the device in its current
769
  * This routine simply activates the device in its current
770
  * configuration, or deactivates the device.  It does not attempt any
770
  * configuration, or deactivates the device.  It does not attempt any
796
  *
796
  *
797
  * @v nic		NIC structure to be filled in
797
  * @v nic		NIC structure to be filled in
798
  * @v isapnp		ISAPnP device
798
  * @v isapnp		ISAPnP device
799
- * @ret None
800
- * @err None
799
+ * @ret None		-
800
+ * @err None		-
801
  *
801
  *
802
  * This fills in generic NIC parameters (e.g. I/O address and IRQ
802
  * This fills in generic NIC parameters (e.g. I/O address and IRQ
803
  * number) that can be determined directly from the ISAPnP device,
803
  * number) that can be determined directly from the ISAPnP device,

+ 6
- 6
src/include/console.h View File

43
 	/** Write a character to the console.
43
 	/** Write a character to the console.
44
 	 *
44
 	 *
45
 	 * @v character		Character to be written
45
 	 * @v character		Character to be written
46
-	 * @ret None
47
-	 * @err None
46
+	 * @ret None		-
47
+	 * @err None		-
48
 	 *
48
 	 *
49
 	 */
49
 	 */
50
 	void ( *putchar ) ( int character );
50
 	void ( *putchar ) ( int character );
51
 
51
 
52
 	/** Read a character from the console.
52
 	/** Read a character from the console.
53
 	 *
53
 	 *
54
-	 * @v None
54
+	 * @v None		-
55
 	 * @ret character	Character read
55
 	 * @ret character	Character read
56
-	 * @err None
56
+	 * @err None		-
57
 	 *
57
 	 *
58
 	 * If no character is available to be read, this method will
58
 	 * If no character is available to be read, this method will
59
 	 * block.  The character read should not be echoed back to the
59
 	 * block.  The character read should not be echoed back to the
64
 
64
 
65
 	/** Check for available input.
65
 	/** Check for available input.
66
 	 *
66
 	 *
67
-	 * @v None
67
+	 * @v None		-
68
 	 * @ret True		Input is available
68
 	 * @ret True		Input is available
69
 	 * @ret False		Input is not available
69
 	 * @ret False		Input is not available
70
-	 * @err None
70
+	 * @err None		-
71
 	 *
71
 	 *
72
 	 * This should return True if a subsequent call to getchar()
72
 	 * This should return True if a subsequent call to getchar()
73
 	 * will not block.
73
 	 * will not block.

+ 1
- 1
src/interface/pxe/pxe_preboot.c View File

29
 /**
29
 /**
30
  * UNLOAD BASE CODE STACK
30
  * UNLOAD BASE CODE STACK
31
  *
31
  *
32
- * @v None
32
+ * @v None				-
33
  * @ret ...
33
  * @ret ...
34
  *
34
  *
35
  */
35
  */

+ 1
- 1
src/interface/pxe/pxe_udp.c View File

83
  * @v udp_close				Pointer to a struct s_PXENV_UDP_CLOSE
83
  * @v udp_close				Pointer to a struct s_PXENV_UDP_CLOSE
84
  * @ret #PXENV_EXIT_SUCCESS		Always
84
  * @ret #PXENV_EXIT_SUCCESS		Always
85
  * @ret s_PXENV_UDP_CLOSE::Status	PXE status code
85
  * @ret s_PXENV_UDP_CLOSE::Status	PXE status code
86
- * @err None
86
+ * @err None				-
87
  *
87
  *
88
  * Closes a UDP "connection" opened with pxenv_udp_open().  Since UDP
88
  * Closes a UDP "connection" opened with pxenv_udp_open().  Since UDP
89
  * is a connectionless protocol, this is a no-op.
89
  * is a connectionless protocol, this is a no-op.

Loading…
Cancel
Save