Minor documentation corrections.

pull/1469/head
Dean Camera 14 years ago
parent fc5fa769ef
commit 9708b45e69

@ -169,8 +169,8 @@
* be used when the read data is processed byte-per-bye (via \c getc()) or when the user application will implement its own * be used when the read data is processed byte-per-bye (via \c getc()) or when the user application will implement its own
* line buffering. * line buffering.
* *
* \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed, if \c NULL stdio * \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed, if \c NULL, \c stdout
* and stdin will be configured to use the USART. * and \c stdin will be configured to use the USART.
* *
* \pre The USART must first be configured via a call to \ref Serial_Init() before the stream is used. * \pre The USART must first be configured via a call to \ref Serial_Init() before the stream is used.
*/ */
@ -189,8 +189,8 @@
/** Identical to \ref Serial_CreateStream(), except that reads are blocking until the calling stream function terminates /** Identical to \ref Serial_CreateStream(), except that reads are blocking until the calling stream function terminates
* the transfer. * the transfer.
* *
* \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed, if \c NULL stdio * \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed, if \c NULL, \c stdout
* and stdin will be configured to use the USART. * and \c stdin will be configured to use the USART.
* *
* \pre The USART must first be configured via a call to \ref Serial_Init() before the stream is used. * \pre The USART must first be configured via a call to \ref Serial_Init() before the stream is used.
*/ */

@ -57,7 +57,7 @@
* - No reversed/shorted target connector detection and notification * - No reversed/shorted target connector detection and notification
* - A separate header is required for each of the ISP, PDI and TPI programming protocols that the user wishes to use * - A separate header is required for each of the ISP, PDI and TPI programming protocols that the user wishes to use
* *
* On AVR models with an ADC converter, AVCC should be tied to 5V (e.g. VBUS) and the VTARGET_ADC_CHANNEL token should be * On AVR models with an ADC converter, AVCC should be tied to 5V (e.g. VBUS) and the \c VTARGET_ADC_CHANNEL token should be
* set to an appropriate ADC channel number in the project makefile for VTARGET detection to operate correctly. On models * set to an appropriate ADC channel number in the project makefile for VTARGET detection to operate correctly. On models
* without an ADC converter, VTARGET will report a fixed 5V level at all times. * without an ADC converter, VTARGET will report a fixed 5V level at all times.
* *

Loading…
Cancel
Save