pfrison / manette-usb

Commit 20f46bd930b91af969cc0f60f1b586b1f6f422da

Authored by root
1 parent 32bf1efe

squelette de la partie atmega16u2

Showing 11 changed files with 3249 additions and 0 deletions   Show diff stats
Inline Side-by-side
atmega16u2/PolytechLille/PAD/Config/LUFAConfig.h 0 → 100644
  Show/Hide comments   View file @20f46bd
... ... @@ -0,0 +1,93 @@
  1 +/*
  2 + LUFA Library
  3 + Copyright (C) Dean Camera, 2017.
  4 +
  5 + dean [at] fourwalledcubicle [dot] com
  6 + www.lufa-lib.org
  7 +*/
  8 +
  9 +/*
  10 + Copyright 2017 Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11 +
  12 + Permission to use, copy, modify, distribute, and sell this
  13 + software and its documentation for any purpose is hereby granted
  14 + without fee, provided that the above copyright notice appear in
  15 + all copies and that both that the copyright notice and this
  16 + permission notice and warranty disclaimer appear in supporting
  17 + documentation, and that the name of the author not be used in
  18 + advertising or publicity pertaining to distribution of the
  19 + software without specific, written prior permission.
  20 +
  21 + The author disclaims all warranties with regard to this
  22 + software, including all implied warranties of merchantability
  23 + and fitness. In no event shall the author be liable for any
  24 + special, indirect or consequential damages or any damages
  25 + whatsoever resulting from loss of use, data or profits, whether
  26 + in an action of contract, negligence or other tortious action,
  27 + arising out of or in connection with the use or performance of
  28 + this software.
  29 +*/
  30 +
  31 +/** \file
  32 + * \brief LUFA Library Configuration Header File
  33 + *
  34 + * This header file is used to configure LUFA's compile time options,
  35 + * as an alternative to the compile time constants supplied through
  36 + * a makefile.
  37 + *
  38 + * For information on what each token does, refer to the LUFA
  39 + * manual section "Summary of Compile Tokens".
  40 + */
  41 +
  42 +#ifndef _LUFA_CONFIG_H_
  43 +#define _LUFA_CONFIG_H_
  44 +
  45 + #if (ARCH == ARCH_AVR8)
  46 +
  47 + /* Non-USB Related Configuration Tokens: */
  48 +// #define DISABLE_TERMINAL_CODES
  49 +
  50 + /* USB Class Driver Related Tokens: */
  51 +// #define HID_HOST_BOOT_PROTOCOL_ONLY
  52 +// #define HID_STATETABLE_STACK_DEPTH {Insert Value Here}
  53 +// #define HID_USAGE_STACK_DEPTH {Insert Value Here}
  54 +// #define HID_MAX_COLLECTIONS {Insert Value Here}
  55 +// #define HID_MAX_REPORTITEMS {Insert Value Here}
  56 +// #define HID_MAX_REPORT_IDS {Insert Value Here}
  57 +// #define NO_CLASS_DRIVER_AUTOFLUSH
  58 +
  59 + /* General USB Driver Related Tokens: */
  60 +// #define ORDERED_EP_CONFIG
  61 + #define USE_STATIC_OPTIONS (USB_DEVICE_OPT_FULLSPEED | USB_OPT_REG_ENABLED | USB_OPT_AUTO_PLL)
  62 + #define USB_DEVICE_ONLY
  63 +// #define USB_HOST_ONLY
  64 +// #define USB_STREAM_TIMEOUT_MS {Insert Value Here}
  65 +// #define NO_LIMITED_CONTROLLER_CONNECT
  66 +// #define NO_SOF_EVENTS
  67 +
  68 + /* USB Device Mode Driver Related Tokens: */
  69 +// #define USE_RAM_DESCRIPTORS
  70 + #define USE_FLASH_DESCRIPTORS
  71 +// #define USE_EEPROM_DESCRIPTORS
  72 +// #define NO_INTERNAL_SERIAL
  73 + #define FIXED_CONTROL_ENDPOINT_SIZE 8
  74 + #define DEVICE_STATE_AS_GPIOR 0
  75 + #define FIXED_NUM_CONFIGURATIONS 1
  76 +// #define CONTROL_ONLY_DEVICE
  77 +// #define INTERRUPT_CONTROL_ENDPOINT
  78 +// #define NO_DEVICE_REMOTE_WAKEUP
  79 +// #define NO_DEVICE_SELF_POWER
  80 +
  81 + /* USB Host Mode Driver Related Tokens: */
  82 +// #define HOST_STATE_AS_GPIOR 0
  83 +// #define USB_HOST_TIMEOUT_MS {Insert Value Here}
  84 +// #define HOST_DEVICE_SETTLE_DELAY_MS {Insert Value Here}
  85 +// #define NO_AUTO_VBUS_MANAGEMENT
  86 +// #define INVERTED_VBUS_ENABLE_LINE
  87 +
  88 + #else
  89 +
  90 + #error Unsupported architecture for this LUFA configuration file.
  91 +
  92 + #endif
  93 +#endif
... ...
atmega16u2/PolytechLille/PAD/Descriptors.c 0 → 100644
  Show/Hide comments   View file @20f46bd
... ... @@ -0,0 +1,188 @@
  1 +/*
  2 + LUFA Library
  3 + Copyright (C) Dean Camera, 2017.
  4 +
  5 + dean [at] fourwalledcubicle [dot] com
  6 + www.lufa-lib.org
  7 +*/
  8 +
  9 +/*
  10 + Copyright 2010 OBinou (obconseil [at] gmail [dot] com)
  11 + Copyright 2017 Dean Camera (dean [at] fourwalledcubicle [dot] com)
  12 +
  13 + Permission to use, copy, modify, distribute, and sell this
  14 + software and its documentation for any purpose is hereby granted
  15 + without fee, provided that the above copyright notice appear in
  16 + all copies and that both that the copyright notice and this
  17 + permission notice and warranty disclaimer appear in supporting
  18 + documentation, and that the name of the author not be used in
  19 + advertising or publicity pertaining to distribution of the
  20 + software without specific, written prior permission.
  21 +
  22 + The author disclaims all warranties with regard to this
  23 + software, including all implied warranties of merchantability
  24 + and fitness. In no event shall the author be liable for any
  25 + special, indirect or consequential damages or any damages
  26 + whatsoever resulting from loss of use, data or profits, whether
  27 + in an action of contract, negligence or other tortious action,
  28 + arising out of or in connection with the use or performance of
  29 + this software.
  30 +*/
  31 +
  32 +/** \file
  33 + *
  34 + * USB Device Descriptors, for library use when in USB device mode. Descriptors are special
  35 + * computer-readable structures which the host requests upon device enumeration, to determine
  36 + * the device's capabilities and functions.
  37 + */
  38 +
  39 +#include "Descriptors.h"
  40 +
  41 +/** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
  42 + * device characteristics, including the supported USB version, control endpoint size and the
  43 + * number of device configurations. The descriptor is read out by the USB host when the enumeration
  44 + * process begins.
  45 + */
  46 +const USB_Descriptor_Device_t PROGMEM RelayBoard_DeviceDescriptor =
  47 +{
  48 + .Header = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
  49 +
  50 + .USBSpecification = VERSION_BCD(1,1,0),
  51 + .Class = USB_CSCP_VendorSpecificClass,
  52 + .SubClass = USB_CSCP_NoDeviceSubclass,
  53 + .Protocol = USB_CSCP_NoDeviceProtocol,
  54 +
  55 + .Endpoint0Size = FIXED_CONTROL_ENDPOINT_SIZE,
  56 +
  57 + .VendorID = 0x04B4,
  58 + .ProductID = 0xFD11,
  59 + .ReleaseNumber = VERSION_BCD(2,0,0),
  60 +
  61 + .ManufacturerStrIndex = STRING_ID_Manufacturer,
  62 + .ProductStrIndex = STRING_ID_Product,
  63 + .SerialNumStrIndex = STRING_ID_Serial,
  64 +
  65 + .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
  66 +};
  67 +
  68 +/** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage
  69 + * of the device in one of its supported configurations, including information about any device interfaces
  70 + * and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting
  71 + * a configuration so that the host may correctly communicate with the USB device.
  72 + */
  73 +const USB_Descriptor_Configuration_t PROGMEM RelayBoard_ConfigurationDescriptor =
  74 +{
  75 + .Config =
  76 + {
  77 + .Header = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
  78 +
  79 + .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
  80 + .TotalInterfaces = 1,
  81 +
  82 + .ConfigurationNumber = 1,
  83 + .ConfigurationStrIndex = NO_DESCRIPTOR,
  84 +
  85 + .ConfigAttributes = USB_CONFIG_ATTR_RESERVED,
  86 +
  87 + .MaxPowerConsumption = USB_CONFIG_POWER_MA(500)
  88 + },
  89 +
  90 + .RelayBoardInterface =
  91 + {
  92 + .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
  93 +
  94 + .InterfaceNumber = INTERFACE_ID_RelayBoard,
  95 + .AlternateSetting = 0,
  96 +
  97 + .TotalEndpoints = 0,
  98 +
  99 + .Class = USB_CSCP_VendorSpecificClass,
  100 + .SubClass = 0x00,
  101 + .Protocol = 0x00,
  102 +
  103 + .InterfaceStrIndex = NO_DESCRIPTOR
  104 + },
  105 +};
  106 +
  107 +/** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests
  108 + * the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate
  109 + * via the language ID table available at USB.org what languages the device supports for its string descriptors.
  110 + */
  111 +const USB_Descriptor_String_t PROGMEM RelayBoard_LanguageString =
  112 +{
  113 + .Header = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
  114 +
  115 + .UnicodeString = {LANGUAGE_ID_ENG}
  116 +};
  117 +
  118 +/** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable
  119 + * form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
  120 + * Descriptor.
  121 + */
  122 +const USB_Descriptor_String_t PROGMEM RelayBoard_ManufacturerString = USB_STRING_DESCRIPTOR(L"SISPM");
  123 +
  124 +/** Product descriptor string. This is a Unicode string containing the product's details in human readable form,
  125 + * and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
  126 + * Descriptor.
  127 + */
  128 +const USB_Descriptor_String_t PROGMEM RelayBoard_ProductString = USB_STRING_DESCRIPTOR(L"RelayBoard");
  129 +
  130 +/** Serial number string. This is a Unicode string containing the device's unique serial number, expressed as a
  131 + * series of uppercase hexadecimal digits.
  132 + */
  133 +const USB_Descriptor_String_t PROGMEM RelayBoard_SerialString = USB_STRING_DESCRIPTOR(L"00001");
  134 +
  135 +/** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
  136 + * documentation) by the application code so that the address and size of a requested descriptor can be given
  137 + * to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
  138 + * is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
  139 + * USB host.
  140 + */
  141 +uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
  142 + const uint16_t wIndex,
  143 + const void** const DescriptorAddress)
  144 +{
  145 + const uint8_t DescriptorType = (wValue >> 8);
  146 + const uint8_t DescriptorNumber = (wValue & 0xFF);
  147 +
  148 + const void* Address = NULL;
  149 + uint16_t Size = NO_DESCRIPTOR;
  150 +
  151 + switch (DescriptorType)
  152 + {
  153 + case DTYPE_Device:
  154 + Address = &RelayBoard_DeviceDescriptor;
  155 + Size = sizeof(USB_Descriptor_Device_t);
  156 + break;
  157 + case DTYPE_Configuration:
  158 + Address = &RelayBoard_ConfigurationDescriptor;
  159 + Size = sizeof(USB_Descriptor_Configuration_t);
  160 + break;
  161 + case DTYPE_String:
  162 + switch (DescriptorNumber)
  163 + {
  164 + case STRING_ID_Language:
  165 + Address = &RelayBoard_LanguageString;
  166 + Size = pgm_read_byte(&RelayBoard_LanguageString.Header.Size);
  167 + break;
  168 + case STRING_ID_Manufacturer:
  169 + Address = &RelayBoard_ManufacturerString;
  170 + Size = pgm_read_byte(&RelayBoard_ManufacturerString.Header.Size);
  171 + break;
  172 + case STRING_ID_Product:
  173 + Address = &RelayBoard_ProductString;
  174 + Size = pgm_read_byte(&RelayBoard_ProductString.Header.Size);
  175 + break;
  176 + case STRING_ID_Serial:
  177 + Address = &RelayBoard_SerialString;
  178 + Size = pgm_read_byte(&RelayBoard_SerialString.Header.Size);
  179 + break;
  180 + }
  181 +
  182 + break;
  183 + }
  184 +
  185 + *DescriptorAddress = Address;
  186 + return Size;
  187 +}
  188 +
... ...
atmega16u2/PolytechLille/PAD/Descriptors.h 0 → 100644
  Show/Hide comments   View file @20f46bd
... ... @@ -0,0 +1,84 @@
  1 +/*
  2 + LUFA Library
  3 + Copyright (C) Dean Camera, 2017.
  4 +
  5 + dean [at] fourwalledcubicle [dot] com
  6 + www.lufa-lib.org
  7 +*/
  8 +
  9 +/*
  10 + Copyright 2010 OBinou (obconseil [at] gmail [dot] com)
  11 + Copyright 2017 Dean Camera (dean [at] fourwalledcubicle [dot] com)
  12 +
  13 + Permission to use, copy, modify, distribute, and sell this
  14 + software and its documentation for any purpose is hereby granted
  15 + without fee, provided that the above copyright notice appear in
  16 + all copies and that both that the copyright notice and this
  17 + permission notice and warranty disclaimer appear in supporting
  18 + documentation, and that the name of the author not be used in
  19 + advertising or publicity pertaining to distribution of the
  20 + software without specific, written prior permission.
  21 +
  22 + The author disclaims all warranties with regard to this
  23 + software, including all implied warranties of merchantability
  24 + and fitness. In no event shall the author be liable for any
  25 + special, indirect or consequential damages or any damages
  26 + whatsoever resulting from loss of use, data or profits, whether
  27 + in an action of contract, negligence or other tortious action,
  28 + arising out of or in connection with the use or performance of
  29 + this software.
  30 +*/
  31 +
  32 +/** \file
  33 + *
  34 + * Header file for Descriptors.c.
  35 + */
  36 +
  37 +#ifndef _DESCRIPTORS_H_
  38 +#define _DESCRIPTORS_H_
  39 +
  40 + /* Includes: */
  41 + #include <avr/pgmspace.h>
  42 + #include <LUFA/Drivers/USB/USB.h>
  43 +
  44 + /* Type Defines: */
  45 + /** Type define for the device configuration descriptor structure. This must be defined in the
  46 + * application code, as the configuration descriptor contains several sub-descriptors which
  47 + * vary between devices, and which describe the device's usage to the host.
  48 + */
  49 + typedef struct
  50 + {
  51 + USB_Descriptor_Configuration_Header_t Config;
  52 +
  53 + // Relay Board Interface
  54 + USB_Descriptor_Interface_t RelayBoardInterface;
  55 + } USB_Descriptor_Configuration_t;
  56 +
  57 + /** Enum for the device interface descriptor IDs within the device. Each interface descriptor
  58 + * should have a unique ID index associated with it, which can be used to refer to the
  59 + * interface from other descriptors.
  60 + */
  61 + enum InterfaceDescriptors_t
  62 + {
  63 + INTERFACE_ID_RelayBoard = 0, /**< Relay board interface descriptor ID */
  64 + };
  65 +
  66 + /** Enum for the device string descriptor IDs within the device. Each string descriptor should
  67 + * have a unique ID index associated with it, which can be used to refer to the string from
  68 + * other descriptors.
  69 + */
  70 + enum StringDescriptors_t
  71 + {
  72 + STRING_ID_Language = 0, /**< Supported Languages string descriptor ID (must be zero) */
  73 + STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */
  74 + STRING_ID_Product = 2, /**< Product string ID */
  75 + STRING_ID_Serial = 3, /**< Serial number string ID */
  76 + };
  77 +
  78 + /* Function Prototypes: */
  79 + uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
  80 + const uint16_t wIndex,
  81 + const void** const DescriptorAddress)
  82 + ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
  83 +#endif
  84 +
... ...
atmega16u2/PolytechLille/PAD/RelayBoard.c 0 → 100644
  Show/Hide comments   View file @20f46bd
... ... @@ -0,0 +1,145 @@
  1 +/*
  2 + LUFA Library
  3 + Copyright (C) Dean Camera, 2017.
  4 +
  5 + dean [at] fourwalledcubicle [dot] com
  6 + www.lufa-lib.org
  7 +*/
  8 +
  9 +/*
  10 + Copyright 2010 OBinou (obconseil [at] gmail [dot] com)
  11 + Copyright 2017 Dean Camera (dean [at] fourwalledcubicle [dot] com)
  12 +
  13 + Permission to use, copy, modify, distribute, and sell this
  14 + software and its documentation for any purpose is hereby granted
  15 + without fee, provided that the above copyright notice appear in
  16 + all copies and that both that the copyright notice and this
  17 + permission notice and warranty disclaimer appear in supporting
  18 + documentation, and that the name of the author not be used in
  19 + advertising or publicity pertaining to distribution of the
  20 + software without specific, written prior permission.
  21 +
  22 + The author disclaims all warranties with regard to this
  23 + software, including all implied warranties of merchantability
  24 + and fitness. In no event shall the author be liable for any
  25 + special, indirect or consequential damages or any damages
  26 + whatsoever resulting from loss of use, data or profits, whether
  27 + in an action of contract, negligence or other tortious action,
  28 + arising out of or in connection with the use or performance of
  29 + this software.
  30 +*/
  31 +
  32 +/** \file
  33 + *
  34 + * Main source file for the RelayBoard program. This file contains the main tasks of
  35 + * the project and is responsible for the initial application hardware configuration.
  36 + */
  37 +
  38 +#include "RelayBoard.h"
  39 +
  40 +
  41 +/** Main program entry point. This routine contains the overall program flow, including initial
  42 + * setup of all components and the main program loop.
  43 + */
  44 +int main(void)
  45 +{
  46 + SetupHardware();
  47 +
  48 + GlobalInterruptEnable();
  49 +
  50 + for (;;)
  51 + USB_USBTask();
  52 +}
  53 +
  54 +/** Configures the board hardware and chip peripherals for the project's functionality. */
  55 +void SetupHardware(void)
  56 +{
  57 +#if (ARCH == ARCH_AVR8)
  58 + /* Disable watchdog if enabled by bootloader/fuses */
  59 + MCUSR &= ~(1 << WDRF);
  60 + wdt_disable();
  61 +
  62 + /* Disable clock division */
  63 + clock_prescale_set(clock_div_1);
  64 +#endif
  65 +
  66 + /* Hardware Initialization */
  67 + USB_Init();
  68 +
  69 + /* Initialize Relays */
  70 + DDRC |= ALL_RELAYS;
  71 + PORTC &= ~ALL_RELAYS;
  72 +}
  73 +
  74 +/** Event handler for the library USB Control Request reception event. */
  75 +void EVENT_USB_Device_ControlRequest(void)
  76 +{
  77 + const uint8_t SerialNumber[5] = { 0, 0, 0, 0, 1 };
  78 + uint8_t ControlData[2] = { 0, 0 };
  79 +
  80 + switch (USB_ControlRequest.bRequest)
  81 + {
  82 + case 0x09:
  83 + if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
  84 + {
  85 + LEDs_ToggleLEDs(LEDS_LED1);
  86 +
  87 + Endpoint_ClearSETUP();
  88 +
  89 + Endpoint_Read_Control_Stream_LE(ControlData, sizeof(ControlData));
  90 + Endpoint_ClearIN();
  91 +
  92 + switch (USB_ControlRequest.wValue)
  93 + {
  94 + case 0x303:
  95 + if (ControlData[1]) PORTC &= ~RELAY1; else PORTC |= RELAY1;
  96 + break;
  97 + case 0x306:
  98 + if (ControlData[1]) PORTC &= ~RELAY2; else PORTC |= RELAY2;
  99 + break;
  100 + case 0x309:
  101 + if (ControlData[1]) PORTC &= ~RELAY3; else PORTC |= RELAY3;
  102 + break;
  103 + case 0x30c:
  104 + if (ControlData[1]) PORTC &= ~RELAY4; else PORTC |= RELAY4;
  105 + break;
  106 + }
  107 + }
  108 +
  109 + break;
  110 + case 0x01:
  111 + if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
  112 + {
  113 + LEDs_ToggleLEDs(LEDS_LED1);
  114 +
  115 + Endpoint_ClearSETUP();
  116 +
  117 + switch (USB_ControlRequest.wValue)
  118 + {
  119 + case 0x301:
  120 + Endpoint_Write_Control_Stream_LE(SerialNumber, sizeof(SerialNumber));
  121 + break;
  122 + case 0x303:
  123 + ControlData[1] = (PORTC & RELAY1) ? 2 : 3;
  124 + break;
  125 + case 0x306:
  126 + ControlData[1] = (PORTC & RELAY2) ? 2 : 3;
  127 + break;
  128 + case 0x309:
  129 + ControlData[1] = (PORTC & RELAY3) ? 2 : 3;
  130 + break;
  131 + case 0x30c:
  132 + ControlData[1] = (PORTC & RELAY4) ? 2 : 3;
  133 + break;
  134 + }
  135 +
  136 + if (ControlData[1])
  137 + Endpoint_Write_Control_Stream_LE(ControlData, sizeof(ControlData));
  138 +
  139 + Endpoint_ClearOUT();
  140 + }
  141 +
  142 + break;
  143 + }
  144 +}
  145 +
... ...
atmega16u2/PolytechLille/PAD/RelayBoard.h 0 → 100644
  Show/Hide comments   View file @20f46bd
... ... @@ -0,0 +1,65 @@
  1 +/*
  2 + LUFA Library
  3 + Copyright (C) Dean Camera, 2017.
  4 +
  5 + dean [at] fourwalledcubicle [dot] com
  6 + www.lufa-lib.org
  7 +*/
  8 +
  9 +/*
  10 + Copyright 2010 OBinou (obconseil [at] gmail [dot] com)
  11 + Copyright 2017 Dean Camera (dean [at] fourwalledcubicle [dot] com)
  12 +
  13 + Permission to use, copy, modify, distribute, and sell this
  14 + software and its documentation for any purpose is hereby granted
  15 + without fee, provided that the above copyright notice appear in
  16 + all copies and that both that the copyright notice and this
  17 + permission notice and warranty disclaimer appear in supporting
  18 + documentation, and that the name of the author not be used in
  19 + advertising or publicity pertaining to distribution of the
  20 + software without specific, written prior permission.
  21 +
  22 + The author disclaims all warranties with regard to this
  23 + software, including all implied warranties of merchantability
  24 + and fitness. In no event shall the author be liable for any
  25 + special, indirect or consequential damages or any damages
  26 + whatsoever resulting from loss of use, data or profits, whether
  27 + in an action of contract, negligence or other tortious action,
  28 + arising out of or in connection with the use or performance of
  29 + this software.
  30 +*/
  31 +
  32 +/** \file
  33 + *
  34 + * Header file for RelayBoard.c.
  35 + */
  36 +
  37 +#ifndef _RELAYBOARD_H_
  38 +#define _RELAYBOARD_H_
  39 +
  40 + /* Includes: */
  41 + #include <avr/io.h>
  42 + #include <avr/wdt.h>
  43 + #include <avr/power.h>
  44 + #include <avr/interrupt.h>
  45 +
  46 + #include "Descriptors.h"
  47 +
  48 + #include <LUFA/Drivers/Board/LEDs.h>
  49 + #include <LUFA/Drivers/USB/USB.h>
  50 + #include <LUFA/Platform/Platform.h>
  51 +
  52 + /* Macros: */
  53 + #define RELAY1 (1 << 7)
  54 + #define RELAY2 (1 << 6)
  55 + #define RELAY3 (1 << 5)
  56 + #define RELAY4 (1 << 4)
  57 + #define ALL_RELAYS (RELAY1 | RELAY2 | RELAY3 | RELAY4)
  58 +
  59 + /* Function Prototypes: */
  60 + void SetupHardware(void);
  61 +
  62 + void EVENT_USB_Device_ControlRequest(void);
  63 +
  64 +#endif
  65 +
... ...
atmega16u2/PolytechLille/PAD/RelayBoard.txt 0 → 100644
  Show/Hide comments   View file @20f46bd
... ... @@ -0,0 +1,106 @@
  1 +/** \file
  2 + *
  3 + * This file contains special DoxyGen information for the generation of the main page and other special
  4 + * documentation pages. It is not a project source file.
  5 + */
  6 +
  7 +/** \mainpage OB's Quad-Relay outlet control using a Teensy2++
  8 + *
  9 + * \section Sec_Compat Project Compatibility:
  10 + *
  11 + * The following list indicates what microcontrollers are compatible with this project.
  12 + *
  13 + * \li AT90USB1286
  14 + *
  15 + * \section Sec_Info USB Information:
  16 + *
  17 + * The following table gives a rundown of the USB utilization of this project.
  18 + *
  19 + * <table>
  20 + * <tr>
  21 + * <td><b>USB Mode:</b></td>
  22 + * <td>Device</td>
  23 + * </tr>
  24 + * <tr>
  25 + * <td><b>USB Class:</b></td>
  26 + * <td>None</td>
  27 + * </tr>
  28 + * <tr>
  29 + * <td><b>USB Subclass:</b></td>
  30 + * <td>None</td>
  31 + * </tr>
  32 + * <tr>
  33 + * <td><b>Relevant Standards:</b></td>
  34 + * <td>USB Standards</td>
  35 + * </tr>
  36 + * <tr>
  37 + * <td><b>Supported USB Speeds:</b></td>
  38 + * <td>Low Speed Mode, Full Speed Mode</td>
  39 + * </tr>
  40 + * </table>
  41 + *
  42 + * \section Sec_Description Project Description:
  43 + *
  44 + * Firmware for a Teensy2++ AVR-based miniboard to control four relays, using the
  45 + * same protocol used by the commercially available Silver Shield PM power outlets
  46 + * ( http://sourceforge.net/projects/sispmctl ) sold for some time. Because this
  47 + * project mimics the original device, it can be controlled using the "sismpctl"
  48 + * package included in many Linux distributions - including router-orientated
  49 + * versions such as OpenWRT - to control the board's relays.
  50 + *
  51 + * Relays 1 to 4 are respectively wired to pins C4, C5, C6 and C7 of the Teensy++ V2,
  52 + * which are the PORTC bits 4 to 7 of the AT90USB1286. The relays MUST be wired through
  53 + * a transistor, and a diode must be added in antiparallel on the relay's coil pins to
  54 + * protect the transistor from back EMF generated from the relay when the coil is turned off.
  55 + * The transistor base pin is wired to the Teensy data port through a 10K resistor. A
  56 + * LED may be also be added as a relay status indicator on each channel.
  57 + *
  58 + * The Relay coil will be driven by the transistor, but the power will come from
  59 + * the 5V from the PC's USB port: Be careful in choosing the relay to avoid overloading
  60 + * the PC, as the maximum current used MUST remains under ~450mA @ 5V.
  61 + *
  62 + * The author's tested relays are 2 Finder 32.21.7.005.2000, coil il 125ohm, which can
  63 + * handle 5A @ 250VAC. Be careful to use proper isolation if high voltages are manipulated.
  64 + * The author used Hotglue to isolate all parts of the PCB in contact with high voltage.
  65 + *
  66 + * See <a>http://www.pjrc.com/teensy/</a> for the Teensy2++ website.
  67 + *
  68 + * <table>
  69 + * <tr>
  70 + * <td><b>Signal:</b></td>
  71 + * <td><b>AVR Port:</b></td>
  72 + * </tr>
  73 + * <tr>
  74 + * <td>Relay 1</td>
  75 + * <td>PORTC, Pin 4</td>
  76 + * </tr>
  77 + * <tr>
  78 + * <td>Relay 2</td>
  79 + * <td>PORTC, Pin 5</td>
  80 + * </tr>
  81 + * <tr>
  82 + * <td>Relay 3</td>
  83 + * <td>PORTC, Pin 6</td>
  84 + * </tr>
  85 + * <tr>
  86 + * <td>Relay 4</td>
  87 + * <td>PORTC, Pin 7</td>
  88 + * </tr>
  89 + * <tr>
  90 + * <td>Teensy2++ Yellow Led</td>
  91 + * <td>PORTD, pin 6</td>
  92 + * </tr>
  93 + * </table>
  94 + *
  95 + * \section Sec_Options Project Options
  96 + *
  97 + * The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
  98 + *
  99 + * <table>
  100 + * <tr>
  101 + * <td>
  102 + * None
  103 + * </td>
  104 + * </tr>
  105 + * </table>
  106 + */
... ...
atmega16u2/PolytechLille/PAD/asf.xml 0 → 100644
  Show/Hide comments   View file @20f46bd
... ... @@ -0,0 +1,47 @@
  1 +<asf xmlversion="1.0">
  2 + <project caption="Relay Board Controller" id="lufa.projects.relay_board.avr8">
  3 + <require idref="lufa.projects.relay_board"/>
  4 + <require idref="lufa.boards.dummy.avr8"/>
  5 + <generator value="as5_8"/>
  6 +
  7 + <device-support value="at90usb1287"/>
  8 + <config name="lufa.drivers.board.name" value="usbkey"/>
  9 +
  10 + <build type="define" name="F_CPU" value="8000000UL"/>
  11 + <build type="define" name="F_USB" value="8000000UL"/>
  12 + </project>
  13 +
  14 + <module type="application" id="lufa.projects.relay_board" caption="Relay Board Controller">
  15 + <info type="description" value="summary">
  16 + Relay Board Controller project.
  17 + </info>
  18 +
  19 + <info type="gui-flag" value="move-to-root"/>
  20 +
  21 + <info type="keyword" value="Technology">
  22 + <keyword value="Low Level APIs"/>
  23 + <keyword value="USB Device"/>
  24 + </info>
  25 +
  26 + <device-support-alias value="lufa_avr8"/>
  27 + <device-support-alias value="lufa_xmega"/>
  28 + <device-support-alias value="lufa_uc3"/>
  29 +
  30 + <build type="distribute" subtype="user-file" value="doxyfile"/>
  31 + <build type="distribute" subtype="user-file" value="RelayBoard.txt"/>
  32 +
  33 + <build type="c-source" value="RelayBoard.c"/>
  34 + <build type="c-source" value="Descriptors.c"/>
  35 + <build type="header-file" value="RelayBoard.h"/>
  36 + <build type="header-file" value="Descriptors.h"/>
  37 +
  38 + <build type="module-config" subtype="path" value="Config"/>
  39 + <build type="header-file" value="Config/LUFAConfig.h"/>
  40 +
  41 + <require idref="lufa.common"/>
  42 + <require idref="lufa.platform"/>
  43 + <require idref="lufa.drivers.usb"/>
  44 + <require idref="lufa.drivers.board"/>
  45 + <require idref="lufa.drivers.board.leds"/>
  46 + </module>
  47 +</asf>
... ...
atmega16u2/PolytechLille/PAD/doxyfile 0 → 100644
  Show/Hide comments   View file @20f46bd
... ... @@ -0,0 +1,2395 @@
  1 +# Doxyfile 1.8.9
  2 +
  3 +# This file describes the settings to be used by the documentation system
  4 +# doxygen (www.doxygen.org) for a project.
  5 +#
  6 +# All text after a double hash (##) is considered a comment and is placed in
  7 +# front of the TAG it is preceding.
  8 +#
  9 +# All text after a single hash (#) is considered a comment and will be ignored.
  10 +# The format is:
  11 +# TAG = value [value, ...]
  12 +# For lists, items can also be appended using:
  13 +# TAG += value [value, ...]
  14 +# Values that contain spaces should be placed between quotes (\" \").
  15 +
  16 +#---------------------------------------------------------------------------
  17 +# Project related configuration options
  18 +#---------------------------------------------------------------------------
  19 +
  20 +# This tag specifies the encoding used for all characters in the config file
  21 +# that follow. The default is UTF-8 which is also the encoding used for all text
  22 +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
  23 +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
  24 +# for the list of possible encodings.
  25 +# The default value is: UTF-8.
  26 +
  27 +DOXYFILE_ENCODING = UTF-8
  28 +
  29 +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
  30 +# double-quotes, unless you are using Doxywizard) that should identify the
  31 +# project for which the documentation is generated. This name is used in the
  32 +# title of most generated pages and in a few other places.
  33 +# The default value is: My Project.
  34 +
  35 +PROJECT_NAME = "OB's Dual-Relay Outlet Control Project"
  36 +
  37 +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
  38 +# could be handy for archiving the generated documentation or if some version
  39 +# control system is used.
  40 +
  41 +PROJECT_NUMBER =
  42 +
  43 +# Using the PROJECT_BRIEF tag one can provide an optional one line description
  44 +# for a project that appears at the top of each page and should give viewer a
  45 +# quick idea about the purpose of the project. Keep the description short.
  46 +
  47 +PROJECT_BRIEF =
  48 +
  49 +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
  50 +# in the documentation. The maximum height of the logo should not exceed 55
  51 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
  52 +# the logo to the output directory.
  53 +
  54 +PROJECT_LOGO =
  55 +
  56 +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
  57 +# into which the generated documentation will be written. If a relative path is
  58 +# entered, it will be relative to the location where doxygen was started. If
  59 +# left blank the current directory will be used.
  60 +
  61 +OUTPUT_DIRECTORY = ./Documentation/
  62 +
  63 +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
  64 +# directories (in 2 levels) under the output directory of each output format and
  65 +# will distribute the generated files over these directories. Enabling this
  66 +# option can be useful when feeding doxygen a huge amount of source files, where
  67 +# putting all generated files in the same directory would otherwise causes
  68 +# performance problems for the file system.
  69 +# The default value is: NO.
  70 +
  71 +CREATE_SUBDIRS = NO
  72 +
  73 +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
  74 +# characters to appear in the names of generated files. If set to NO, non-ASCII
  75 +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
  76 +# U+3044.
  77 +# The default value is: NO.
  78 +
  79 +ALLOW_UNICODE_NAMES = NO
  80 +
  81 +# The OUTPUT_LANGUAGE tag is used to specify the language in which all
  82 +# documentation generated by doxygen is written. Doxygen will use this
  83 +# information to generate all constant output in the proper language.
  84 +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
  85 +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
  86 +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
  87 +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
  88 +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
  89 +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
  90 +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
  91 +# Ukrainian and Vietnamese.
  92 +# The default value is: English.
  93 +
  94 +OUTPUT_LANGUAGE = English
  95 +
  96 +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
  97 +# descriptions after the members that are listed in the file and class
  98 +# documentation (similar to Javadoc). Set to NO to disable this.
  99 +# The default value is: YES.
  100 +
  101 +BRIEF_MEMBER_DESC = YES
  102 +
  103 +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
  104 +# description of a member or function before the detailed description
  105 +#
  106 +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
  107 +# brief descriptions will be completely suppressed.
  108 +# The default value is: YES.
  109 +
  110 +REPEAT_BRIEF = YES
  111 +
  112 +# This tag implements a quasi-intelligent brief description abbreviator that is
  113 +# used to form the text in various listings. Each string in this list, if found
  114 +# as the leading text of the brief description, will be stripped from the text
  115 +# and the result, after processing the whole list, is used as the annotated
  116 +# text. Otherwise, the brief description is used as-is. If left blank, the
  117 +# following values are used ($name is automatically replaced with the name of
  118 +# the entity):The $name class, The $name widget, The $name file, is, provides,
  119 +# specifies, contains, represents, a, an and the.
  120 +
  121 +ABBREVIATE_BRIEF = "The $name class" \
  122 + "The $name widget" \
  123 + "The $name file" \
  124 + is \
  125 + provides \
  126 + specifies \
  127 + contains \
  128 + represents \
  129 + a \
  130 + an \
  131 + the
  132 +
  133 +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
  134 +# doxygen will generate a detailed section even if there is only a brief
  135 +# description.
  136 +# The default value is: NO.
  137 +
  138 +ALWAYS_DETAILED_SEC = NO
  139 +
  140 +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
  141 +# inherited members of a class in the documentation of that class as if those
  142 +# members were ordinary class members. Constructors, destructors and assignment
  143 +# operators of the base classes will not be shown.
  144 +# The default value is: NO.
  145 +
  146 +INLINE_INHERITED_MEMB = NO
  147 +
  148 +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
  149 +# before files name in the file list and in the header files. If set to NO the
  150 +# shortest path that makes the file name unique will be used
  151 +# The default value is: YES.
  152 +
  153 +FULL_PATH_NAMES = YES
  154 +
  155 +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
  156 +# Stripping is only done if one of the specified strings matches the left-hand
  157 +# part of the path. The tag can be used to show relative paths in the file list.
  158 +# If left blank the directory from which doxygen is run is used as the path to
  159 +# strip.
  160 +#
  161 +# Note that you can specify absolute paths here, but also relative paths, which
  162 +# will be relative from the directory where doxygen is started.
  163 +# This tag requires that the tag FULL_PATH_NAMES is set to YES.
  164 +
  165 +STRIP_FROM_PATH =
  166 +
  167 +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
  168 +# path mentioned in the documentation of a class, which tells the reader which
  169 +# header file to include in order to use a class. If left blank only the name of
  170 +# the header file containing the class definition is used. Otherwise one should
  171 +# specify the list of include paths that are normally passed to the compiler
  172 +# using the -I flag.
  173 +
  174 +STRIP_FROM_INC_PATH =
  175 +
  176 +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
  177 +# less readable) file names. This can be useful is your file systems doesn't
  178 +# support long names like on DOS, Mac, or CD-ROM.
  179 +# The default value is: NO.
  180 +
  181 +SHORT_NAMES = YES
  182 +
  183 +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
  184 +# first line (until the first dot) of a Javadoc-style comment as the brief
  185 +# description. If set to NO, the Javadoc-style will behave just like regular Qt-
  186 +# style comments (thus requiring an explicit @brief command for a brief
  187 +# description.)
  188 +# The default value is: NO.
  189 +
  190 +JAVADOC_AUTOBRIEF = NO
  191 +
  192 +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
  193 +# line (until the first dot) of a Qt-style comment as the brief description. If
  194 +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
  195 +# requiring an explicit \brief command for a brief description.)
  196 +# The default value is: NO.
  197 +
  198 +QT_AUTOBRIEF = NO
  199 +
  200 +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
  201 +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
  202 +# a brief description. This used to be the default behavior. The new default is
  203 +# to treat a multi-line C++ comment block as a detailed description. Set this
  204 +# tag to YES if you prefer the old behavior instead.
  205 +#
  206 +# Note that setting this tag to YES also means that rational rose comments are
  207 +# not recognized any more.
  208 +# The default value is: NO.
  209 +
  210 +MULTILINE_CPP_IS_BRIEF = NO
  211 +
  212 +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
  213 +# documentation from any documented member that it re-implements.
  214 +# The default value is: YES.
  215 +
  216 +INHERIT_DOCS = YES
  217 +
  218 +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
  219 +# page for each member. If set to NO, the documentation of a member will be part
  220 +# of the file/class/namespace that contains it.
  221 +# The default value is: NO.
  222 +
  223 +SEPARATE_MEMBER_PAGES = NO
  224 +
  225 +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
  226 +# uses this value to replace tabs by spaces in code fragments.
  227 +# Minimum value: 1, maximum value: 16, default value: 4.
  228 +
  229 +TAB_SIZE = 4
  230 +
  231 +# This tag can be used to specify a number of aliases that act as commands in
  232 +# the documentation. An alias has the form:
  233 +# name=value
  234 +# For example adding
  235 +# "sideeffect=@par Side Effects:\n"
  236 +# will allow you to put the command \sideeffect (or @sideeffect) in the
  237 +# documentation, which will result in a user-defined paragraph with heading
  238 +# "Side Effects:". You can put \n's in the value part of an alias to insert
  239 +# newlines.
  240 +
  241 +ALIASES =
  242 +
  243 +# This tag can be used to specify a number of word-keyword mappings (TCL only).
  244 +# A mapping has the form "name=value". For example adding "class=itcl::class"
  245 +# will allow you to use the command class in the itcl::class meaning.
  246 +
  247 +TCL_SUBST =
  248 +
  249 +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
  250 +# only. Doxygen will then generate output that is more tailored for C. For
  251 +# instance, some of the names that are used will be different. The list of all
  252 +# members will be omitted, etc.
  253 +# The default value is: NO.
  254 +
  255 +OPTIMIZE_OUTPUT_FOR_C = YES
  256 +
  257 +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
  258 +# Python sources only. Doxygen will then generate output that is more tailored
  259 +# for that language. For instance, namespaces will be presented as packages,
  260 +# qualified scopes will look different, etc.
  261 +# The default value is: NO.
  262 +
  263 +OPTIMIZE_OUTPUT_JAVA = NO
  264 +
  265 +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
  266 +# sources. Doxygen will then generate output that is tailored for Fortran.
  267 +# The default value is: NO.
  268 +
  269 +OPTIMIZE_FOR_FORTRAN = NO
  270 +
  271 +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
  272 +# sources. Doxygen will then generate output that is tailored for VHDL.
  273 +# The default value is: NO.
  274 +
  275 +OPTIMIZE_OUTPUT_VHDL = NO
  276 +
  277 +# Doxygen selects the parser to use depending on the extension of the files it
  278 +# parses. With this tag you can assign which parser to use for a given
  279 +# extension. Doxygen has a built-in mapping, but you can override or extend it
  280 +# using this tag. The format is ext=language, where ext is a file extension, and
  281 +# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
  282 +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
  283 +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
  284 +# Fortran. In the later case the parser tries to guess whether the code is fixed
  285 +# or free formatted code, this is the default for Fortran type files), VHDL. For
  286 +# instance to make doxygen treat .inc files as Fortran files (default is PHP),
  287 +# and .f files as C (default is Fortran), use: inc=Fortran f=C.
  288 +#
  289 +# Note: For files without extension you can use no_extension as a placeholder.
  290 +#
  291 +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
  292 +# the files are not read by doxygen.
  293 +
  294 +EXTENSION_MAPPING =
  295 +
  296 +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
  297 +# according to the Markdown format, which allows for more readable
  298 +# documentation. See http://daringfireball.net/projects/markdown/ for details.
  299 +# The output of markdown processing is further processed by doxygen, so you can
  300 +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
  301 +# case of backward compatibilities issues.
  302 +# The default value is: YES.
  303 +
  304 +MARKDOWN_SUPPORT = NO
  305 +
  306 +# When enabled doxygen tries to link words that correspond to documented
  307 +# classes, or namespaces to their corresponding documentation. Such a link can
  308 +# be prevented in individual cases by putting a % sign in front of the word or
  309 +# globally by setting AUTOLINK_SUPPORT to NO.
  310 +# The default value is: YES.
  311 +
  312 +AUTOLINK_SUPPORT = YES
  313 +
  314 +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
  315 +# to include (a tag file for) the STL sources as input, then you should set this
  316 +# tag to YES in order to let doxygen match functions declarations and
  317 +# definitions whose arguments contain STL classes (e.g. func(std::string);
  318 +# versus func(std::string) {}). This also make the inheritance and collaboration
  319 +# diagrams that involve STL classes more complete and accurate.
  320 +# The default value is: NO.
  321 +
  322 +BUILTIN_STL_SUPPORT = NO
  323 +
  324 +# If you use Microsoft's C++/CLI language, you should set this option to YES to
  325 +# enable parsing support.
  326 +# The default value is: NO.
  327 +
  328 +CPP_CLI_SUPPORT = NO
  329 +
  330 +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
  331 +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
  332 +# will parse them like normal C++ but will assume all classes use public instead
  333 +# of private inheritance when no explicit protection keyword is present.
  334 +# The default value is: NO.
  335 +
  336 +SIP_SUPPORT = NO
  337 +
  338 +# For Microsoft's IDL there are propget and propput attributes to indicate
  339 +# getter and setter methods for a property. Setting this option to YES will make
  340 +# doxygen to replace the get and set methods by a property in the documentation.
  341 +# This will only work if the methods are indeed getting or setting a simple
  342 +# type. If this is not the case, or you want to show the methods anyway, you
  343 +# should set this option to NO.
  344 +# The default value is: YES.
  345 +
  346 +IDL_PROPERTY_SUPPORT = YES
  347 +
  348 +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
  349 +# tag is set to YES then doxygen will reuse the documentation of the first
  350 +# member in the group (if any) for the other members of the group. By default
  351 +# all members of a group must be documented explicitly.
  352 +# The default value is: NO.
  353 +
  354 +DISTRIBUTE_GROUP_DOC = NO
  355 +
  356 +# Set the SUBGROUPING tag to YES to allow class member groups of the same type
  357 +# (for instance a group of public functions) to be put as a subgroup of that
  358 +# type (e.g. under the Public Functions section). Set it to NO to prevent
  359 +# subgrouping. Alternatively, this can be done per class using the
  360 +# \nosubgrouping command.
  361 +# The default value is: YES.
  362 +
  363 +SUBGROUPING = YES
  364 +
  365 +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
  366 +# are shown inside the group in which they are included (e.g. using \ingroup)
  367 +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
  368 +# and RTF).
  369 +#
  370 +# Note that this feature does not work in combination with
  371 +# SEPARATE_MEMBER_PAGES.
  372 +# The default value is: NO.
  373 +
  374 +INLINE_GROUPED_CLASSES = NO
  375 +
  376 +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
  377 +# with only public data fields or simple typedef fields will be shown inline in
  378 +# the documentation of the scope in which they are defined (i.e. file,
  379 +# namespace, or group documentation), provided this scope is documented. If set
  380 +# to NO, structs, classes, and unions are shown on a separate page (for HTML and
  381 +# Man pages) or section (for LaTeX and RTF).
  382 +# The default value is: NO.
  383 +
  384 +INLINE_SIMPLE_STRUCTS = NO
  385 +
  386 +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
  387 +# enum is documented as struct, union, or enum with the name of the typedef. So
  388 +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
  389 +# with name TypeT. When disabled the typedef will appear as a member of a file,
  390 +# namespace, or class. And the struct will be named TypeS. This can typically be
  391 +# useful for C code in case the coding convention dictates that all compound
  392 +# types are typedef'ed and only the typedef is referenced, never the tag name.
  393 +# The default value is: NO.
  394 +
  395 +TYPEDEF_HIDES_STRUCT = NO
  396 +
  397 +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
  398 +# cache is used to resolve symbols given their name and scope. Since this can be
  399 +# an expensive process and often the same symbol appears multiple times in the
  400 +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
  401 +# doxygen will become slower. If the cache is too large, memory is wasted. The
  402 +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
  403 +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
  404 +# symbols. At the end of a run doxygen will report the cache usage and suggest
  405 +# the optimal cache size from a speed point of view.
  406 +# Minimum value: 0, maximum value: 9, default value: 0.
  407 +
  408 +LOOKUP_CACHE_SIZE = 0
  409 +
  410 +#---------------------------------------------------------------------------
  411 +# Build related configuration options
  412 +#---------------------------------------------------------------------------
  413 +
  414 +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
  415 +# documentation are documented, even if no documentation was available. Private
  416 +# class members and static file members will be hidden unless the
  417 +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
  418 +# Note: This will also disable the warnings about undocumented members that are
  419 +# normally produced when WARNINGS is set to YES.
  420 +# The default value is: NO.
  421 +
  422 +EXTRACT_ALL = YES
  423 +
  424 +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
  425 +# be included in the documentation.
  426 +# The default value is: NO.
  427 +
  428 +EXTRACT_PRIVATE = YES
  429 +
  430 +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
  431 +# scope will be included in the documentation.
  432 +# The default value is: NO.
  433 +
  434 +EXTRACT_PACKAGE = NO
  435 +
  436 +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
  437 +# included in the documentation.
  438 +# The default value is: NO.
  439 +
  440 +EXTRACT_STATIC = YES
  441 +
  442 +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
  443 +# locally in source files will be included in the documentation. If set to NO,
  444 +# only classes defined in header files are included. Does not have any effect
  445 +# for Java sources.
  446 +# The default value is: YES.
  447 +
  448 +EXTRACT_LOCAL_CLASSES = YES
  449 +
  450 +# This flag is only useful for Objective-C code. If set to YES, local methods,
  451 +# which are defined in the implementation section but not in the interface are
  452 +# included in the documentation. If set to NO, only methods in the interface are
  453 +# included.
  454 +# The default value is: NO.
  455 +
  456 +EXTRACT_LOCAL_METHODS = NO
  457 +
  458 +# If this flag is set to YES, the members of anonymous namespaces will be
  459 +# extracted and appear in the documentation as a namespace called
  460 +# 'anonymous_namespace{file}', where file will be replaced with the base name of
  461 +# the file that contains the anonymous namespace. By default anonymous namespace
  462 +# are hidden.
  463 +# The default value is: NO.
  464 +
  465 +EXTRACT_ANON_NSPACES = NO
  466 +
  467 +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
  468 +# undocumented members inside documented classes or files. If set to NO these
  469 +# members will be included in the various overviews, but no documentation
  470 +# section is generated. This option has no effect if EXTRACT_ALL is enabled.
  471 +# The default value is: NO.
  472 +
  473 +HIDE_UNDOC_MEMBERS = NO
  474 +
  475 +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
  476 +# undocumented classes that are normally visible in the class hierarchy. If set
  477 +# to NO, these classes will be included in the various overviews. This option
  478 +# has no effect if EXTRACT_ALL is enabled.
  479 +# The default value is: NO.
  480 +
  481 +HIDE_UNDOC_CLASSES = NO
  482 +
  483 +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
  484 +# (class|struct|union) declarations. If set to NO, these declarations will be
  485 +# included in the documentation.
  486 +# The default value is: NO.
  487 +
  488 +HIDE_FRIEND_COMPOUNDS = NO
  489 +
  490 +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
  491 +# documentation blocks found inside the body of a function. If set to NO, these
  492 +# blocks will be appended to the function's detailed documentation block.
  493 +# The default value is: NO.
  494 +
  495 +HIDE_IN_BODY_DOCS = NO
  496 +
  497 +# The INTERNAL_DOCS tag determines if documentation that is typed after a
  498 +# \internal command is included. If the tag is set to NO then the documentation
  499 +# will be excluded. Set it to YES to include the internal documentation.
  500 +# The default value is: NO.
  501 +
  502 +INTERNAL_DOCS = NO
  503 +
  504 +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
  505 +# names in lower-case letters. If set to YES, upper-case letters are also
  506 +# allowed. This is useful if you have classes or files whose names only differ
  507 +# in case and if your file system supports case sensitive file names. Windows
  508 +# and Mac users are advised to set this option to NO.
  509 +# The default value is: system dependent.
  510 +
  511 +CASE_SENSE_NAMES = NO
  512 +
  513 +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
  514 +# their full class and namespace scopes in the documentation. If set to YES, the
  515 +# scope will be hidden.
  516 +# The default value is: NO.
  517 +
  518 +HIDE_SCOPE_NAMES = NO
  519 +
  520 +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
  521 +# append additional text to a page's title, such as Class Reference. If set to
  522 +# YES the compound reference will be hidden.
  523 +# The default value is: NO.
  524 +
  525 +HIDE_COMPOUND_REFERENCE= NO
  526 +
  527 +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
  528 +# the files that are included by a file in the documentation of that file.
  529 +# The default value is: YES.
  530 +
  531 +SHOW_INCLUDE_FILES = YES
  532 +
  533 +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
  534 +# grouped member an include statement to the documentation, telling the reader
  535 +# which file to include in order to use the member.
  536 +# The default value is: NO.
  537 +
  538 +SHOW_GROUPED_MEMB_INC = NO
  539 +
  540 +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
  541 +# files with double quotes in the documentation rather than with sharp brackets.
  542 +# The default value is: NO.
  543 +
  544 +FORCE_LOCAL_INCLUDES = NO
  545 +
  546 +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
  547 +# documentation for inline members.
  548 +# The default value is: YES.
  549 +
  550 +INLINE_INFO = YES
  551 +
  552 +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
  553 +# (detailed) documentation of file and class members alphabetically by member
  554 +# name. If set to NO, the members will appear in declaration order.
  555 +# The default value is: YES.
  556 +
  557 +SORT_MEMBER_DOCS = YES
  558 +
  559 +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
  560 +# descriptions of file, namespace and class members alphabetically by member
  561 +# name. If set to NO, the members will appear in declaration order. Note that
  562 +# this will also influence the order of the classes in the class list.
  563 +# The default value is: NO.
  564 +
  565 +SORT_BRIEF_DOCS = NO
  566 +
  567 +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
  568 +# (brief and detailed) documentation of class members so that constructors and
  569 +# destructors are listed first. If set to NO the constructors will appear in the
  570 +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
  571 +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
  572 +# member documentation.
  573 +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
  574 +# detailed member documentation.
  575 +# The default value is: NO.
  576 +
  577 +SORT_MEMBERS_CTORS_1ST = NO
  578 +
  579 +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
  580 +# of group names into alphabetical order. If set to NO the group names will
  581 +# appear in their defined order.
  582 +# The default value is: NO.
  583 +
  584 +SORT_GROUP_NAMES = NO
  585 +
  586 +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
  587 +# fully-qualified names, including namespaces. If set to NO, the class list will
  588 +# be sorted only by class name, not including the namespace part.
  589 +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
  590 +# Note: This option applies only to the class list, not to the alphabetical
  591 +# list.
  592 +# The default value is: NO.
  593 +
  594 +SORT_BY_SCOPE_NAME = NO
  595 +
  596 +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
  597 +# type resolution of all parameters of a function it will reject a match between
  598 +# the prototype and the implementation of a member function even if there is
  599 +# only one candidate or it is obvious which candidate to choose by doing a
  600 +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
  601 +# accept a match between prototype and implementation in such cases.
  602 +# The default value is: NO.
  603 +
  604 +STRICT_PROTO_MATCHING = NO
  605 +
  606 +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
  607 +# list. This list is created by putting \todo commands in the documentation.
  608 +# The default value is: YES.
  609 +
  610 +GENERATE_TODOLIST = NO
  611 +
  612 +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
  613 +# list. This list is created by putting \test commands in the documentation.
  614 +# The default value is: YES.
  615 +
  616 +GENERATE_TESTLIST = NO
  617 +
  618 +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
  619 +# list. This list is created by putting \bug commands in the documentation.
  620 +# The default value is: YES.
  621 +
  622 +GENERATE_BUGLIST = NO
  623 +
  624 +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
  625 +# the deprecated list. This list is created by putting \deprecated commands in
  626 +# the documentation.
  627 +# The default value is: YES.
  628 +
  629 +GENERATE_DEPRECATEDLIST= YES
  630 +
  631 +# The ENABLED_SECTIONS tag can be used to enable conditional documentation
  632 +# sections, marked by \if <section_label> ... \endif and \cond <section_label>
  633 +# ... \endcond blocks.
  634 +
  635 +ENABLED_SECTIONS =
  636 +
  637 +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
  638 +# initial value of a variable or macro / define can have for it to appear in the
  639 +# documentation. If the initializer consists of more lines than specified here
  640 +# it will be hidden. Use a value of 0 to hide initializers completely. The
  641 +# appearance of the value of individual variables and macros / defines can be
  642 +# controlled using \showinitializer or \hideinitializer command in the
  643 +# documentation regardless of this setting.
  644 +# Minimum value: 0, maximum value: 10000, default value: 30.
  645 +
  646 +MAX_INITIALIZER_LINES = 30
  647 +
  648 +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
  649 +# the bottom of the documentation of classes and structs. If set to YES, the
  650 +# list will mention the files that were used to generate the documentation.
  651 +# The default value is: YES.
  652 +
  653 +SHOW_USED_FILES = YES
  654 +
  655 +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
  656 +# will remove the Files entry from the Quick Index and from the Folder Tree View
  657 +# (if specified).
  658 +# The default value is: YES.
  659 +
  660 +SHOW_FILES = YES
  661 +
  662 +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
  663 +# page. This will remove the Namespaces entry from the Quick Index and from the
  664 +# Folder Tree View (if specified).
  665 +# The default value is: YES.
  666 +
  667 +SHOW_NAMESPACES = YES
  668 +
  669 +# The FILE_VERSION_FILTER tag can be used to specify a program or script that
  670 +# doxygen should invoke to get the current version for each file (typically from
  671 +# the version control system). Doxygen will invoke the program by executing (via
  672 +# popen()) the command command input-file, where command is the value of the
  673 +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
  674 +# by doxygen. Whatever the program writes to standard output is used as the file
  675 +# version. For an example see the documentation.
  676 +
  677 +FILE_VERSION_FILTER =
  678 +
  679 +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
  680 +# by doxygen. The layout file controls the global structure of the generated
  681 +# output files in an output format independent way. To create the layout file
  682 +# that represents doxygen's defaults, run doxygen with the -l option. You can
  683 +# optionally specify a file name after the option, if omitted DoxygenLayout.xml
  684 +# will be used as the name of the layout file.
  685 +#
  686 +# Note that if you run doxygen from a directory containing a file called
  687 +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
  688 +# tag is left empty.
  689 +
  690 +LAYOUT_FILE =
  691 +
  692 +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
  693 +# the reference definitions. This must be a list of .bib files. The .bib
  694 +# extension is automatically appended if omitted. This requires the bibtex tool
  695 +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
  696 +# For LaTeX the style of the bibliography can be controlled using
  697 +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
  698 +# search path. See also \cite for info how to create references.
  699 +
  700 +CITE_BIB_FILES =
  701 +
  702 +#---------------------------------------------------------------------------
  703 +# Configuration options related to warning and progress messages
  704 +#---------------------------------------------------------------------------
  705 +
  706 +# The QUIET tag can be used to turn on/off the messages that are generated to
  707 +# standard output by doxygen. If QUIET is set to YES this implies that the
  708 +# messages are off.
  709 +# The default value is: NO.
  710 +
  711 +QUIET = YES
  712 +
  713 +# The WARNINGS tag can be used to turn on/off the warning messages that are
  714 +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
  715 +# this implies that the warnings are on.
  716 +#
  717 +# Tip: Turn warnings on while writing the documentation.
  718 +# The default value is: YES.
  719 +
  720 +WARNINGS = YES
  721 +
  722 +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
  723 +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
  724 +# will automatically be disabled.
  725 +# The default value is: YES.
  726 +
  727 +WARN_IF_UNDOCUMENTED = YES
  728 +
  729 +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
  730 +# potential errors in the documentation, such as not documenting some parameters
  731 +# in a documented function, or documenting parameters that don't exist or using
  732 +# markup commands wrongly.
  733 +# The default value is: YES.
  734 +
  735 +WARN_IF_DOC_ERROR = YES
  736 +
  737 +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
  738 +# are documented, but have no documentation for their parameters or return
  739 +# value. If set to NO, doxygen will only warn about wrong or incomplete
  740 +# parameter documentation, but not about the absence of documentation.
  741 +# The default value is: NO.
  742 +
  743 +WARN_NO_PARAMDOC = YES
  744 +
  745 +# The WARN_FORMAT tag determines the format of the warning messages that doxygen
  746 +# can produce. The string should contain the $file, $line, and $text tags, which
  747 +# will be replaced by the file and line number from which the warning originated
  748 +# and the warning text. Optionally the format may contain $version, which will
  749 +# be replaced by the version of the file (if it could be obtained via
  750 +# FILE_VERSION_FILTER)
  751 +# The default value is: $file:$line: $text.
  752 +
  753 +WARN_FORMAT = "$file:$line: $text"
  754 +
  755 +# The WARN_LOGFILE tag can be used to specify a file to which warning and error
  756 +# messages should be written. If left blank the output is written to standard
  757 +# error (stderr).
  758 +
  759 +WARN_LOGFILE =
  760 +
  761 +#---------------------------------------------------------------------------
  762 +# Configuration options related to the input files
  763 +#---------------------------------------------------------------------------
  764 +
  765 +# The INPUT tag is used to specify the files and/or directories that contain
  766 +# documented source files. You may enter file names like myfile.cpp or
  767 +# directories like /usr/src/myproject. Separate the files or directories with
  768 +# spaces.
  769 +# Note: If this tag is empty the current directory is searched.
  770 +
  771 +INPUT = ./
  772 +
  773 +# This tag can be used to specify the character encoding of the source files
  774 +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
  775 +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
  776 +# documentation (see: http://www.gnu.org/software/libiconv) for the list of
  777 +# possible encodings.
  778 +# The default value is: UTF-8.
  779 +
  780 +INPUT_ENCODING = UTF-8
  781 +
  782 +# If the value of the INPUT tag contains directories, you can use the
  783 +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
  784 +# *.h) to filter out the source-files in the directories. If left blank the
  785 +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
  786 +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
  787 +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
  788 +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
  789 +# *.qsf, *.as and *.js.
  790 +
  791 +FILE_PATTERNS = *.h \
  792 + *.c \
  793 + *.txt
  794 +
  795 +# The RECURSIVE tag can be used to specify whether or not subdirectories should
  796 +# be searched for input files as well.
  797 +# The default value is: NO.
  798 +
  799 +RECURSIVE = YES
  800 +
  801 +# The EXCLUDE tag can be used to specify files and/or directories that should be
  802 +# excluded from the INPUT source files. This way you can easily exclude a
  803 +# subdirectory from a directory tree whose root is specified with the INPUT tag.
  804 +#
  805 +# Note that relative paths are relative to the directory from which doxygen is
  806 +# run.
  807 +
  808 +EXCLUDE = Documentation/
  809 +
  810 +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
  811 +# directories that are symbolic links (a Unix file system feature) are excluded
  812 +# from the input.
  813 +# The default value is: NO.
  814 +
  815 +EXCLUDE_SYMLINKS = NO
  816 +
  817 +# If the value of the INPUT tag contains directories, you can use the
  818 +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
  819 +# certain files from those directories.
  820 +#
  821 +# Note that the wildcards are matched against the file with absolute path, so to
  822 +# exclude all test directories for example use the pattern */test/*
  823 +
  824 +EXCLUDE_PATTERNS =
  825 +
  826 +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
  827 +# (namespaces, classes, functions, etc.) that should be excluded from the
  828 +# output. The symbol name can be a fully qualified name, a word, or if the
  829 +# wildcard * is used, a substring. Examples: ANamespace, AClass,
  830 +# AClass::ANamespace, ANamespace::*Test
  831 +#
  832 +# Note that the wildcards are matched against the file with absolute path, so to
  833 +# exclude all test directories use the pattern */test/*
  834 +
  835 +EXCLUDE_SYMBOLS = __* \
  836 + INCLUDE_FROM_*
  837 +
  838 +# The EXAMPLE_PATH tag can be used to specify one or more files or directories
  839 +# that contain example code fragments that are included (see the \include
  840 +# command).
  841 +
  842 +EXAMPLE_PATH =
  843 +
  844 +# If the value of the EXAMPLE_PATH tag contains directories, you can use the
  845 +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
  846 +# *.h) to filter out the source-files in the directories. If left blank all
  847 +# files are included.
  848 +
  849 +EXAMPLE_PATTERNS = *
  850 +
  851 +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
  852 +# searched for input files to be used with the \include or \dontinclude commands
  853 +# irrespective of the value of the RECURSIVE tag.
  854 +# The default value is: NO.
  855 +
  856 +EXAMPLE_RECURSIVE = NO
  857 +
  858 +# The IMAGE_PATH tag can be used to specify one or more files or directories
  859 +# that contain images that are to be included in the documentation (see the
  860 +# \image command).
  861 +
  862 +IMAGE_PATH =
  863 +
  864 +# The INPUT_FILTER tag can be used to specify a program that doxygen should
  865 +# invoke to filter for each input file. Doxygen will invoke the filter program
  866 +# by executing (via popen()) the command:
  867 +#
  868 +# <filter> <input-file>
  869 +#
  870 +# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
  871 +# name of an input file. Doxygen will then use the output that the filter
  872 +# program writes to standard output. If FILTER_PATTERNS is specified, this tag
  873 +# will be ignored.
  874 +#
  875 +# Note that the filter must not add or remove lines; it is applied before the
  876 +# code is scanned, but not when the output code is generated. If lines are added
  877 +# or removed, the anchors will not be placed correctly.
  878 +
  879 +INPUT_FILTER =
  880 +
  881 +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
  882 +# basis. Doxygen will compare the file name with each pattern and apply the
  883 +# filter if there is a match. The filters are a list of the form: pattern=filter
  884 +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
  885 +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
  886 +# patterns match the file name, INPUT_FILTER is applied.
  887 +
  888 +FILTER_PATTERNS =
  889 +
  890 +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
  891 +# INPUT_FILTER) will also be used to filter the input files that are used for
  892 +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
  893 +# The default value is: NO.
  894 +
  895 +FILTER_SOURCE_FILES = NO
  896 +
  897 +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
  898 +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
  899 +# it is also possible to disable source filtering for a specific pattern using
  900 +# *.ext= (so without naming a filter).
  901 +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
  902 +
  903 +FILTER_SOURCE_PATTERNS =
  904 +
  905 +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
  906 +# is part of the input, its contents will be placed on the main page
  907 +# (index.html). This can be useful if you have a project on for instance GitHub
  908 +# and want to reuse the introduction page also for the doxygen output.
  909 +
  910 +USE_MDFILE_AS_MAINPAGE =
  911 +
  912 +#---------------------------------------------------------------------------
  913 +# Configuration options related to source browsing
  914 +#---------------------------------------------------------------------------
  915 +
  916 +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
  917 +# generated. Documented entities will be cross-referenced with these sources.
  918 +#
  919 +# Note: To get rid of all source code in the generated output, make sure that
  920 +# also VERBATIM_HEADERS is set to NO.
  921 +# The default value is: NO.
  922 +
  923 +SOURCE_BROWSER = NO
  924 +
  925 +# Setting the INLINE_SOURCES tag to YES will include the body of functions,
  926 +# classes and enums directly into the documentation.
  927 +# The default value is: NO.
  928 +
  929 +INLINE_SOURCES = NO
  930 +
  931 +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
  932 +# special comment blocks from generated source code fragments. Normal C, C++ and
  933 +# Fortran comments will always remain visible.
  934 +# The default value is: YES.
  935 +
  936 +STRIP_CODE_COMMENTS = YES
  937 +
  938 +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
  939 +# function all documented functions referencing it will be listed.
  940 +# The default value is: NO.
  941 +
  942 +REFERENCED_BY_RELATION = NO
  943 +
  944 +# If the REFERENCES_RELATION tag is set to YES then for each documented function
  945 +# all documented entities called/used by that function will be listed.
  946 +# The default value is: NO.
  947 +
  948 +REFERENCES_RELATION = NO
  949 +
  950 +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
  951 +# to YES then the hyperlinks from functions in REFERENCES_RELATION and
  952 +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
  953 +# link to the documentation.
  954 +# The default value is: YES.
  955 +
  956 +REFERENCES_LINK_SOURCE = NO
  957 +
  958 +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
  959 +# source code will show a tooltip with additional information such as prototype,
  960 +# brief description and links to the definition and documentation. Since this
  961 +# will make the HTML file larger and loading of large files a bit slower, you
  962 +# can opt to disable this feature.
  963 +# The default value is: YES.
  964 +# This tag requires that the tag SOURCE_BROWSER is set to YES.
  965 +
  966 +SOURCE_TOOLTIPS = YES
  967 +
  968 +# If the USE_HTAGS tag is set to YES then the references to source code will
  969 +# point to the HTML generated by the htags(1) tool instead of doxygen built-in
  970 +# source browser. The htags tool is part of GNU's global source tagging system
  971 +# (see http://www.gnu.org/software/global/global.html). You will need version
  972 +# 4.8.6 or higher.
  973 +#
  974 +# To use it do the following:
  975 +# - Install the latest version of global
  976 +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
  977 +# - Make sure the INPUT points to the root of the source tree
  978 +# - Run doxygen as normal
  979 +#
  980 +# Doxygen will invoke htags (and that will in turn invoke gtags), so these
  981 +# tools must be available from the command line (i.e. in the search path).
  982 +#
  983 +# The result: instead of the source browser generated by doxygen, the links to
  984 +# source code will now point to the output of htags.
  985 +# The default value is: NO.
  986 +# This tag requires that the tag SOURCE_BROWSER is set to YES.
  987 +
  988 +USE_HTAGS = NO
  989 +
  990 +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
  991 +# verbatim copy of the header file for each class for which an include is
  992 +# specified. Set to NO to disable this.
  993 +# See also: Section \class.
  994 +# The default value is: YES.
  995 +
  996 +VERBATIM_HEADERS = NO
  997 +
  998 +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
  999 +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
  1000 +# cost of reduced performance. This can be particularly helpful with template
  1001 +# rich C++ code for which doxygen's built-in parser lacks the necessary type
  1002 +# information.
  1003 +# Note: The availability of this option depends on whether or not doxygen was
  1004 +# compiled with the --with-libclang option.
  1005 +# The default value is: NO.
  1006 +
  1007 +CLANG_ASSISTED_PARSING = NO
  1008 +
  1009 +# If clang assisted parsing is enabled you can provide the compiler with command
  1010 +# line options that you would normally use when invoking the compiler. Note that
  1011 +# the include paths will already be set by doxygen for the files and directories
  1012 +# specified with INPUT and INCLUDE_PATH.
  1013 +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
  1014 +
  1015 +CLANG_OPTIONS =
  1016 +
  1017 +#---------------------------------------------------------------------------
  1018 +# Configuration options related to the alphabetical class index
  1019 +#---------------------------------------------------------------------------
  1020 +
  1021 +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
  1022 +# compounds will be generated. Enable this if the project contains a lot of
  1023 +# classes, structs, unions or interfaces.
  1024 +# The default value is: YES.
  1025 +
  1026 +ALPHABETICAL_INDEX = YES
  1027 +
  1028 +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
  1029 +# which the alphabetical index list will be split.
  1030 +# Minimum value: 1, maximum value: 20, default value: 5.
  1031 +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
  1032 +
  1033 +COLS_IN_ALPHA_INDEX = 5
  1034 +
  1035 +# In case all classes in a project start with a common prefix, all classes will
  1036 +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
  1037 +# can be used to specify a prefix (or a list of prefixes) that should be ignored
  1038 +# while generating the index headers.
  1039 +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
  1040 +
  1041 +IGNORE_PREFIX =
  1042 +
  1043 +#---------------------------------------------------------------------------
  1044 +# Configuration options related to the HTML output
  1045 +#---------------------------------------------------------------------------
  1046 +
  1047 +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
  1048 +# The default value is: YES.
  1049 +
  1050 +GENERATE_HTML = YES
  1051 +
  1052 +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
  1053 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1054 +# it.
  1055 +# The default directory is: html.
  1056 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1057 +
  1058 +HTML_OUTPUT = html
  1059 +
  1060 +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
  1061 +# generated HTML page (for example: .htm, .php, .asp).
  1062 +# The default value is: .html.
  1063 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1064 +
  1065 +HTML_FILE_EXTENSION = .html
  1066 +
  1067 +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
  1068 +# each generated HTML page. If the tag is left blank doxygen will generate a
  1069 +# standard header.
  1070 +#
  1071 +# To get valid HTML the header file that includes any scripts and style sheets
  1072 +# that doxygen needs, which is dependent on the configuration options used (e.g.
  1073 +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
  1074 +# default header using
  1075 +# doxygen -w html new_header.html new_footer.html new_stylesheet.css
  1076 +# YourConfigFile
  1077 +# and then modify the file new_header.html. See also section "Doxygen usage"
  1078 +# for information on how to generate the default header that doxygen normally
  1079 +# uses.
  1080 +# Note: The header is subject to change so you typically have to regenerate the
  1081 +# default header when upgrading to a newer version of doxygen. For a description
  1082 +# of the possible markers and block names see the documentation.
  1083 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1084 +
  1085 +HTML_HEADER =
  1086 +
  1087 +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
  1088 +# generated HTML page. If the tag is left blank doxygen will generate a standard
  1089 +# footer. See HTML_HEADER for more information on how to generate a default
  1090 +# footer and what special commands can be used inside the footer. See also
  1091 +# section "Doxygen usage" for information on how to generate the default footer
  1092 +# that doxygen normally uses.
  1093 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1094 +
  1095 +HTML_FOOTER =
  1096 +
  1097 +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
  1098 +# sheet that is used by each HTML page. It can be used to fine-tune the look of
  1099 +# the HTML output. If left blank doxygen will generate a default style sheet.
  1100 +# See also section "Doxygen usage" for information on how to generate the style
  1101 +# sheet that doxygen normally uses.
  1102 +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
  1103 +# it is more robust and this tag (HTML_STYLESHEET) will in the future become
  1104 +# obsolete.
  1105 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1106 +
  1107 +HTML_STYLESHEET =
  1108 +
  1109 +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
  1110 +# cascading style sheets that are included after the standard style sheets
  1111 +# created by doxygen. Using this option one can overrule certain style aspects.
  1112 +# This is preferred over using HTML_STYLESHEET since it does not replace the
  1113 +# standard style sheet and is therefore more robust against future updates.
  1114 +# Doxygen will copy the style sheet files to the output directory.
  1115 +# Note: The order of the extra style sheet files is of importance (e.g. the last
  1116 +# style sheet in the list overrules the setting of the previous ones in the
  1117 +# list). For an example see the documentation.
  1118 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1119 +
  1120 +HTML_EXTRA_STYLESHEET =
  1121 +
  1122 +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
  1123 +# other source files which should be copied to the HTML output directory. Note
  1124 +# that these files will be copied to the base HTML output directory. Use the
  1125 +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
  1126 +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
  1127 +# files will be copied as-is; there are no commands or markers available.
  1128 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1129 +
  1130 +HTML_EXTRA_FILES =
  1131 +
  1132 +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
  1133 +# will adjust the colors in the style sheet and background images according to
  1134 +# this color. Hue is specified as an angle on a colorwheel, see
  1135 +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
  1136 +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
  1137 +# purple, and 360 is red again.
  1138 +# Minimum value: 0, maximum value: 359, default value: 220.
  1139 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1140 +
  1141 +HTML_COLORSTYLE_HUE = 220
  1142 +
  1143 +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
  1144 +# in the HTML output. For a value of 0 the output will use grayscales only. A
  1145 +# value of 255 will produce the most vivid colors.
  1146 +# Minimum value: 0, maximum value: 255, default value: 100.
  1147 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1148 +
  1149 +HTML_COLORSTYLE_SAT = 100
  1150 +
  1151 +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
  1152 +# luminance component of the colors in the HTML output. Values below 100
  1153 +# gradually make the output lighter, whereas values above 100 make the output
  1154 +# darker. The value divided by 100 is the actual gamma applied, so 80 represents
  1155 +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
  1156 +# change the gamma.
  1157 +# Minimum value: 40, maximum value: 240, default value: 80.
  1158 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1159 +
  1160 +HTML_COLORSTYLE_GAMMA = 80
  1161 +
  1162 +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
  1163 +# page will contain the date and time when the page was generated. Setting this
  1164 +# to NO can help when comparing the output of multiple runs.
  1165 +# The default value is: YES.
  1166 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1167 +
  1168 +HTML_TIMESTAMP = NO
  1169 +
  1170 +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
  1171 +# documentation will contain sections that can be hidden and shown after the
  1172 +# page has loaded.
  1173 +# The default value is: NO.
  1174 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1175 +
  1176 +HTML_DYNAMIC_SECTIONS = YES
  1177 +
  1178 +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
  1179 +# shown in the various tree structured indices initially; the user can expand
  1180 +# and collapse entries dynamically later on. Doxygen will expand the tree to
  1181 +# such a level that at most the specified number of entries are visible (unless
  1182 +# a fully collapsed tree already exceeds this amount). So setting the number of
  1183 +# entries 1 will produce a full collapsed tree by default. 0 is a special value
  1184 +# representing an infinite number of entries and will result in a full expanded
  1185 +# tree by default.
  1186 +# Minimum value: 0, maximum value: 9999, default value: 100.
  1187 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1188 +
  1189 +HTML_INDEX_NUM_ENTRIES = 100
  1190 +
  1191 +# If the GENERATE_DOCSET tag is set to YES, additional index files will be
  1192 +# generated that can be used as input for Apple's Xcode 3 integrated development
  1193 +# environment (see: http://developer.apple.com/tools/xcode/), introduced with
  1194 +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
  1195 +# Makefile in the HTML output directory. Running make will produce the docset in
  1196 +# that directory and running make install will install the docset in
  1197 +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
  1198 +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
  1199 +# for more information.
  1200 +# The default value is: NO.
  1201 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1202 +
  1203 +GENERATE_DOCSET = NO
  1204 +
  1205 +# This tag determines the name of the docset feed. A documentation feed provides
  1206 +# an umbrella under which multiple documentation sets from a single provider
  1207 +# (such as a company or product suite) can be grouped.
  1208 +# The default value is: Doxygen generated docs.
  1209 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
  1210 +
  1211 +DOCSET_FEEDNAME = "Doxygen generated docs"
  1212 +
  1213 +# This tag specifies a string that should uniquely identify the documentation
  1214 +# set bundle. This should be a reverse domain-name style string, e.g.
  1215 +# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
  1216 +# The default value is: org.doxygen.Project.
  1217 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
  1218 +
  1219 +DOCSET_BUNDLE_ID = org.doxygen.Project
  1220 +
  1221 +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
  1222 +# the documentation publisher. This should be a reverse domain-name style
  1223 +# string, e.g. com.mycompany.MyDocSet.documentation.
  1224 +# The default value is: org.doxygen.Publisher.
  1225 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
  1226 +
  1227 +DOCSET_PUBLISHER_ID = org.doxygen.Publisher
  1228 +
  1229 +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
  1230 +# The default value is: Publisher.
  1231 +# This tag requires that the tag GENERATE_DOCSET is set to YES.
  1232 +
  1233 +DOCSET_PUBLISHER_NAME = Publisher
  1234 +
  1235 +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
  1236 +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
  1237 +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
  1238 +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
  1239 +# Windows.
  1240 +#
  1241 +# The HTML Help Workshop contains a compiler that can convert all HTML output
  1242 +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
  1243 +# files are now used as the Windows 98 help format, and will replace the old
  1244 +# Windows help format (.hlp) on all Windows platforms in the future. Compressed
  1245 +# HTML files also contain an index, a table of contents, and you can search for
  1246 +# words in the documentation. The HTML workshop also contains a viewer for
  1247 +# compressed HTML files.
  1248 +# The default value is: NO.
  1249 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1250 +
  1251 +GENERATE_HTMLHELP = NO
  1252 +
  1253 +# The CHM_FILE tag can be used to specify the file name of the resulting .chm
  1254 +# file. You can add a path in front of the file if the result should not be
  1255 +# written to the html output directory.
  1256 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1257 +
  1258 +CHM_FILE =
  1259 +
  1260 +# The HHC_LOCATION tag can be used to specify the location (absolute path
  1261 +# including file name) of the HTML help compiler (hhc.exe). If non-empty,
  1262 +# doxygen will try to run the HTML help compiler on the generated index.hhp.
  1263 +# The file has to be specified with full path.
  1264 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1265 +
  1266 +HHC_LOCATION =
  1267 +
  1268 +# The GENERATE_CHI flag controls if a separate .chi index file is generated
  1269 +# (YES) or that it should be included in the master .chm file (NO).
  1270 +# The default value is: NO.
  1271 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1272 +
  1273 +GENERATE_CHI = NO
  1274 +
  1275 +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
  1276 +# and project file content.
  1277 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1278 +
  1279 +CHM_INDEX_ENCODING =
  1280 +
  1281 +# The BINARY_TOC flag controls whether a binary table of contents is generated
  1282 +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
  1283 +# enables the Previous and Next buttons.
  1284 +# The default value is: NO.
  1285 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1286 +
  1287 +BINARY_TOC = NO
  1288 +
  1289 +# The TOC_EXPAND flag can be set to YES to add extra items for group members to
  1290 +# the table of contents of the HTML help documentation and to the tree view.
  1291 +# The default value is: NO.
  1292 +# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
  1293 +
  1294 +TOC_EXPAND = YES
  1295 +
  1296 +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
  1297 +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
  1298 +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
  1299 +# (.qch) of the generated HTML documentation.
  1300 +# The default value is: NO.
  1301 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1302 +
  1303 +GENERATE_QHP = NO
  1304 +
  1305 +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
  1306 +# the file name of the resulting .qch file. The path specified is relative to
  1307 +# the HTML output folder.
  1308 +# This tag requires that the tag GENERATE_QHP is set to YES.
  1309 +
  1310 +QCH_FILE =
  1311 +
  1312 +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
  1313 +# Project output. For more information please see Qt Help Project / Namespace
  1314 +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
  1315 +# The default value is: org.doxygen.Project.
  1316 +# This tag requires that the tag GENERATE_QHP is set to YES.
  1317 +
  1318 +QHP_NAMESPACE = org.doxygen.Project
  1319 +
  1320 +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
  1321 +# Help Project output. For more information please see Qt Help Project / Virtual
  1322 +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
  1323 +# folders).
  1324 +# The default value is: doc.
  1325 +# This tag requires that the tag GENERATE_QHP is set to YES.
  1326 +
  1327 +QHP_VIRTUAL_FOLDER = doc
  1328 +
  1329 +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
  1330 +# filter to add. For more information please see Qt Help Project / Custom
  1331 +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  1332 +# filters).
  1333 +# This tag requires that the tag GENERATE_QHP is set to YES.
  1334 +
  1335 +QHP_CUST_FILTER_NAME =
  1336 +
  1337 +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
  1338 +# custom filter to add. For more information please see Qt Help Project / Custom
  1339 +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
  1340 +# filters).
  1341 +# This tag requires that the tag GENERATE_QHP is set to YES.
  1342 +
  1343 +QHP_CUST_FILTER_ATTRS =
  1344 +
  1345 +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
  1346 +# project's filter section matches. Qt Help Project / Filter Attributes (see:
  1347 +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
  1348 +# This tag requires that the tag GENERATE_QHP is set to YES.
  1349 +
  1350 +QHP_SECT_FILTER_ATTRS =
  1351 +
  1352 +# The QHG_LOCATION tag can be used to specify the location of Qt's
  1353 +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
  1354 +# generated .qhp file.
  1355 +# This tag requires that the tag GENERATE_QHP is set to YES.
  1356 +
  1357 +QHG_LOCATION =
  1358 +
  1359 +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
  1360 +# generated, together with the HTML files, they form an Eclipse help plugin. To
  1361 +# install this plugin and make it available under the help contents menu in
  1362 +# Eclipse, the contents of the directory containing the HTML and XML files needs
  1363 +# to be copied into the plugins directory of eclipse. The name of the directory
  1364 +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
  1365 +# After copying Eclipse needs to be restarted before the help appears.
  1366 +# The default value is: NO.
  1367 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1368 +
  1369 +GENERATE_ECLIPSEHELP = NO
  1370 +
  1371 +# A unique identifier for the Eclipse help plugin. When installing the plugin
  1372 +# the directory name containing the HTML and XML files should also have this
  1373 +# name. Each documentation set should have its own identifier.
  1374 +# The default value is: org.doxygen.Project.
  1375 +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
  1376 +
  1377 +ECLIPSE_DOC_ID = org.doxygen.Project
  1378 +
  1379 +# If you want full control over the layout of the generated HTML pages it might
  1380 +# be necessary to disable the index and replace it with your own. The
  1381 +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
  1382 +# of each HTML page. A value of NO enables the index and the value YES disables
  1383 +# it. Since the tabs in the index contain the same information as the navigation
  1384 +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
  1385 +# The default value is: NO.
  1386 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1387 +
  1388 +DISABLE_INDEX = YES
  1389 +
  1390 +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
  1391 +# structure should be generated to display hierarchical information. If the tag
  1392 +# value is set to YES, a side panel will be generated containing a tree-like
  1393 +# index structure (just like the one that is generated for HTML Help). For this
  1394 +# to work a browser that supports JavaScript, DHTML, CSS and frames is required
  1395 +# (i.e. any modern browser). Windows users are probably better off using the
  1396 +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
  1397 +# further fine-tune the look of the index. As an example, the default style
  1398 +# sheet generated by doxygen has an example that shows how to put an image at
  1399 +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
  1400 +# the same information as the tab index, you could consider setting
  1401 +# DISABLE_INDEX to YES when enabling this option.
  1402 +# The default value is: NO.
  1403 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1404 +
  1405 +GENERATE_TREEVIEW = YES
  1406 +
  1407 +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
  1408 +# doxygen will group on one line in the generated HTML documentation.
  1409 +#
  1410 +# Note that a value of 0 will completely suppress the enum values from appearing
  1411 +# in the overview section.
  1412 +# Minimum value: 0, maximum value: 20, default value: 4.
  1413 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1414 +
  1415 +ENUM_VALUES_PER_LINE = 1
  1416 +
  1417 +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
  1418 +# to set the initial width (in pixels) of the frame in which the tree is shown.
  1419 +# Minimum value: 0, maximum value: 1500, default value: 250.
  1420 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1421 +
  1422 +TREEVIEW_WIDTH = 250
  1423 +
  1424 +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
  1425 +# external symbols imported via tag files in a separate window.
  1426 +# The default value is: NO.
  1427 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1428 +
  1429 +EXT_LINKS_IN_WINDOW = NO
  1430 +
  1431 +# Use this tag to change the font size of LaTeX formulas included as images in
  1432 +# the HTML documentation. When you change the font size after a successful
  1433 +# doxygen run you need to manually remove any form_*.png images from the HTML
  1434 +# output directory to force them to be regenerated.
  1435 +# Minimum value: 8, maximum value: 50, default value: 10.
  1436 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1437 +
  1438 +FORMULA_FONTSIZE = 10
  1439 +
  1440 +# Use the FORMULA_TRANPARENT tag to determine whether or not the images
  1441 +# generated for formulas are transparent PNGs. Transparent PNGs are not
  1442 +# supported properly for IE 6.0, but are supported on all modern browsers.
  1443 +#
  1444 +# Note that when changing this option you need to delete any form_*.png files in
  1445 +# the HTML output directory before the changes have effect.
  1446 +# The default value is: YES.
  1447 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1448 +
  1449 +FORMULA_TRANSPARENT = YES
  1450 +
  1451 +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
  1452 +# http://www.mathjax.org) which uses client side Javascript for the rendering
  1453 +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
  1454 +# installed or if you want to formulas look prettier in the HTML output. When
  1455 +# enabled you may also need to install MathJax separately and configure the path
  1456 +# to it using the MATHJAX_RELPATH option.
  1457 +# The default value is: NO.
  1458 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1459 +
  1460 +USE_MATHJAX = NO
  1461 +
  1462 +# When MathJax is enabled you can set the default output format to be used for
  1463 +# the MathJax output. See the MathJax site (see:
  1464 +# http://docs.mathjax.org/en/latest/output.html) for more details.
  1465 +# Possible values are: HTML-CSS (which is slower, but has the best
  1466 +# compatibility), NativeMML (i.e. MathML) and SVG.
  1467 +# The default value is: HTML-CSS.
  1468 +# This tag requires that the tag USE_MATHJAX is set to YES.
  1469 +
  1470 +MATHJAX_FORMAT = HTML-CSS
  1471 +
  1472 +# When MathJax is enabled you need to specify the location relative to the HTML
  1473 +# output directory using the MATHJAX_RELPATH option. The destination directory
  1474 +# should contain the MathJax.js script. For instance, if the mathjax directory
  1475 +# is located at the same level as the HTML output directory, then
  1476 +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
  1477 +# Content Delivery Network so you can quickly see the result without installing
  1478 +# MathJax. However, it is strongly recommended to install a local copy of
  1479 +# MathJax from http://www.mathjax.org before deployment.
  1480 +# The default value is: http://cdn.mathjax.org/mathjax/latest.
  1481 +# This tag requires that the tag USE_MATHJAX is set to YES.
  1482 +
  1483 +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
  1484 +
  1485 +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
  1486 +# extension names that should be enabled during MathJax rendering. For example
  1487 +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
  1488 +# This tag requires that the tag USE_MATHJAX is set to YES.
  1489 +
  1490 +MATHJAX_EXTENSIONS =
  1491 +
  1492 +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
  1493 +# of code that will be used on startup of the MathJax code. See the MathJax site
  1494 +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
  1495 +# example see the documentation.
  1496 +# This tag requires that the tag USE_MATHJAX is set to YES.
  1497 +
  1498 +MATHJAX_CODEFILE =
  1499 +
  1500 +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
  1501 +# the HTML output. The underlying search engine uses javascript and DHTML and
  1502 +# should work on any modern browser. Note that when using HTML help
  1503 +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
  1504 +# there is already a search function so this one should typically be disabled.
  1505 +# For large projects the javascript based search engine can be slow, then
  1506 +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
  1507 +# search using the keyboard; to jump to the search box use <access key> + S
  1508 +# (what the <access key> is depends on the OS and browser, but it is typically
  1509 +# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
  1510 +# key> to jump into the search results window, the results can be navigated
  1511 +# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
  1512 +# the search. The filter options can be selected when the cursor is inside the
  1513 +# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
  1514 +# to select a filter and <Enter> or <escape> to activate or cancel the filter
  1515 +# option.
  1516 +# The default value is: YES.
  1517 +# This tag requires that the tag GENERATE_HTML is set to YES.
  1518 +
  1519 +SEARCHENGINE = NO
  1520 +
  1521 +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
  1522 +# implemented using a web server instead of a web client using Javascript. There
  1523 +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
  1524 +# setting. When disabled, doxygen will generate a PHP script for searching and
  1525 +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
  1526 +# and searching needs to be provided by external tools. See the section
  1527 +# "External Indexing and Searching" for details.
  1528 +# The default value is: NO.
  1529 +# This tag requires that the tag SEARCHENGINE is set to YES.
  1530 +
  1531 +SERVER_BASED_SEARCH = NO
  1532 +
  1533 +# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
  1534 +# script for searching. Instead the search results are written to an XML file
  1535 +# which needs to be processed by an external indexer. Doxygen will invoke an
  1536 +# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
  1537 +# search results.
  1538 +#
  1539 +# Doxygen ships with an example indexer (doxyindexer) and search engine
  1540 +# (doxysearch.cgi) which are based on the open source search engine library
  1541 +# Xapian (see: http://xapian.org/).
  1542 +#
  1543 +# See the section "External Indexing and Searching" for details.
  1544 +# The default value is: NO.
  1545 +# This tag requires that the tag SEARCHENGINE is set to YES.
  1546 +
  1547 +EXTERNAL_SEARCH = NO
  1548 +
  1549 +# The SEARCHENGINE_URL should point to a search engine hosted by a web server
  1550 +# which will return the search results when EXTERNAL_SEARCH is enabled.
  1551 +#
  1552 +# Doxygen ships with an example indexer (doxyindexer) and search engine
  1553 +# (doxysearch.cgi) which are based on the open source search engine library
  1554 +# Xapian (see: http://xapian.org/). See the section "External Indexing and
  1555 +# Searching" for details.
  1556 +# This tag requires that the tag SEARCHENGINE is set to YES.
  1557 +
  1558 +SEARCHENGINE_URL =
  1559 +
  1560 +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
  1561 +# search data is written to a file for indexing by an external tool. With the
  1562 +# SEARCHDATA_FILE tag the name of this file can be specified.
  1563 +# The default file is: searchdata.xml.
  1564 +# This tag requires that the tag SEARCHENGINE is set to YES.
  1565 +
  1566 +SEARCHDATA_FILE = searchdata.xml
  1567 +
  1568 +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
  1569 +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
  1570 +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
  1571 +# projects and redirect the results back to the right project.
  1572 +# This tag requires that the tag SEARCHENGINE is set to YES.
  1573 +
  1574 +EXTERNAL_SEARCH_ID =
  1575 +
  1576 +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
  1577 +# projects other than the one defined by this configuration file, but that are
  1578 +# all added to the same external search index. Each project needs to have a
  1579 +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
  1580 +# to a relative location where the documentation can be found. The format is:
  1581 +# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
  1582 +# This tag requires that the tag SEARCHENGINE is set to YES.
  1583 +
  1584 +EXTRA_SEARCH_MAPPINGS =
  1585 +
  1586 +#---------------------------------------------------------------------------
  1587 +# Configuration options related to the LaTeX output
  1588 +#---------------------------------------------------------------------------
  1589 +
  1590 +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
  1591 +# The default value is: YES.
  1592 +
  1593 +GENERATE_LATEX = NO
  1594 +
  1595 +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
  1596 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1597 +# it.
  1598 +# The default directory is: latex.
  1599 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1600 +
  1601 +LATEX_OUTPUT = latex
  1602 +
  1603 +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
  1604 +# invoked.
  1605 +#
  1606 +# Note that when enabling USE_PDFLATEX this option is only used for generating
  1607 +# bitmaps for formulas in the HTML output, but not in the Makefile that is
  1608 +# written to the output directory.
  1609 +# The default file is: latex.
  1610 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1611 +
  1612 +LATEX_CMD_NAME = latex
  1613 +
  1614 +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
  1615 +# index for LaTeX.
  1616 +# The default file is: makeindex.
  1617 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1618 +
  1619 +MAKEINDEX_CMD_NAME = makeindex
  1620 +
  1621 +# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
  1622 +# documents. This may be useful for small projects and may help to save some
  1623 +# trees in general.
  1624 +# The default value is: NO.
  1625 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1626 +
  1627 +COMPACT_LATEX = NO
  1628 +
  1629 +# The PAPER_TYPE tag can be used to set the paper type that is used by the
  1630 +# printer.
  1631 +# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
  1632 +# 14 inches) and executive (7.25 x 10.5 inches).
  1633 +# The default value is: a4.
  1634 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1635 +
  1636 +PAPER_TYPE = a4wide
  1637 +
  1638 +# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
  1639 +# that should be included in the LaTeX output. To get the times font for
  1640 +# instance you can specify
  1641 +# EXTRA_PACKAGES=times
  1642 +# If left blank no extra packages will be included.
  1643 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1644 +
  1645 +EXTRA_PACKAGES =
  1646 +
  1647 +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
  1648 +# generated LaTeX document. The header should contain everything until the first
  1649 +# chapter. If it is left blank doxygen will generate a standard header. See
  1650 +# section "Doxygen usage" for information on how to let doxygen write the
  1651 +# default header to a separate file.
  1652 +#
  1653 +# Note: Only use a user-defined header if you know what you are doing! The
  1654 +# following commands have a special meaning inside the header: $title,
  1655 +# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
  1656 +# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
  1657 +# string, for the replacement values of the other commands the user is referred
  1658 +# to HTML_HEADER.
  1659 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1660 +
  1661 +LATEX_HEADER =
  1662 +
  1663 +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
  1664 +# generated LaTeX document. The footer should contain everything after the last
  1665 +# chapter. If it is left blank doxygen will generate a standard footer. See
  1666 +# LATEX_HEADER for more information on how to generate a default footer and what
  1667 +# special commands can be used inside the footer.
  1668 +#
  1669 +# Note: Only use a user-defined footer if you know what you are doing!
  1670 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1671 +
  1672 +LATEX_FOOTER =
  1673 +
  1674 +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
  1675 +# LaTeX style sheets that are included after the standard style sheets created
  1676 +# by doxygen. Using this option one can overrule certain style aspects. Doxygen
  1677 +# will copy the style sheet files to the output directory.
  1678 +# Note: The order of the extra style sheet files is of importance (e.g. the last
  1679 +# style sheet in the list overrules the setting of the previous ones in the
  1680 +# list).
  1681 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1682 +
  1683 +LATEX_EXTRA_STYLESHEET =
  1684 +
  1685 +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
  1686 +# other source files which should be copied to the LATEX_OUTPUT output
  1687 +# directory. Note that the files will be copied as-is; there are no commands or
  1688 +# markers available.
  1689 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1690 +
  1691 +LATEX_EXTRA_FILES =
  1692 +
  1693 +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
  1694 +# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
  1695 +# contain links (just like the HTML output) instead of page references. This
  1696 +# makes the output suitable for online browsing using a PDF viewer.
  1697 +# The default value is: YES.
  1698 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1699 +
  1700 +PDF_HYPERLINKS = YES
  1701 +
  1702 +# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
  1703 +# the PDF file directly from the LaTeX files. Set this option to YES, to get a
  1704 +# higher quality PDF documentation.
  1705 +# The default value is: YES.
  1706 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1707 +
  1708 +USE_PDFLATEX = YES
  1709 +
  1710 +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
  1711 +# command to the generated LaTeX files. This will instruct LaTeX to keep running
  1712 +# if errors occur, instead of asking the user for help. This option is also used
  1713 +# when generating formulas in HTML.
  1714 +# The default value is: NO.
  1715 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1716 +
  1717 +LATEX_BATCHMODE = NO
  1718 +
  1719 +# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
  1720 +# index chapters (such as File Index, Compound Index, etc.) in the output.
  1721 +# The default value is: NO.
  1722 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1723 +
  1724 +LATEX_HIDE_INDICES = NO
  1725 +
  1726 +# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
  1727 +# code with syntax highlighting in the LaTeX output.
  1728 +#
  1729 +# Note that which sources are shown also depends on other settings such as
  1730 +# SOURCE_BROWSER.
  1731 +# The default value is: NO.
  1732 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1733 +
  1734 +LATEX_SOURCE_CODE = NO
  1735 +
  1736 +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
  1737 +# bibliography, e.g. plainnat, or ieeetr. See
  1738 +# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
  1739 +# The default value is: plain.
  1740 +# This tag requires that the tag GENERATE_LATEX is set to YES.
  1741 +
  1742 +LATEX_BIB_STYLE = plain
  1743 +
  1744 +#---------------------------------------------------------------------------
  1745 +# Configuration options related to the RTF output
  1746 +#---------------------------------------------------------------------------
  1747 +
  1748 +# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
  1749 +# RTF output is optimized for Word 97 and may not look too pretty with other RTF
  1750 +# readers/editors.
  1751 +# The default value is: NO.
  1752 +
  1753 +GENERATE_RTF = NO
  1754 +
  1755 +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
  1756 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1757 +# it.
  1758 +# The default directory is: rtf.
  1759 +# This tag requires that the tag GENERATE_RTF is set to YES.
  1760 +
  1761 +RTF_OUTPUT = rtf
  1762 +
  1763 +# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
  1764 +# documents. This may be useful for small projects and may help to save some
  1765 +# trees in general.
  1766 +# The default value is: NO.
  1767 +# This tag requires that the tag GENERATE_RTF is set to YES.
  1768 +
  1769 +COMPACT_RTF = NO
  1770 +
  1771 +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
  1772 +# contain hyperlink fields. The RTF file will contain links (just like the HTML
  1773 +# output) instead of page references. This makes the output suitable for online
  1774 +# browsing using Word or some other Word compatible readers that support those
  1775 +# fields.
  1776 +#
  1777 +# Note: WordPad (write) and others do not support links.
  1778 +# The default value is: NO.
  1779 +# This tag requires that the tag GENERATE_RTF is set to YES.
  1780 +
  1781 +RTF_HYPERLINKS = NO
  1782 +
  1783 +# Load stylesheet definitions from file. Syntax is similar to doxygen's config
  1784 +# file, i.e. a series of assignments. You only have to provide replacements,
  1785 +# missing definitions are set to their default value.
  1786 +#
  1787 +# See also section "Doxygen usage" for information on how to generate the
  1788 +# default style sheet that doxygen normally uses.
  1789 +# This tag requires that the tag GENERATE_RTF is set to YES.
  1790 +
  1791 +RTF_STYLESHEET_FILE =
  1792 +
  1793 +# Set optional variables used in the generation of an RTF document. Syntax is
  1794 +# similar to doxygen's config file. A template extensions file can be generated
  1795 +# using doxygen -e rtf extensionFile.
  1796 +# This tag requires that the tag GENERATE_RTF is set to YES.
  1797 +
  1798 +RTF_EXTENSIONS_FILE =
  1799 +
  1800 +# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
  1801 +# with syntax highlighting in the RTF output.
  1802 +#
  1803 +# Note that which sources are shown also depends on other settings such as
  1804 +# SOURCE_BROWSER.
  1805 +# The default value is: NO.
  1806 +# This tag requires that the tag GENERATE_RTF is set to YES.
  1807 +
  1808 +RTF_SOURCE_CODE = NO
  1809 +
  1810 +#---------------------------------------------------------------------------
  1811 +# Configuration options related to the man page output
  1812 +#---------------------------------------------------------------------------
  1813 +
  1814 +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
  1815 +# classes and files.
  1816 +# The default value is: NO.
  1817 +
  1818 +GENERATE_MAN = NO
  1819 +
  1820 +# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
  1821 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1822 +# it. A directory man3 will be created inside the directory specified by
  1823 +# MAN_OUTPUT.
  1824 +# The default directory is: man.
  1825 +# This tag requires that the tag GENERATE_MAN is set to YES.
  1826 +
  1827 +MAN_OUTPUT = man
  1828 +
  1829 +# The MAN_EXTENSION tag determines the extension that is added to the generated
  1830 +# man pages. In case the manual section does not start with a number, the number
  1831 +# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
  1832 +# optional.
  1833 +# The default value is: .3.
  1834 +# This tag requires that the tag GENERATE_MAN is set to YES.
  1835 +
  1836 +MAN_EXTENSION = .3
  1837 +
  1838 +# The MAN_SUBDIR tag determines the name of the directory created within
  1839 +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
  1840 +# MAN_EXTENSION with the initial . removed.
  1841 +# This tag requires that the tag GENERATE_MAN is set to YES.
  1842 +
  1843 +MAN_SUBDIR =
  1844 +
  1845 +# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
  1846 +# will generate one additional man file for each entity documented in the real
  1847 +# man page(s). These additional files only source the real man page, but without
  1848 +# them the man command would be unable to find the correct page.
  1849 +# The default value is: NO.
  1850 +# This tag requires that the tag GENERATE_MAN is set to YES.
  1851 +
  1852 +MAN_LINKS = NO
  1853 +
  1854 +#---------------------------------------------------------------------------
  1855 +# Configuration options related to the XML output
  1856 +#---------------------------------------------------------------------------
  1857 +
  1858 +# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
  1859 +# captures the structure of the code including all documentation.
  1860 +# The default value is: NO.
  1861 +
  1862 +GENERATE_XML = NO
  1863 +
  1864 +# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
  1865 +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
  1866 +# it.
  1867 +# The default directory is: xml.
  1868 +# This tag requires that the tag GENERATE_XML is set to YES.
  1869 +
  1870 +XML_OUTPUT = xml
  1871 +
  1872 +# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
  1873 +# listings (including syntax highlighting and cross-referencing information) to
  1874 +# the XML output. Note that enabling this will significantly increase the size
  1875 +# of the XML output.
  1876 +# The default value is: YES.
  1877 +# This tag requires that the tag GENERATE_XML is set to YES.
  1878 +
  1879 +XML_PROGRAMLISTING = YES
  1880 +
  1881 +#---------------------------------------------------------------------------
  1882 +# Configuration options related to the DOCBOOK output
  1883 +#---------------------------------------------------------------------------
  1884 +
  1885 +# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
  1886 +# that can be used to generate PDF.
  1887 +# The default value is: NO.
  1888 +
  1889 +GENERATE_DOCBOOK = NO
  1890 +
  1891 +# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
  1892 +# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
  1893 +# front of it.
  1894 +# The default directory is: docbook.
  1895 +# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
  1896 +
  1897 +DOCBOOK_OUTPUT = docbook
  1898 +
  1899 +# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
  1900 +# program listings (including syntax highlighting and cross-referencing
  1901 +# information) to the DOCBOOK output. Note that enabling this will significantly
  1902 +# increase the size of the DOCBOOK output.
  1903 +# The default value is: NO.
  1904 +# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
  1905 +
  1906 +DOCBOOK_PROGRAMLISTING = NO
  1907 +
  1908 +#---------------------------------------------------------------------------
  1909 +# Configuration options for the AutoGen Definitions output
  1910 +#---------------------------------------------------------------------------
  1911 +
  1912 +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
  1913 +# AutoGen Definitions (see http://autogen.sf.net) file that captures the
  1914 +# structure of the code including all documentation. Note that this feature is
  1915 +# still experimental and incomplete at the moment.
  1916 +# The default value is: NO.
  1917 +
  1918 +GENERATE_AUTOGEN_DEF = NO
  1919 +
  1920 +#---------------------------------------------------------------------------
  1921 +# Configuration options related to the Perl module output
  1922 +#---------------------------------------------------------------------------
  1923 +
  1924 +# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
  1925 +# file that captures the structure of the code including all documentation.
  1926 +#
  1927 +# Note that this feature is still experimental and incomplete at the moment.
  1928 +# The default value is: NO.
  1929 +
  1930 +GENERATE_PERLMOD = NO
  1931 +
  1932 +# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
  1933 +# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
  1934 +# output from the Perl module output.
  1935 +# The default value is: NO.
  1936 +# This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1937 +
  1938 +PERLMOD_LATEX = NO
  1939 +
  1940 +# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
  1941 +# formatted so it can be parsed by a human reader. This is useful if you want to
  1942 +# understand what is going on. On the other hand, if this tag is set to NO, the
  1943 +# size of the Perl module output will be much smaller and Perl will parse it
  1944 +# just the same.
  1945 +# The default value is: YES.
  1946 +# This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1947 +
  1948 +PERLMOD_PRETTY = YES
  1949 +
  1950 +# The names of the make variables in the generated doxyrules.make file are
  1951 +# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
  1952 +# so different doxyrules.make files included by the same Makefile don't
  1953 +# overwrite each other's variables.
  1954 +# This tag requires that the tag GENERATE_PERLMOD is set to YES.
  1955 +
  1956 +PERLMOD_MAKEVAR_PREFIX =
  1957 +
  1958 +#---------------------------------------------------------------------------
  1959 +# Configuration options related to the preprocessor
  1960 +#---------------------------------------------------------------------------
  1961 +
  1962 +# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
  1963 +# C-preprocessor directives found in the sources and include files.
  1964 +# The default value is: YES.
  1965 +
  1966 +ENABLE_PREPROCESSING = YES
  1967 +
  1968 +# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
  1969 +# in the source code. If set to NO, only conditional compilation will be
  1970 +# performed. Macro expansion can be done in a controlled way by setting
  1971 +# EXPAND_ONLY_PREDEF to YES.
  1972 +# The default value is: NO.
  1973 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1974 +
  1975 +MACRO_EXPANSION = YES
  1976 +
  1977 +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
  1978 +# the macro expansion is limited to the macros specified with the PREDEFINED and
  1979 +# EXPAND_AS_DEFINED tags.
  1980 +# The default value is: NO.
  1981 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1982 +
  1983 +EXPAND_ONLY_PREDEF = YES
  1984 +
  1985 +# If the SEARCH_INCLUDES tag is set to YES, the include files in the
  1986 +# INCLUDE_PATH will be searched if a #include is found.
  1987 +# The default value is: YES.
  1988 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  1989 +
  1990 +SEARCH_INCLUDES = YES
  1991 +
  1992 +# The INCLUDE_PATH tag can be used to specify one or more directories that
  1993 +# contain include files that are not input files but should be processed by the
  1994 +# preprocessor.
  1995 +# This tag requires that the tag SEARCH_INCLUDES is set to YES.
  1996 +
  1997 +INCLUDE_PATH =
  1998 +
  1999 +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
  2000 +# patterns (like *.h and *.hpp) to filter out the header-files in the
  2001 +# directories. If left blank, the patterns specified with FILE_PATTERNS will be
  2002 +# used.
  2003 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  2004 +
  2005 +INCLUDE_FILE_PATTERNS =
  2006 +
  2007 +# The PREDEFINED tag can be used to specify one or more macro names that are
  2008 +# defined before the preprocessor is started (similar to the -D option of e.g.
  2009 +# gcc). The argument of the tag is a list of macros of the form: name or
  2010 +# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
  2011 +# is assumed. To prevent a macro definition from being undefined via #undef or
  2012 +# recursively expanded use the := operator instead of the = operator.
  2013 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  2014 +
  2015 +PREDEFINED = __DOXYGEN__ \
  2016 + PROGMEM
  2017 +
  2018 +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
  2019 +# tag can be used to specify a list of macro names that should be expanded. The
  2020 +# macro definition that is found in the sources will be used. Use the PREDEFINED
  2021 +# tag if you want to use a different macro definition that overrules the
  2022 +# definition found in the source code.
  2023 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  2024 +
  2025 +EXPAND_AS_DEFINED =
  2026 +
  2027 +# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
  2028 +# remove all references to function-like macros that are alone on a line, have
  2029 +# an all uppercase name, and do not end with a semicolon. Such function macros
  2030 +# are typically used for boiler-plate code, and will confuse the parser if not
  2031 +# removed.
  2032 +# The default value is: YES.
  2033 +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
  2034 +
  2035 +SKIP_FUNCTION_MACROS = YES
  2036 +
  2037 +#---------------------------------------------------------------------------
  2038 +# Configuration options related to external references
  2039 +#---------------------------------------------------------------------------
  2040 +
  2041 +# The TAGFILES tag can be used to specify one or more tag files. For each tag
  2042 +# file the location of the external documentation should be added. The format of
  2043 +# a tag file without this location is as follows:
  2044 +# TAGFILES = file1 file2 ...
  2045 +# Adding location for the tag files is done as follows:
  2046 +# TAGFILES = file1=loc1 "file2 = loc2" ...
  2047 +# where loc1 and loc2 can be relative or absolute paths or URLs. See the
  2048 +# section "Linking to external documentation" for more information about the use
  2049 +# of tag files.
  2050 +# Note: Each tag file must have a unique name (where the name does NOT include
  2051 +# the path). If a tag file is not located in the directory in which doxygen is
  2052 +# run, you must also specify the path to the tagfile here.
  2053 +
  2054 +TAGFILES =
  2055 +
  2056 +# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
  2057 +# tag file that is based on the input files it reads. See section "Linking to
  2058 +# external documentation" for more information about the usage of tag files.
  2059 +
  2060 +GENERATE_TAGFILE =
  2061 +
  2062 +# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
  2063 +# the class index. If set to NO, only the inherited external classes will be
  2064 +# listed.
  2065 +# The default value is: NO.
  2066 +
  2067 +ALLEXTERNALS = NO
  2068 +
  2069 +# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
  2070 +# in the modules index. If set to NO, only the current project's groups will be
  2071 +# listed.
  2072 +# The default value is: YES.
  2073 +
  2074 +EXTERNAL_GROUPS = YES
  2075 +
  2076 +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
  2077 +# the related pages index. If set to NO, only the current project's pages will
  2078 +# be listed.
  2079 +# The default value is: YES.
  2080 +
  2081 +EXTERNAL_PAGES = YES
  2082 +
  2083 +# The PERL_PATH should be the absolute path and name of the perl script
  2084 +# interpreter (i.e. the result of 'which perl').
  2085 +# The default file (with absolute path) is: /usr/bin/perl.
  2086 +
  2087 +PERL_PATH = /usr/bin/perl
  2088 +
  2089 +#---------------------------------------------------------------------------
  2090 +# Configuration options related to the dot tool
  2091 +#---------------------------------------------------------------------------
  2092 +
  2093 +# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
  2094 +# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
  2095 +# NO turns the diagrams off. Note that this option also works with HAVE_DOT
  2096 +# disabled, but it is recommended to install and use dot, since it yields more
  2097 +# powerful graphs.
  2098 +# The default value is: YES.
  2099 +
  2100 +CLASS_DIAGRAMS = NO
  2101 +
  2102 +# You can define message sequence charts within doxygen comments using the \msc
  2103 +# command. Doxygen will then run the mscgen tool (see:
  2104 +# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
  2105 +# documentation. The MSCGEN_PATH tag allows you to specify the directory where
  2106 +# the mscgen tool resides. If left empty the tool is assumed to be found in the
  2107 +# default search path.
  2108 +
  2109 +MSCGEN_PATH =
  2110 +
  2111 +# You can include diagrams made with dia in doxygen documentation. Doxygen will
  2112 +# then run dia to produce the diagram and insert it in the documentation. The
  2113 +# DIA_PATH tag allows you to specify the directory where the dia binary resides.
  2114 +# If left empty dia is assumed to be found in the default search path.
  2115 +
  2116 +DIA_PATH =
  2117 +
  2118 +# If set to YES the inheritance and collaboration graphs will hide inheritance
  2119 +# and usage relations if the target is undocumented or is not a class.
  2120 +# The default value is: YES.
  2121 +
  2122 +HIDE_UNDOC_RELATIONS = YES
  2123 +
  2124 +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
  2125 +# available from the path. This tool is part of Graphviz (see:
  2126 +# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
  2127 +# Bell Labs. The other options in this section have no effect if this option is
  2128 +# set to NO
  2129 +# The default value is: NO.
  2130 +
  2131 +HAVE_DOT = NO
  2132 +
  2133 +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
  2134 +# to run in parallel. When set to 0 doxygen will base this on the number of
  2135 +# processors available in the system. You can set it explicitly to a value
  2136 +# larger than 0 to get control over the balance between CPU load and processing
  2137 +# speed.
  2138 +# Minimum value: 0, maximum value: 32, default value: 0.
  2139 +# This tag requires that the tag HAVE_DOT is set to YES.
  2140 +
  2141 +DOT_NUM_THREADS = 0
  2142 +
  2143 +# When you want a differently looking font in the dot files that doxygen
  2144 +# generates you can specify the font name using DOT_FONTNAME. You need to make
  2145 +# sure dot is able to find the font, which can be done by putting it in a
  2146 +# standard location or by setting the DOTFONTPATH environment variable or by
  2147 +# setting DOT_FONTPATH to the directory containing the font.
  2148 +# The default value is: Helvetica.
  2149 +# This tag requires that the tag HAVE_DOT is set to YES.
  2150 +
  2151 +DOT_FONTNAME =
  2152 +
  2153 +# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
  2154 +# dot graphs.
  2155 +# Minimum value: 4, maximum value: 24, default value: 10.
  2156 +# This tag requires that the tag HAVE_DOT is set to YES.
  2157 +
  2158 +DOT_FONTSIZE = 10
  2159 +
  2160 +# By default doxygen will tell dot to use the default font as specified with
  2161 +# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
  2162 +# the path where dot can find it using this tag.
  2163 +# This tag requires that the tag HAVE_DOT is set to YES.
  2164 +
  2165 +DOT_FONTPATH =
  2166 +
  2167 +# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
  2168 +# each documented class showing the direct and indirect inheritance relations.
  2169 +# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
  2170 +# The default value is: YES.
  2171 +# This tag requires that the tag HAVE_DOT is set to YES.
  2172 +
  2173 +CLASS_GRAPH = NO
  2174 +
  2175 +# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
  2176 +# graph for each documented class showing the direct and indirect implementation
  2177 +# dependencies (inheritance, containment, and class references variables) of the
  2178 +# class with other documented classes.
  2179 +# The default value is: YES.
  2180 +# This tag requires that the tag HAVE_DOT is set to YES.
  2181 +
  2182 +COLLABORATION_GRAPH = NO
  2183 +
  2184 +# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
  2185 +# groups, showing the direct groups dependencies.
  2186 +# The default value is: YES.
  2187 +# This tag requires that the tag HAVE_DOT is set to YES.
  2188 +
  2189 +GROUP_GRAPHS = NO
  2190 +
  2191 +# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
  2192 +# collaboration diagrams in a style similar to the OMG's Unified Modeling
  2193 +# Language.
  2194 +# The default value is: NO.
  2195 +# This tag requires that the tag HAVE_DOT is set to YES.
  2196 +
  2197 +UML_LOOK = NO
  2198 +
  2199 +# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
  2200 +# class node. If there are many fields or methods and many nodes the graph may
  2201 +# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
  2202 +# number of items for each type to make the size more manageable. Set this to 0
  2203 +# for no limit. Note that the threshold may be exceeded by 50% before the limit
  2204 +# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
  2205 +# but if the number exceeds 15, the total amount of fields shown is limited to
  2206 +# 10.
  2207 +# Minimum value: 0, maximum value: 100, default value: 10.
  2208 +# This tag requires that the tag HAVE_DOT is set to YES.
  2209 +
  2210 +UML_LIMIT_NUM_FIELDS = 10
  2211 +
  2212 +# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
  2213 +# collaboration graphs will show the relations between templates and their
  2214 +# instances.
  2215 +# The default value is: NO.
  2216 +# This tag requires that the tag HAVE_DOT is set to YES.
  2217 +
  2218 +TEMPLATE_RELATIONS = NO
  2219 +
  2220 +# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
  2221 +# YES then doxygen will generate a graph for each documented file showing the
  2222 +# direct and indirect include dependencies of the file with other documented
  2223 +# files.
  2224 +# The default value is: YES.
  2225 +# This tag requires that the tag HAVE_DOT is set to YES.
  2226 +
  2227 +INCLUDE_GRAPH = NO
  2228 +
  2229 +# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
  2230 +# set to YES then doxygen will generate a graph for each documented file showing
  2231 +# the direct and indirect include dependencies of the file with other documented
  2232 +# files.
  2233 +# The default value is: YES.
  2234 +# This tag requires that the tag HAVE_DOT is set to YES.
  2235 +
  2236 +INCLUDED_BY_GRAPH = NO
  2237 +
  2238 +# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
  2239 +# dependency graph for every global function or class method.
  2240 +#
  2241 +# Note that enabling this option will significantly increase the time of a run.
  2242 +# So in most cases it will be better to enable call graphs for selected
  2243 +# functions only using the \callgraph command.
  2244 +# The default value is: NO.
  2245 +# This tag requires that the tag HAVE_DOT is set to YES.
  2246 +
  2247 +CALL_GRAPH = NO
  2248 +
  2249 +# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
  2250 +# dependency graph for every global function or class method.
  2251 +#
  2252 +# Note that enabling this option will significantly increase the time of a run.
  2253 +# So in most cases it will be better to enable caller graphs for selected
  2254 +# functions only using the \callergraph command.
  2255 +# The default value is: NO.
  2256 +# This tag requires that the tag HAVE_DOT is set to YES.
  2257 +
  2258 +CALLER_GRAPH = NO
  2259 +
  2260 +# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
  2261 +# hierarchy of all classes instead of a textual one.
  2262 +# The default value is: YES.
  2263 +# This tag requires that the tag HAVE_DOT is set to YES.
  2264 +
  2265 +GRAPHICAL_HIERARCHY = NO
  2266 +
  2267 +# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
  2268 +# dependencies a directory has on other directories in a graphical way. The
  2269 +# dependency relations are determined by the #include relations between the
  2270 +# files in the directories.
  2271 +# The default value is: YES.
  2272 +# This tag requires that the tag HAVE_DOT is set to YES.
  2273 +
  2274 +DIRECTORY_GRAPH = NO
  2275 +
  2276 +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
  2277 +# generated by dot.
  2278 +# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
  2279 +# to make the SVG files visible in IE 9+ (other browsers do not have this
  2280 +# requirement).
  2281 +# Possible values are: png, jpg, gif and svg.
  2282 +# The default value is: png.
  2283 +# This tag requires that the tag HAVE_DOT is set to YES.
  2284 +
  2285 +DOT_IMAGE_FORMAT = png
  2286 +
  2287 +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
  2288 +# enable generation of interactive SVG images that allow zooming and panning.
  2289 +#
  2290 +# Note that this requires a modern browser other than Internet Explorer. Tested
  2291 +# and working are Firefox, Chrome, Safari, and Opera.
  2292 +# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
  2293 +# the SVG files visible. Older versions of IE do not have SVG support.
  2294 +# The default value is: NO.
  2295 +# This tag requires that the tag HAVE_DOT is set to YES.
  2296 +
  2297 +INTERACTIVE_SVG = NO
  2298 +
  2299 +# The DOT_PATH tag can be used to specify the path where the dot tool can be
  2300 +# found. If left blank, it is assumed the dot tool can be found in the path.
  2301 +# This tag requires that the tag HAVE_DOT is set to YES.
  2302 +
  2303 +DOT_PATH =
  2304 +
  2305 +# The DOTFILE_DIRS tag can be used to specify one or more directories that
  2306 +# contain dot files that are included in the documentation (see the \dotfile
  2307 +# command).
  2308 +# This tag requires that the tag HAVE_DOT is set to YES.
  2309 +
  2310 +DOTFILE_DIRS =
  2311 +
  2312 +# The MSCFILE_DIRS tag can be used to specify one or more directories that
  2313 +# contain msc files that are included in the documentation (see the \mscfile
  2314 +# command).
  2315 +
  2316 +MSCFILE_DIRS =
  2317 +
  2318 +# The DIAFILE_DIRS tag can be used to specify one or more directories that
  2319 +# contain dia files that are included in the documentation (see the \diafile
  2320 +# command).
  2321 +
  2322 +DIAFILE_DIRS =
  2323 +
  2324 +# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
  2325 +# path where java can find the plantuml.jar file. If left blank, it is assumed
  2326 +# PlantUML is not used or called during a preprocessing step. Doxygen will
  2327 +# generate a warning when it encounters a \startuml command in this case and
  2328 +# will not generate output for the diagram.
  2329 +
  2330 +PLANTUML_JAR_PATH =
  2331 +
  2332 +# When using plantuml, the specified paths are searched for files specified by
  2333 +# the !include statement in a plantuml block.
  2334 +
  2335 +PLANTUML_INCLUDE_PATH =
  2336 +
  2337 +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
  2338 +# that will be shown in the graph. If the number of nodes in a graph becomes
  2339 +# larger than this value, doxygen will truncate the graph, which is visualized
  2340 +# by representing a node as a red box. Note that doxygen if the number of direct
  2341 +# children of the root node in a graph is already larger than
  2342 +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
  2343 +# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
  2344 +# Minimum value: 0, maximum value: 10000, default value: 50.
  2345 +# This tag requires that the tag HAVE_DOT is set to YES.
  2346 +
  2347 +DOT_GRAPH_MAX_NODES = 15
  2348 +
  2349 +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
  2350 +# generated by dot. A depth value of 3 means that only nodes reachable from the
  2351 +# root by following a path via at most 3 edges will be shown. Nodes that lay
  2352 +# further from the root node will be omitted. Note that setting this option to 1
  2353 +# or 2 may greatly reduce the computation time needed for large code bases. Also
  2354 +# note that the size of a graph can be further restricted by
  2355 +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
  2356 +# Minimum value: 0, maximum value: 1000, default value: 0.
  2357 +# This tag requires that the tag HAVE_DOT is set to YES.
  2358 +
  2359 +MAX_DOT_GRAPH_DEPTH = 2
  2360 +
  2361 +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
  2362 +# background. This is disabled by default, because dot on Windows does not seem
  2363 +# to support this out of the box.
  2364 +#
  2365 +# Warning: Depending on the platform used, enabling this option may lead to
  2366 +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
  2367 +# read).
  2368 +# The default value is: NO.
  2369 +# This tag requires that the tag HAVE_DOT is set to YES.
  2370 +
  2371 +DOT_TRANSPARENT = YES
  2372 +
  2373 +# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
  2374 +# files in one run (i.e. multiple -o and -T options on the command line). This
  2375 +# makes dot run faster, but since only newer versions of dot (>1.8.10) support
  2376 +# this, this feature is disabled by default.
  2377 +# The default value is: NO.
  2378 +# This tag requires that the tag HAVE_DOT is set to YES.
  2379 +
  2380 +DOT_MULTI_TARGETS = NO
  2381 +
  2382 +# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
  2383 +# explaining the meaning of the various boxes and arrows in the dot generated
  2384 +# graphs.
  2385 +# The default value is: YES.
  2386 +# This tag requires that the tag HAVE_DOT is set to YES.
  2387 +
  2388 +GENERATE_LEGEND = YES
  2389 +
  2390 +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
  2391 +# files that are used to generate the various graphs.
  2392 +# The default value is: YES.
  2393 +# This tag requires that the tag HAVE_DOT is set to YES.
  2394 +
  2395 +DOT_CLEANUP = YES
... ...
atmega16u2/PolytechLille/PAD/makefile 0 → 100644
  Show/Hide comments   View file @20f46bd
... ... @@ -0,0 +1,43 @@
  1 +#
  2 +# LUFA Library
  3 +# Copyright (C) Dean Camera, 2017.
  4 +#
  5 +# dean [at] fourwalledcubicle [dot] com
  6 +# www.lufa-lib.org
  7 +#
  8 +# --------------------------------------
  9 +# LUFA Project Makefile.
  10 +# --------------------------------------
  11 +
  12 +# Run "make help" for target help.
  13 +
  14 +MCU = atmega16u2
  15 +ARCH = AVR8
  16 +BOARD = UNO
  17 +F_CPU = 16000000
  18 +F_USB = $(F_CPU)
  19 +OPTIMIZATION = s
  20 +TARGET = PAD
  21 +SRC = $(TARGET).c Descriptors.c $(LUFA_SRC_USB) $(LUFA_SRC_USBCLASS)
  22 +LUFA_PATH = ../../LUFA
  23 +CC_FLAGS = -DUSE_LUFA_CONFIG_HEADER -IConfig/
  24 +LD_FLAGS =
  25 +
  26 +# Default target
  27 +all:
  28 +
  29 +# Include LUFA-specific DMBS extension modules
  30 +DMBS_LUFA_PATH ?= $(LUFA_PATH)/Build/LUFA
  31 +include $(DMBS_LUFA_PATH)/lufa-sources.mk
  32 +include $(DMBS_LUFA_PATH)/lufa-gcc.mk
  33 +
  34 +# Include common DMBS build system modules
  35 +DMBS_PATH ?= $(LUFA_PATH)/Build/DMBS/DMBS
  36 +include $(DMBS_PATH)/core.mk
  37 +include $(DMBS_PATH)/cppcheck.mk
  38 +include $(DMBS_PATH)/doxygen.mk
  39 +include $(DMBS_PATH)/dfu.mk
  40 +include $(DMBS_PATH)/gcc.mk
  41 +include $(DMBS_PATH)/hid.mk
  42 +include $(DMBS_PATH)/avrdude.mk
  43 +include $(DMBS_PATH)/atprogram.mk
... ...
atmega16u2/README.txt 0 → 100644
  Show/Hide comments   View file @20f46bd
... ... @@ -0,0 +1,56 @@
  1 +
  2 + _ _ _ ___ _
  3 + | | | | | __/ \
  4 + | |_| U | _| o | - The Lightweight USB
  5 + |___|___|_||_n_| Framework for AVRs
  6 + =========================================
  7 + Written by Dean Camera
  8 + dean [at] fourwalledcubicle [dot] com
  9 +
  10 + http://www.lufa-lib.org
  11 + =========================================
  12 +
  13 + LUFA is donation supported. To support LUFA,
  14 + please donate at http://www.lufa-lib.org/donate
  15 +
  16 + Released under a modified MIT license - see
  17 + LUFA/License.txt for license details.
  18 +
  19 + For Commercial Licensing information, see
  20 + http://www.lufa-lib.org/license
  21 +
  22 +
  23 +This package contains the complete LUFA library, demos, user-submitted
  24 +projects and bootloaders for use with compatible microcontroller models.
  25 +LUFA is a simple to use, lightweight framework which sits atop the hardware
  26 +USB controller in specific AVR microcontroller models, and allows for the
  27 +quick and easy creation of complex USB devices and hosts.
  28 +
  29 +To get started, you will need to install the "Doxygen" documentation
  30 +generation tool. If you use Linux, this can be installed via the "doxygen"
  31 +package in your chosen package management tool - under Ubuntu, this can be
  32 +achieved by running the following command in the terminal:
  33 +
  34 + sudo apt-get install doxygen
  35 +
  36 +Other package managers and distributions will have similar methods to
  37 +install Doxygen. In Windows, you can download a prebuilt installer for
  38 +Doxygen from its website, www.doxygen.org.
  39 +
  40 +Once installed, you can then use the Doxygen tool to generate the library
  41 +documentation from the command line or terminal of your operating system. To
  42 +do this, open your terminal or command line to the root directory of the
  43 +LUFA package, and type the following command:
  44 +
  45 + make doxygen
  46 +
  47 +Which will recursively generate documentation for all elements in the
  48 +library - the core, plus all demos, projects and bootloaders. Generated
  49 +documentation will then be available by opening the file "index.html" of the
  50 +created Documentation/html/ subdirectories inside each project folder.
  51 +
  52 +The documentation for the library itself (but not the documentation for the
  53 +individual demos, projects or bootloaders) is also available as a separate
  54 +package from the project webpage for convenience if Doxygen cannot be
  55 +installed.
  56 +
... ...
atmega16u2/makefile 0 → 100644
  Show/Hide comments   View file @20f46bd
... ... @@ -0,0 +1,27 @@
  1 +#
  2 +# LUFA Library
  3 +# Copyright (C) Dean Camera, 2017.
  4 +#
  5 +# dean [at] fourwalledcubicle [dot] com
  6 +# www.lufa-lib.org
  7 +#
  8 +
  9 +# Makefile to build the LUFA library, projects and demos.
  10 +
  11 +# Call with "make all" to rebuild everything, "make clean" to clean everything,
  12 +# "make mostlyclean" to remove all intermediary files but preserve any binaries,
  13 +# "make doxygen" to document everything with Doxygen (if installed). Call
  14 +# "make help" for additional target build information within a specific project.
  15 +
  16 +all:
  17 +
  18 +%:
  19 + @echo Executing \"make $@\" on all LUFA library elements.
  20 + @echo
  21 + $(MAKE) -C LUFA $@
  22 + $(MAKE) -C Demos $@
  23 + $(MAKE) -C Projects $@
  24 + $(MAKE) -C Bootloaders $@
  25 + $(MAKE) -C PolytechLille $@
  26 + @echo
  27 + @echo LUFA \"make $@\" operation complete.
... ...