Documentation: Update copyrights to 2020.
[pub/lufa.git] / LUFA / Drivers / Peripheral / TWI.h
index e7eb850..4143474 100644 (file)
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2020.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2020  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
@@ -29,7 +29,7 @@
 */
 
 /** \file
- *  \brief Master include file for the TWI peripheral driver.
+ *  \brief Hardware Two Wire Interface (I2C) driver.
  *
  *  This file is the master dispatch header file for the device-specific SPI driver, for microcontrollers
  *  containing a hardware TWI.
 
 /** \ingroup Group_PeripheralDrivers
  *  \defgroup Group_TWI TWI Driver - LUFA/Drivers/Peripheral/TWI.h
+ *  \brief Hardware Two Wire Interface (I2C) driver.
  *
- *  \section Sec_Dependencies Module Source Dependencies
+ *  \section Sec_TWI_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
- *    - LUFA/Drivers/Peripheral/$(ARCH)TWI.c <i>(Makefile source module name: LUFA_SRC_TWI)</i>
+ *    - LUFA/Drivers/Peripheral/<i>ARCH</i>/TWI_<i>ARCH</i>.c <i>(Makefile source module name: LUFA_SRC_TWI)</i>
  *
- *  \section Sec_ModDescription Module Description
+ *  \section Sec_TWI_ModDescription Module Description
  *  Hardware TWI driver. This module provides an easy to use driver for the setup and transfer of data over
  *  the selected architecture and microcontroller model's TWI bus port.
  *
 #define __TWI_H__
 
        /* Macros: */
-               #if !defined(__DOXYGEN__)
-                       #define __INCLUDE_FROM_TWI_H
-               #endif
+               #define __INCLUDE_FROM_TWI_H
 
        /* Includes: */
                #include "../../Common/Common.h"
 
        /* Includes: */
                #if (ARCH == ARCH_AVR8)
-                       #include "AVR8/TWI.h"
+                       #include "AVR8/TWI_AVR8.h"
+               #elif (ARCH == ARCH_XMEGA)
+                       #include "XMEGA/TWI_XMEGA.h"
                #else
                        #error The TWI peripheral driver is not currently available for your selected architecture.
                #endif