Minor documentation fixes.
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Device / CDC.h
index 9eb7b48..b2d148d 100644 (file)
                        void CDC_Device_SendControlLineStateChange(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 
                        /** Creates a standard character stream for the given CDC Device instance so that it can be used with all the regular
-                        *  functions in the avr-libc <stdio.h> library that accept a \c FILE stream as a destination (e.g. \c fprintf). The created
+                        *  functions in the standard <stdio.h> library that accept a \c FILE stream as a destination (e.g. \c fprintf). The created
                         *  stream is bidirectional and can be used for both input and output functions.
                         *
                         *  Reading data from this stream is non-blocking, i.e. in most instances, complete strings cannot be read in by a single
                         *
                         *  \note The created stream can be given as stdout if desired to direct the standard output from all <stdio.h> functions
                         *        to the given CDC interface.
+                        *        \n\n
+                        *
+                        *  \note This function is not available on all microcontroller architectures.
                         *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         *  \param[in,out] Stream            Pointer to a FILE structure where the created stream should be placed.
                        /** Identical to \ref CDC_Device_CreateStream(), except that reads are blocking until the calling stream function terminates
                         *  the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications.
                         *
+                        *  \note This function is not available on all microcontroller architectures.
+                        *
                         *  \param[in,out] CDCInterfaceInfo  Pointer to a structure containing a CDC Class configuration and state.
                         *  \param[in,out] Stream            Pointer to a FILE structure where the created stream should be placed.
                         */
        #if !defined(__DOXYGEN__)
                /* Function Prototypes: */
                        #if defined(__INCLUDE_FROM_CDC_DEVICE_C)
+                               #if defined(FDEV_SETUP_STREAM)
                                static int CDC_Device_putchar(char c,
                                                              FILE* Stream) ATTR_NON_NULL_PTR_ARG(2);
                                static int CDC_Device_getchar(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
                                static int CDC_Device_getchar_Blocking(FILE* Stream) ATTR_NON_NULL_PTR_ARG(1);
+                               #endif
 
                                void CDC_Device_Event_Stub(void) ATTR_CONST;
                                void EVENT_CDC_Device_LineEncodingChanged(USB_ClassInfo_CDC_Device_t* const CDCInterfaceInfo)