Documentation improvements - put driver example code into its own section, fix incorr...

[pub/USBasp.git] / LUFA / Drivers / USB / HighLevel / StreamCallbacks.h

diff --git a/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h b/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h
index 9b627e6..573a950 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h
+++ b/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.

-              
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
 */
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 

-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this

-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the

   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -37,7 +37,7 @@
  *  \note This file should not be included directly. It is automatically included as needed by the USB driver
  *        dispatch header located in LUFA/Drivers/USB/USB.h.
  */
  *  \note This file should not be included directly. It is automatically included as needed by the USB driver
  *        dispatch header located in LUFA/Drivers/USB/USB.h.
  */

- 
+

 /** \ingroup Group_USB
  *  @defgroup Group_StreamCallbacks Endpoint and Pipe Stream Callbacks
  *
 /** \ingroup Group_USB
  *  @defgroup Group_StreamCallbacks Endpoint and Pipe Stream Callbacks
  *


@@ -47,24 +47,27 @@
  *
  *  @{
  */
  *
  *  @{
  */

- 
+

 #ifndef __STREAMCALLBACK_H__
 #define __STREAMCALLBACK_H__
 
 #ifndef __STREAMCALLBACK_H__
 #define __STREAMCALLBACK_H__
 

+       /* Includes: */
+               #include <stdint.h>
+

        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_USB_DRIVER)
                        #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
                #endif
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_USB_DRIVER)
                        #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
                #endif

-               
+

        /* Public Interface - May be used in end-application: */
                /* Macros: */
                        /** Used with the Endpoint and Pipe stream functions as the callback function parameter, indicating that the stream
                         *  call has no callback function to be called between USB packets.
                         */
                        #define NO_STREAM_CALLBACK    NULL
        /* Public Interface - May be used in end-application: */
                /* Macros: */
                        /** Used with the Endpoint and Pipe stream functions as the callback function parameter, indicating that the stream
                         *  call has no callback function to be called between USB packets.
                         */
                        #define NO_STREAM_CALLBACK    NULL

-                       
+

                /* Enums: */
                /* Enums: */

-                       /** Enum for the possible error return codes of a stream callback function */
+                       /** Enum for the possible error return codes of a stream callback function. */

                        enum StreamCallback_Return_ErrorCodes_t
                        {
                                STREAMCALLBACK_Continue            = 0, /**< Continue sending or receiving the stream. */
                        enum StreamCallback_Return_ErrorCodes_t
                        {
                                STREAMCALLBACK_Continue            = 0, /**< Continue sending or receiving the stream. */


@@ -77,7 +80,8 @@
                         *  are to be used as the callback parameter of the stream functions.
                         */
                        typedef uint8_t (* const StreamCallbackPtr_t)(void);
                         *  are to be used as the callback parameter of the stream functions.
                         */
                        typedef uint8_t (* const StreamCallbackPtr_t)(void);

-               
+

 #endif
 
 /** @} */
 #endif
 
 /** @} */

+