X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/60e96412220b62a614348c287354c56f282fcc70..fa1a092901319b3b41bf09e0c4cb9cbbec470d6b:/LUFA/Drivers/USB/Class/Host/Printer.h diff --git a/LUFA/Drivers/USB/Class/Host/Printer.h b/LUFA/Drivers/USB/Class/Host/Printer.h index 06a1f8433..04286ca32 100644 --- a/LUFA/Drivers/USB/Class/Host/Printer.h +++ b/LUFA/Drivers/USB/Class/Host/Printer.h @@ -28,6 +28,15 @@ this software. */ +/** \file + * \brief Host mode driver for the library USB Printer Class driver. + * + * Host mode driver for the library USB Printer Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/Printer.h. + */ + /** \ingroup Group_USBClassPrinter * @defgroup Group_USBClassPrinterHost Printer Class Host Mode Driver * @@ -53,11 +62,16 @@ extern "C" { #endif + /* Preprocessor Checks: */ + #if !defined(__INCLUDE_FROM_PRINTER_DRIVER) + #error Do not include this file directly. Include LUFA/Drivers/Class/Printer.h instead. + #endif + /* Public Interface - May be used in end-application: */ - /* Macros: */ - /* Type Defines: */ - /** Class state structure. An instance of this structure should be made within the user application, + /** \brief Printer Class Host Mode Configuration and State Structure. + * + * Class state structure. An instance of this structure should be made within the user application, * and passed to each of the Printer class driver functions as the PRNTInterfaceInfo parameter. This * stores each Printer interface's configuration and state information. */ @@ -203,7 +217,7 @@ #define PRNT_FOUND_DATAPIPE_OUT (1 << 1) /* Function Prototypes: */ - #if defined(INCLUDE_FROM_PRINTER_CLASS_HOST_C) + #if defined(__INCLUDE_FROM_PRINTER_CLASS_HOST_C) static uint8_t DComp_NextPRNTInterface(void* const CurrentDescriptor); static uint8_t DComp_NextPRNTInterfaceEndpoint(void* const CurrentDescriptor); #endif