[tuxdroid-svn] r546 - in firmware/tuxaudio/trunk: . doc
Status: Beta
Brought to you by:
ks156
Menu
▾
▴
[tuxdroid-svn] r546 - in firmware/tuxaudio/trunk: . doc
|
From: jaguarondi <c2m...@c2...> - 2007-09-28 09:54:17
|
Author: jaguarondi
Date: 2007-09-28 11:54:08 +0200 (Fri, 28 Sep 2007)
New Revision: 546
Added:
firmware/tuxaudio/trunk/AT26F004.c
firmware/tuxaudio/trunk/AT26F004.h
firmware/tuxaudio/trunk/PC_communication.c
firmware/tuxaudio/trunk/PC_communication.h
firmware/tuxaudio/trunk/doc/
firmware/tuxaudio/trunk/doc/Doxyfile
firmware/tuxaudio/trunk/doc/builddoc.sh
firmware/tuxaudio/trunk/hardware.h
Removed:
firmware/tuxaudio/trunk/doc/Doxyfile
firmware/tuxaudio/trunk/doc/builddoc.sh
Modified:
firmware/tuxaudio/trunk/Makefile
firmware/tuxaudio/trunk/flash.c
firmware/tuxaudio/trunk/flash.h
firmware/tuxaudio/trunk/init.c
firmware/tuxaudio/trunk/main.c
firmware/tuxaudio/trunk/spi.c
firmware/tuxaudio/trunk/spi.h
Log:
* Merged changes made in the audio_cleanup branch up to now.
Copied: firmware/tuxaudio/trunk/AT26F004.c (from rev 545, firmware/tuxaudio/branches/audio_cleanup/AT26F004.c)
===================================================================
--- firmware/tuxaudio/trunk/AT26F004.c (rev 0)
+++ firmware/tuxaudio/trunk/AT26F004.c 2007-09-28 09:54:08 UTC (rev 546)
@@ -0,0 +1,184 @@
+/*
+ * TUXAUDIO - Firmware for the 'audio' CPU of tuxdroid
+ * Copyright (C) 2007 C2ME S.A. <tux...@c2...>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+/* $Id: $ */
+
+#include <avr/io.h>
+#include "AT26F004.h"
+#include "hardware.h"
+#include "spi.h"
+
+/**
+ * \ingroup at26f004
+ * \brief initialize a table with the sectors adresses values
+ */
+static uint8_t sector_adress[11][3] = {
+ {SECTOR0},
+ {SECTOR1},
+ {SECTOR2},
+ {SECTOR3},
+ {SECTOR4},
+ {SECTOR5},
+ {SECTOR6},
+ {SECTOR7},
+ {SECTOR8},
+ {SECTOR9},
+ {SECTOR10}
+};
+
+/**
+ * \ingroup at26f004
+
+ \brief This function set the write enable flag of the flash memory.
+ */
+uint8_t read_status(void)
+{
+ uint8_t status;
+
+ FLASH_CS_ON;
+ spiSend(READ_STATUS_REG); /* Send Read Status Command */
+ status = spiSend(NOP); /* Read status on spi */
+ FLASH_CS_OFF;
+ return status;
+}
+/**
+ * \ingroup at26f004
+
+ \brief This function set the write enable flag of the flash memory.
+ */
+void write_enable(void)
+{
+ FLASH_CS_ON;
+ spiSend(WRITE_EN); /* Send Write Enable Command */
+ FLASH_CS_OFF;
+}
+/**
+ * \ingroup at26f004
+
+ \brief This function clear the write enable flag of the flash memory.
+ */
+void write_disable(void)
+{
+ FLASH_CS_ON;
+ spiSend(WRITE_DIS); /* Send Write Disable Command */
+ FLASH_CS_OFF;
+}
+
+/**
+ * \ingroup at26f004
+
+ \brief This function write into the flash memory status register.
+ */
+void write_status(uint8_t const status)
+{
+ FLASH_CS_ON;
+ spiSend(WRITE_STATUS_REG); /* Send Write Status Command */
+ spiSend(status); /* Send status */
+ FLASH_CS_OFF;
+}
+/**
+ * \ingroup at26f004
+ \param ad2 high address part
+ \param ad1 medium adress part
+ \param ad0 lower adress part
+
+ \brief This function unprotect a sector.
+ */
+void unprotect_sector(uint8_t const ad2, uint8_t const ad1, uint8_t const ad0)
+{
+ FLASH_CS_ON;
+ spiSend(UNPROTECT_SECTOR); /* Send unprotect sector command */
+ /* Send Adress */
+ spiSend(ad2);
+ spiSend(ad1);
+ spiSend(ad0);
+ FLASH_CS_OFF;
+}
+/**
+ * \ingroup at26f004
+
+ \brief This function erase the entire memory.
+ */
+void erase_flash(void)
+{
+ uint8_t i;
+ write_status(0x00); /* Disable sector protection register */
+ for (i=0; i<=10; i++)
+ {
+ write_enable(); /* Enable the writing */
+ unprotect_sector(sector_adress[i][0], sector_adress[i][1],sector_adress[i][2]);
+ }
+
+ write_enable(); /* Enable the writing */
+
+ FLASH_CS_ON;
+ spiSend(CHIP_ERASE); /* Send Erase Bulk command */
+ FLASH_CS_OFF;
+}
+
+/**
+ * \ingroup at26f004
+ \param ad2 high address part
+ \param ad1 medium adress part
+ \param ad0 lower adress part
+
+ \brief This function write a byte in the flash memory.
+ */
+void program_flash(uint8_t const ad2, uint8_t const ad1, uint8_t const ad0,
+ uint8_t const data)
+{
+ while (read_status() & BUSY) ; /* Wait Page Program Cycle */
+
+ write_enable();
+ FLASH_CS_ON;
+ spiSend(BYTE_PROGRAM); /* Send Page Byte Command */
+ /* Send adress */
+ spiSend(ad2);
+ spiSend(ad1);
+ spiSend(ad0);
+ spiSend(data); /* Write data in flash */
+ FLASH_CS_OFF;
+}
+
+/**
+ * \ingroup at26f004
+ \param ad2 high address part
+ \param ad1 medium adress part
+ \param ad0 lower adress part
+ \return Data read
+ \brief This function read a single byte in the flash memory.
+ */
+uint8_t read_data(uint8_t const ad2, uint8_t const ad1, uint8_t const ad0)
+{
+ uint8_t data1;
+
+ FLASH_CS_ON;
+ spiSend(READ_ARRAY_LOW_F); /* Send Read Page Command */
+ /* Send address */
+ spiSend(ad2);
+ spiSend(ad1);
+ spiSend(ad0);
+ data1 = spiSend(NOP); /* Wait response */
+ FLASH_CS_OFF;
+
+ return data1;
+}
+
+
+
Copied: firmware/tuxaudio/trunk/AT26F004.h (from rev 545, firmware/tuxaudio/branches/audio_cleanup/AT26F004.h)
===================================================================
--- firmware/tuxaudio/trunk/AT26F004.h (rev 0)
+++ firmware/tuxaudio/trunk/AT26F004.h 2007-09-28 09:54:08 UTC (rev 546)
@@ -0,0 +1,151 @@
+/*
+ * TUXAUDIO - Firmware for the 'audio' CPU of tuxdroid
+ * Copyright (C) 2007 C2ME S.A. <tux...@c2...>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+/** \defgroup at26f004 AT26F004 flash memory
+ \ingroup at26f004
+
+ This module contains all specific definitions and functions to access the flash memory.
+ */
+
+/** \file AT26F004.h
+ \ingroup at26f004
+ \brief AT26F004 flash memory header
+ */
+
+#ifndef AT26F004_H
+#define AT26F004_H
+
+#include "hardware.h"
+
+/** \file AT26F004.c
+ \ingroup at26f004
+ \brief AT26F004 functions
+ */
+
+
+/**
+ * \name Read opcodes
+ @{ */
+#define READ_ARRAY 0x0B
+#define READ_ARRAY_LOW_F 0x03
+/* @} */
+/** \name Erase opcodes
+ *@{ */
+#define BLOCK_ERASE_4K 0x20
+#define BLOCK_ERASE_32K 0x52
+#define BLOCK_ERASE_64K 0xD8
+#define CHIP_ERASE 0x60
+/* @} */
+
+/** \name Program opcodes
+ * @{ */
+#define BYTE_PROGRAM 0x02
+#define SEQU_PROGRAM 0xAF
+/* @} */
+
+/** \name Sectors managment opcodes
+ * @{ */
+#define WRITE_EN 0x06
+#define WRITE_DIS 0x04
+#define PROTECT_SECTOR 0x36
+#define UNPROTECT_SECTOR 0x39
+#define READ_SECT_PROTECT 0x3C
+/* @} */
+/** \name Status command
+ * @{ */
+#define READ_STATUS_REG 0x05
+#define WRITE_STATUS_REG 0x01
+/* @} */
+/** \name Misc. opcodes
+ * @{ */
+#define READ_MANUFACT 0x9F
+#define DEEP_POWER_MODE 0xB9
+#define RESUME_DEEP_MODE 0xAB
+
+#define NOP 0x00
+/* @} */
+
+/**
+ * \name AT26F004 status register masks
+ *
+ * @{ */
+#define BUSY 0x01
+#define WEL 0X02
+#define SWP 0x0C
+#define WPP 0x10
+#define RES 0x20
+#define SPM 0x40
+#define SPRL 0x80
+/*! @} */
+
+/** \name Flash sector adresses
+ * @{ */
+#define SECTOR0 0x00, 0x00, 0x00
+#define SECTOR1 0x01, 0x00, 0x00
+#define SECTOR2 0x02, 0x00, 0x00
+#define SECTOR3 0x03, 0x00, 0X00
+#define SECTOR4 0x04, 0x00, 0x00
+#define SECTOR5 0x05, 0x00, 0x00
+#define SECTOR6 0x06, 0X00, 0x00
+#define SECTOR7 0x07, 0x00, 0x00
+#define SECTOR8 0x07, 0x80, 0x00
+#define SECTOR9 0x07, 0xA0, 0x00
+#define SECTOR10 0x07, 0xC0, 0x00
+
+/* @} */
+
+
+/**
+ * \name Flash TOP address
+ * The flash memory address range is 0x000000 - [TOP_A2 TOP_A1 TOP_A0]
+ * The AT26F004 has an address range of 0x000000 - 0x7FFFFF
+ * @{ */
+
+/** High byte of the TOP address. */
+#define TOP_A2 0x07
+/** Middle byte of the TOP address. */
+#define TOP_A1 0xFF
+/** Low byte of the TOP address. */
+#define TOP_A0 0xFF
+/*! @} */
+
+/** \name Status access functions
+ * @{ */
+extern uint8_t read_status(void);
+extern void write_status(uint8_t const status);
+/* @} */
+/** \name Writing functions
+ * @{ */
+extern void write_enable(void);
+extern void write_disable(void);
+extern void program_flash(uint8_t const ad2, uint8_t const ad1, uint8_t const ad0,
+ uint8_t const data);
+/* @} */
+/** \name Reading function
+ * @{ */
+extern uint8_t read_data(uint8_t const ad2, uint8_t const ad1, uint8_t const ad0);
+/* @} */
+/** \name Misc. functions
+ * @{ */
+extern void erase_flash(void);
+extern void unprotect_sector(uint8_t const ad2, uint8_t const ad1,
+ uint8_t const ad0);
+/* @} */
+
+#endif
Modified: firmware/tuxaudio/trunk/Makefile
===================================================================
--- firmware/tuxaudio/trunk/Makefile 2007-09-28 07:40:32 UTC (rev 545)
+++ firmware/tuxaudio/trunk/Makefile 2007-09-28 09:54:08 UTC (rev 546)
@@ -69,7 +69,7 @@
## Objects that must be built in order to link
-OBJECTS = init.o main.o varis.o fifo.o spi.o flash.o communication.o i2c.o config.o
+OBJECTS = init.o main.o varis.o fifo.o spi.o AT26F004.o flash.o communication.o PC_communication.o i2c.o config.o
## Objects explicitly added by the user
LINKONLYOBJECTS =
@@ -94,12 +94,18 @@
spi.o: spi.c
$(CC) $(INCLUDES) $(CFLAGS) -c $<
+AT26F004.o: AT26F004.c
+ $(CC) $(INCLUDES) $(CFLAGS) -c $<
+
flash.o: flash.c
$(CC) $(INCLUDES) $(CFLAGS) -c $<
communication.o: communication.c
$(CC) $(INCLUDES) $(CFLAGS) -c $<
+PC_communication.o: PC_communication.c
+ $(CC) $(INCLUDES) $(CFLAGS) -c $<
+
i2c.o: i2c.c
$(CC) $(INCLUDES) $(CFLAGS) -c $<
@@ -109,6 +115,9 @@
bootloader.o: bootloader.c
$(CC) $(INCLUDES) $(CFLAGS) -c $<
+
+
+
##Link
$(TARGET): $(OBJECTS)
$(CC) $(LDFLAGS) $(OBJECTS) $(LINKONLYOBJECTS) $(LIBDIRS) $(LIBS) -o $(TARGET)
@@ -142,8 +151,9 @@
endif
## Generate SVN info
-.PHONY: svnrev.h
-svnrev.h:
+# We need to change the status each time a file changes, thus so many
+# dependencies
+svnrev.h: $(CSOURCE) $(HEADERS)
ifdef windir
SubWCRev . svnrev.tmpl.h svnrev.h
else
@@ -159,6 +169,16 @@
## Other dependencies
-include $(shell mkdir dep 2>/dev/null) $(wildcard dep/*)
+## Generate doxygen documentation
+.PHONY: doc
+doc: svnrev.h
+ifdef windir
+ # XXX add windows version
+else
+ @./doc/builddoc.sh
+endif
+
+
# Programming
prog: $(PROJECT).hex
tuxup $(PROJECT).hex $(PROJECT).eep
Copied: firmware/tuxaudio/trunk/PC_communication.c (from rev 545, firmware/tuxaudio/branches/audio_cleanup/PC_communication.c)
===================================================================
--- firmware/tuxaudio/trunk/PC_communication.c (rev 0)
+++ firmware/tuxaudio/trunk/PC_communication.c 2007-09-28 09:54:08 UTC (rev 546)
@@ -0,0 +1,180 @@
+/*
+ * TUXAUDIO - Firmware for the 'audio' CPU of tuxdroid
+ * Copyright (C) 2007 C2ME S.A. <tux...@c2...>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+/* $Id: */
+
+#include <avr/io.h>
+#include <avr/interrupt.h>
+
+#include "varis.h"
+#include "fifo.h"
+#include "PC_communication.h"
+#include "communication.h"
+#include "spi.h"
+#include "hardware.h"
+
+void spiTransaction(void)
+{
+ if ((spi_start) && (spi_enable)) // Wait start
+ {
+ spi_start = 0; // Reset the spi start flag
+ spi_enable = 0; // Communication in progress
+ spi_count = 0; // Reset spi counter
+ spi_slave = HEADERS; // Set state machine
+ spi_master = HEADERM;
+ if (programmingFlash)
+ HOLD_ON;
+ // Reset SPI to fix strange bug on the spi
+ SPCR = 0x50;
+ SPSR = 0x00;
+ asm volatile /* Clear the SPI interrupt flag */
+ ("in __tmp_reg__, %0" "\n\t" "in __tmp_reg__, %1" "\n\t"::
+ "I" (_SFR_IO_ADDR(SPSR)), "I"(_SFR_IO_ADDR(SPDR)));
+
+ PORTB &= ~0x04; // Chip select
+ while (1)
+ {
+ if (spi_ready)
+ {
+ spi_ready = 0;
+ if (spi_slave == HEADERS)
+ {
+ /* Sound */
+ if (fifoLength(&ADCFifo) >= 17)
+ spi_headerb = 0x02; /* frame will contain sound */
+ else
+ spi_headerb = 0x00; /* no sound in frame */
+
+ /* Status */
+ if ((rf_data_sent_ack == RF_DATA_SENT_NACKED)
+ || (rf_data_sent_ack == RF_DATA_SENT_DROPPED))
+ {
+ spi_headerb |= 0x08; /* resend the previous status if nacked */
+ cli();
+ sei();
+ }
+ else if (rf_data_sent_ack != RF_DATA_SENT_BUSY) /* wait the end of transmission */
+ if (!popStatus(spi_commandTX)) /* fetch the next status */
+ spi_headerb |= 0x08; /* indicate that the frame contains status */
+
+ SPDR = spi_headerb; // Header byte
+ spi_slave = GET_SOUND_FIFO; // Next state
+ }
+ else if (spi_slave == GET_SOUND_FIFO)
+ {
+ if (spi_count == 17)
+ spi_slave = PUT_COMMAND; // Next state
+ if (spi_headerb & 0x02)
+ {
+ cli();
+ SPDR = pullFifo(&ADCFifo); // Get data from FIFO
+ sei();
+ }
+ else
+ SPDR = 0x00; // No data to transmit
+ }
+ else if (spi_slave == PUT_COMMAND)
+ {
+ if (spi_count == 21)
+ spi_slave = DUMMY; // Next state
+ if (spi_headerb & 0x08)
+ {
+ SPDR = spi_commandTX[spi_count - 18]; // Get command from buffer
+ }
+ else
+ SPDR = 0x00; // No command to transmit
+ }
+ else if (spi_slave == DUMMY)
+ {
+ SPDR = 0x00; // Dummy byte in case of big frame
+ }
+
+ while ((SPSR & 0x80) == 0) ; // Wait SPI response
+
+ spi_count++;
+ if (spi_master == HEADERM)
+ {
+ spi_master_config = SPDR; // Save header config byte
+ if (spi_master_config & 0x08) // Command
+ commandRX = 1; // Flag to send command on I2C
+ if (spi_master_config & 0x80) // Double frame
+ spi_lenght_data = 34;
+ else
+ spi_lenght_data = 17;
+ spi_master = PUT_SOUND_FIFO; // Go to the next state
+
+ if (!programmingFlash) // XXX code must be review it's very strange .....
+ {
+ if (!(spi_master_config & 0x02))
+ {
+ if (!lockAdaptFifo)
+ {
+ cli();
+ adaptFifo(&PWMFifo); // Adaptative FIFO
+ sei();
+ lockAdaptFifo = 1;
+ }
+ else
+ resetFifo(&PWMFifo);
+ }
+ else
+ {
+ lockAdaptFifo = 0;
+ }
+ }
+
+ }
+ else if (spi_master == PUT_SOUND_FIFO)
+ {
+ if (spi_master_config & 0x02)
+ {
+ cli();
+ pushFifo(&PWMFifo, SPDR); // Put into the FIFO
+ sei();
+ }
+ if (spi_count == (spi_lenght_data + 1))
+ spi_master = READ_COMMAND; // Go to the next state
+ }
+ else if (spi_master == READ_COMMAND)
+ {
+ if (spi_master_config & 0x08)
+ {
+ if (spi_master_config & 0x80)
+ spi_commandRX[spi_count - 36] = SPDR; // Put command into the buffer
+ else
+ spi_commandRX[spi_count - 19] = SPDR; // Put command into the buffer
+ }
+ if (spi_count == spi_lenght_data + 6)
+ {
+ /* Check the acknowledge from the rf */
+ if (spi_headerb & 0x08) /* if data was sent in the current SPI transaction, mark buffer as full and drop the received status */
+ rf_data_sent_ack = RF_DATA_SENT_BUSY; /* status buffer of the rf filled */
+ else
+ rf_data_sent_ack = spi_commandRX[4]; /* get the acknowledge of the previous sent data */
+
+ PORTB |= 0x04; // Chip deselect
+ spi_enable = 1;
+ break;
+ }
+ }
+ }
+ }
+ }
+}
+
Copied: firmware/tuxaudio/trunk/PC_communication.h (from rev 545, firmware/tuxaudio/branches/audio_cleanup/PC_communication.h)
===================================================================
--- firmware/tuxaudio/trunk/PC_communication.h (rev 0)
+++ firmware/tuxaudio/trunk/PC_communication.h 2007-09-28 09:54:08 UTC (rev 546)
@@ -0,0 +1,27 @@
+/*
+ * TUXAUDIO - Firmware for the 'audio' CPU of tuxdroid
+ * Copyright (C) 2007 C2ME S.A. <tux...@c2...>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+/* $Id: $ */
+
+#ifndef PC_COMMUNICATION_H
+#define PC_COMMUNICATION_H
+
+extern void spiTransaction(void);
+
+#endif
Copied: firmware/tuxaudio/trunk/doc (from rev 545, firmware/tuxaudio/branches/audio_cleanup/doc)
Deleted: firmware/tuxaudio/trunk/doc/Doxyfile
===================================================================
--- firmware/tuxaudio/branches/audio_cleanup/doc/Doxyfile 2007-09-28 07:40:32 UTC (rev 545)
+++ firmware/tuxaudio/trunk/doc/Doxyfile 2007-09-28 09:54:08 UTC (rev 546)
@@ -1,1277 +0,0 @@
-# Doxyfile 1.5.2 - Doxygen configuration file for TUXCORE
-#
-# TUXCORE - Firmware for the 'core' CPU of tuxdroid
-# Copyright (C) 2007 C2ME S.A. <tux...@c2...>
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-#
-
-# $Id: Doxyfile 494 2007-09-06 15:23:54Z jaguarondi $
-
-# This file describes the settings to be used by the documentation system
-# doxygen (www.doxygen.org) for a project
-#
-# All text after a hash (#) is considered a comment and will be ignored
-# The format is:
-# TAG = value [value, ...]
-# For lists items can also be appended using:
-# TAG += value [value, ...]
-# Values that contain spaces should be placed between quotes (" ")
-
-#---------------------------------------------------------------------------
-# Project related configuration options
-#---------------------------------------------------------------------------
-
-# This tag specifies the encoding used for all characters in the config file that
-# follow. The default is UTF-8 which is also the encoding used for all text before
-# the first occurrence of this tag. Doxygen uses libiconv (or the iconv built into
-# libc) for the transcoding. See http://www.gnu.org/software/libiconv for the list of
-# possible encodings.
-
-DOXYFILE_ENCODING = UTF-8
-
-# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
-# by quotes) that should identify the project.
-
-PROJECT_NAME = tuxaudio
-
-# The PROJECT_NUMBER tag can be used to enter a project or revision number.
-# This could be handy for archiving the generated documentation or
-# if some version control system is used.
-
-PROJECT_NUMBER = $(VERSION)
-
-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
-# base path where the generated documentation will be put.
-# If a relative path is entered, it will be relative to the location
-# where doxygen was started. If left blank the current directory will be used.
-
-OUTPUT_DIRECTORY = doc
-
-# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
-# 4096 sub-directories (in 2 levels) under the output directory of each output
-# format and will distribute the generated files over these directories.
-# Enabling this option can be useful when feeding doxygen a huge amount of
-# source files, where putting all generated files in the same directory would
-# otherwise cause performance problems for the file system.
-
-CREATE_SUBDIRS = NO
-
-# The OUTPUT_LANGUAGE tag is used to specify the language in which all
-# documentation generated by doxygen is written. Doxygen will use this
-# information to generate all constant output in the proper language.
-# The default language is English, other supported languages are:
-# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
-# Croatian, Czech, Danish, Dutch, Finnish, French, German, Greek, Hungarian,
-# Italian, Japanese, Japanese-en (Japanese with English messages), Korean,
-# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian,
-# Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
-
-OUTPUT_LANGUAGE = English
-
-# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
-# include brief member descriptions after the members that are listed in
-# the file and class documentation (similar to JavaDoc).
-# Set to NO to disable this.
-
-BRIEF_MEMBER_DESC = YES
-
-# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
-# the brief description of a member or function before the detailed description.
-# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
-# brief descriptions will be completely suppressed.
-
-REPEAT_BRIEF = YES
-
-# This tag implements a quasi-intelligent brief description abbreviator
-# that is used to form the text in various listings. Each string
-# in this list, if found as the leading text of the brief description, will be
-# stripped from the text and the result after processing the whole list, is
-# used as the annotated text. Otherwise, the brief description is used as-is.
-# If left blank, the following values are used ("$name" is automatically
-# replaced with the name of the entity): "The $name class" "The $name widget"
-# "The $name file" "is" "provides" "specifies" "contains"
-# "represents" "a" "an" "the"
-
-ABBREVIATE_BRIEF =
-
-# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
-# Doxygen will generate a detailed section even if there is only a brief
-# description.
-
-ALWAYS_DETAILED_SEC = NO
-
-# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
-# inherited members of a class in the documentation of that class as if those
-# members were ordinary class members. Constructors, destructors and assignment
-# operators of the base classes will not be shown.
-
-INLINE_INHERITED_MEMB = NO
-
-# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
-# path before files name in the file list and in the header files. If set
-# to NO the shortest path that makes the file name unique will be used.
-
-FULL_PATH_NAMES = YES
-
-# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
-# can be used to strip a user-defined part of the path. Stripping is
-# only done if one of the specified strings matches the left-hand part of
-# the path. The tag can be used to show relative paths in the file list.
-# If left blank the directory from which doxygen is run is used as the
-# path to strip.
-
-STRIP_FROM_PATH =
-
-# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
-# the path mentioned in the documentation of a class, which tells
-# the reader which header file to include in order to use a class.
-# If left blank only the name of the header file containing the class
-# definition is used. Otherwise one should specify the include paths that
-# are normally passed to the compiler using the -I flag.
-
-STRIP_FROM_INC_PATH =
-
-# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
-# (but less readable) file names. This can be useful is your file systems
-# doesn't support long names like on DOS, Mac, or CD-ROM.
-
-SHORT_NAMES = NO
-
-# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
-# will interpret the first line (until the first dot) of a JavaDoc-style
-# comment as the brief description. If set to NO, the JavaDoc
-# comments will behave just like the Qt-style comments (thus requiring an
-# explicit @brief command for a brief description.
-
-JAVADOC_AUTOBRIEF = YES
-
-# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
-# treat a multi-line C++ special comment block (i.e. a block of //! or ///
-# comments) as a brief description. This used to be the default behaviour.
-# The new default is to treat a multi-line C++ comment block as a detailed
-# description. Set this tag to YES if you prefer the old behaviour instead.
-
-MULTILINE_CPP_IS_BRIEF = NO
-
-# If the DETAILS_AT_TOP tag is set to YES then Doxygen
-# will output the detailed description near the top, like JavaDoc.
-# If set to NO, the detailed description appears after the member
-# documentation.
-
-DETAILS_AT_TOP = NO
-
-# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
-# member inherits the documentation from any documented member that it
-# re-implements.
-
-INHERIT_DOCS = YES
-
-# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
-# a new page for each member. If set to NO, the documentation of a member will
-# be part of the file/class/namespace that contains it.
-
-SEPARATE_MEMBER_PAGES = NO
-
-# The TAB_SIZE tag can be used to set the number of spaces in a tab.
-# Doxygen uses this value to replace tabs by spaces in code fragments.
-
-TAB_SIZE = 4
-
-# This tag can be used to specify a number of aliases that acts
-# as commands in the documentation. An alias has the form "name=value".
-# For example adding "sideeffect=\par Side Effects:\n" will allow you to
-# put the command \sideeffect (or @sideeffect) in the documentation, which
-# will result in a user-defined paragraph with heading "Side Effects:".
-# You can put \n's in the value part of an alias to insert newlines.
-
-ALIASES =
-
-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
-# sources only. Doxygen will then generate output that is more tailored for C.
-# For instance, some of the names that are used will be different. The list
-# of all members will be omitted, etc.
-
-OPTIMIZE_OUTPUT_FOR_C = YES
-
-# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
-# sources only. Doxygen will then generate output that is more tailored for Java.
-# For instance, namespaces will be presented as packages, qualified scopes
-# will look different, etc.
-
-OPTIMIZE_OUTPUT_JAVA = NO
-
-# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
-# include (a tag file for) the STL sources as input, then you should
-# set this tag to YES in order to let doxygen match functions declarations and
-# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
-# func(std::string) {}). This also make the inheritance and collaboration
-# diagrams that involve STL classes more complete and accurate.
-
-BUILTIN_STL_SUPPORT = NO
-
-# If you use Microsoft's C++/CLI language, you should set this option to YES to
-# enable parsing support.
-
-CPP_CLI_SUPPORT = NO
-
-# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
-# tag is set to YES, then doxygen will reuse the documentation of the first
-# member in the group (if any) for the other members of the group. By default
-# all members of a group must be documented explicitly.
-
-DISTRIBUTE_GROUP_DOC = NO
-
-# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
-# the same type (for instance a group of public functions) to be put as a
-# subgroup of that type (e.g. under the Public Functions section). Set it to
-# NO to prevent subgrouping. Alternatively, this can be done per class using
-# the \nosubgrouping command.
-
-SUBGROUPING = YES
-
-#---------------------------------------------------------------------------
-# Build related configuration options
-#---------------------------------------------------------------------------
-
-# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
-# documentation are documented, even if no documentation was available.
-# Private class members and static file members will be hidden unless
-# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
-
-EXTRACT_ALL = YES
-
-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
-# will be included in the documentation.
-
-EXTRACT_PRIVATE = YES
-
-# If the EXTRACT_STATIC tag is set to YES all static members of a file
-# will be included in the documentation.
-
-EXTRACT_STATIC = YES
-
-# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
-# defined locally in source files will be included in the documentation.
-# If set to NO only classes defined in header files are included.
-
-EXTRACT_LOCAL_CLASSES = YES
-
-# This flag is only useful for Objective-C code. When set to YES local
-# methods, which are defined in the implementation section but not in
-# the interface are included in the documentation.
-# If set to NO (the default) only methods in the interface are included.
-
-EXTRACT_LOCAL_METHODS = NO
-
-# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
-# undocumented members of documented classes, files or namespaces.
-# If set to NO (the default) these members will be included in the
-# various overviews, but no documentation section is generated.
-# This option has no effect if EXTRACT_ALL is enabled.
-
-HIDE_UNDOC_MEMBERS = NO
-
-# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
-# undocumented classes that are normally visible in the class hierarchy.
-# If set to NO (the default) these classes will be included in the various
-# overviews. This option has no effect if EXTRACT_ALL is enabled.
-
-HIDE_UNDOC_CLASSES = NO
-
-# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
-# friend (class|struct|union) declarations.
-# If set to NO (the default) these declarations will be included in the
-# documentation.
-
-HIDE_FRIEND_COMPOUNDS = NO
-
-# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
-# documentation blocks found inside the body of a function.
-# If set to NO (the default) these blocks will be appended to the
-# function's detailed documentation block.
-
-HIDE_IN_BODY_DOCS = NO
-
-# The INTERNAL_DOCS tag determines if documentation
-# that is typed after a \internal command is included. If the tag is set
-# to NO (the default) then the documentation will be excluded.
-# Set it to YES to include the internal documentation.
-
-INTERNAL_DOCS = NO
-
-# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
-# file names in lower-case letters. If set to YES upper-case letters are also
-# allowed. This is useful if you have classes or files whose names only differ
-# in case and if your file system supports case sensitive file names. Windows
-# and Mac users are advised to set this option to NO.
-
-CASE_SENSE_NAMES = YES
-
-# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
-# will show members with their full class and namespace scopes in the
-# documentation. If set to YES the scope will be hidden.
-
-HIDE_SCOPE_NAMES = NO
-
-# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
-# will put a list of the files that are included by a file in the documentation
-# of that file.
-
-SHOW_INCLUDE_FILES = YES
-
-# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
-# is inserted in the documentation for inline members.
-
-INLINE_INFO = YES
-
-# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
-# will sort the (detailed) documentation of file and class members
-# alphabetically by member name. If set to NO the members will appear in
-# declaration order.
-
-SORT_MEMBER_DOCS = NO
-
-# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
-# brief documentation of file, namespace and class members alphabetically
-# by member name. If set to NO (the default) the members will appear in
-# declaration order.
-
-SORT_BRIEF_DOCS = NO
-
-# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
-# sorted by fully-qualified names, including namespaces. If set to
-# NO (the default), the class list will be sorted only by class name,
-# not including the namespace part.
-# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
-# Note: This option applies only to the class list, not to the
-# alphabetical list.
-
-SORT_BY_SCOPE_NAME = NO
-
-# The GENERATE_TODOLIST tag can be used to enable (YES) or
-# disable (NO) the todo list. This list is created by putting \todo
-# commands in the documentation.
-
-GENERATE_TODOLIST = YES
-
-# The GENERATE_TESTLIST tag can be used to enable (YES) or
-# disable (NO) the test list. This list is created by putting \test
-# commands in the documentation.
-
-GENERATE_TESTLIST = YES
-
-# The GENERATE_BUGLIST tag can be used to enable (YES) or
-# disable (NO) the bug list. This list is created by putting \bug
-# commands in the documentation.
-
-GENERATE_BUGLIST = YES
-
-# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
-# disable (NO) the deprecated list. This list is created by putting
-# \deprecated commands in the documentation.
-
-GENERATE_DEPRECATEDLIST= YES
-
-# The ENABLED_SECTIONS tag can be used to enable conditional
-# documentation sections, marked by \if sectionname ... \endif.
-
-ENABLED_SECTIONS =
-
-# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
-# the initial value of a variable or define consists of for it to appear in
-# the documentation. If the initializer consists of more lines than specified
-# here it will be hidden. Use a value of 0 to hide initializers completely.
-# The appearance of the initializer of individual variables and defines in the
-# documentation can be controlled using \showinitializer or \hideinitializer
-# command in the documentation regardless of this setting.
-
-MAX_INITIALIZER_LINES = 30
-
-# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
-# at the bottom of the documentation of classes and structs. If set to YES the
-# list will mention the files that were used to generate the documentation.
-
-SHOW_USED_FILES = YES
-
-# If the sources in your project are distributed over multiple directories
-# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
-# in the documentation. The default is NO.
-
-SHOW_DIRECTORIES = NO
-
-# The FILE_VERSION_FILTER tag can be used to specify a program or script that
-# doxygen should invoke to get the current version for each file (typically from the
-# version control system). Doxygen will invoke the program by executing (via
-# popen()) the command <command> <input-file>, where <command> is the value of
-# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
-# provided by doxygen. Whatever the program writes to standard output
-# is used as the file version. See the manual for examples.
-
-FILE_VERSION_FILTER =
-
-#---------------------------------------------------------------------------
-# configuration options related to warning and progress messages
-#---------------------------------------------------------------------------
-
-# The QUIET tag can be used to turn on/off the messages that are generated
-# by doxygen. Possible values are YES and NO. If left blank NO is used.
-
-QUIET = NO
-
-# The WARNINGS tag can be used to turn on/off the warning messages that are
-# generated by doxygen. Possible values are YES and NO. If left blank
-# NO is used.
-
-WARNINGS = YES
-
-# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
-# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
-# automatically be disabled.
-
-WARN_IF_UNDOCUMENTED = YES
-
-# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
-# potential errors in the documentation, such as not documenting some
-# parameters in a documented function, or documenting parameters that
-# don't exist or using markup commands wrongly.
-
-WARN_IF_DOC_ERROR = YES
-
-# This WARN_NO_PARAMDOC option can be abled to get warnings for
-# functions that are documented, but have no documentation for their parameters
-# or return value. If set to NO (the default) doxygen will only warn about
-# wrong or incomplete parameter documentation, but not about the absence of
-# documentation.
-
-WARN_NO_PARAMDOC = NO
-
-# The WARN_FORMAT tag determines the format of the warning messages that
-# doxygen can produce. The string should contain the $file, $line, and $text
-# tags, which will be replaced by the file and line number from which the
-# warning originated and the warning text. Optionally the format may contain
-# $version, which will be replaced by the version of the file (if it could
-# be obtained via FILE_VERSION_FILTER)
-
-WARN_FORMAT = "$file:$line: $text"
-
-# The WARN_LOGFILE tag can be used to specify a file to which warning
-# and error messages should be written. If left blank the output is written
-# to stderr.
-
-WARN_LOGFILE =
-
-#---------------------------------------------------------------------------
-# configuration options related to the input files
-#---------------------------------------------------------------------------
-
-# The INPUT tag can be used to specify the files and/or directories that contain
-# documented source files. You may enter file names like "myfile.cpp" or
-# directories like "/usr/src/myproject". Separate the files or directories
-# with spaces.
-
-INPUT =
-
-# This tag can be used to specify the character encoding of the source files that
-# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
-# input encoding. Doxygen uses libiconv (or the iconv built into libc) for the transcoding.
-# See http://www.gnu.org/software/libiconv for the list of possible encodings.
-
-INPUT_ENCODING = UTF-8
-
-# If the value of the INPUT tag contains directories, you can use the
-# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
-# and *.h) to filter out the source-files in the directories. If left
-# blank the following patterns are tested:
-# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
-# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
-
-FILE_PATTERNS =
-
-# The RECURSIVE tag can be used to turn specify whether or not subdirectories
-# should be searched for input files as well. Possible values are YES and NO.
-# If left blank NO is used.
-
-RECURSIVE = YES
-
-# The EXCLUDE tag can be used to specify files and/or directories that should
-# excluded from the INPUT source files. This way you can easily exclude a
-# subdirectory from a directory tree whose root is specified with the INPUT tag.
-
-EXCLUDE =
-
-# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
-# directories that are symbolic links (a Unix filesystem feature) are excluded
-# from the input.
-
-EXCLUDE_SYMLINKS = NO
-
-# If the value of the INPUT tag contains directories, you can use the
-# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
-# certain files from those directories. Note that the wildcards are matched
-# against the file with absolute path, so to exclude all test directories
-# for example use the pattern */test/*
-
-EXCLUDE_PATTERNS = */.svn/* */dep/*
-
-# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
-# (namespaces, classes, functions, etc.) that should be excluded from the output.
-# The symbol name can be a fully qualified name, a word, or if the wildcard * is used,
-# a substring. Examples: ANamespace, AClass, AClass::ANamespace, ANamespace::*Test
-
-EXCLUDE_SYMBOLS =
-
-# The EXAMPLE_PATH tag can be used to specify one or more files or
-# directories that contain example code fragments that are included (see
-# the \include command).
-
-EXAMPLE_PATH =
-
-# If the value of the EXAMPLE_PATH tag contains directories, you can use the
-# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
-# and *.h) to filter out the source-files in the directories. If left
-# blank all files are included.
-
-EXAMPLE_PATTERNS =
-
-# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
-# searched for input files to be used with the \include or \dontinclude
-# commands irrespective of the value of the RECURSIVE tag.
-# Possible values are YES and NO. If left blank NO is used.
-
-EXAMPLE_RECURSIVE = NO
-
-# The IMAGE_PATH tag can be used to specify one or more files or
-# directories that contain image that are included in the documentation (see
-# the \image command).
-
-IMAGE_PATH = doc
-
-# The INPUT_FILTER tag can be used to specify a program that doxygen should
-# invoke to filter for each input file. Doxygen will invoke the filter program
-# by executing (via popen()) the command <filter> <input-file>, where <filter>
-# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
-# input file. Doxygen will then use the output that the filter program writes
-# to standard output. If FILTER_PATTERNS is specified, this tag will be
-# ignored.
-
-INPUT_FILTER =
-
-# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
-# basis. Doxygen will compare the file name with each pattern and apply the
-# filter if there is a match. The filters are a list of the form:
-# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
-# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
-# is applied to all files.
-
-FILTER_PATTERNS =
-
-# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
-# INPUT_FILTER) will be used to filter the input files when producing source
-# files to browse (i.e. when SOURCE_BROWSER is set to YES).
-
-FILTER_SOURCE_FILES = NO
-
-#---------------------------------------------------------------------------
-# configuration options related to source browsing
-#---------------------------------------------------------------------------
-
-# If the SOURCE_BROWSER tag is set to YES then a list of source files will
-# be generated. Documented entities will be cross-referenced with these sources.
-# Note: To get rid of all source code in the generated output, make sure also
-# VERBATIM_HEADERS is set to NO.
-
-SOURCE_BROWSER = YES
-
-# Setting the INLINE_SOURCES tag to YES will include the body
-# of functions and classes directly in the documentation.
-
-INLINE_SOURCES = NO
-
-# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
-# doxygen to hide any special comment blocks from generated source code
-# fragments. Normal C and C++ comments will always remain visible.
-
-STRIP_CODE_COMMENTS = NO
-
-# If the REFERENCED_BY_RELATION tag is set to YES (the default)
-# then for each documented function all documented
-# functions referencing it will be listed.
-
-REFERENCED_BY_RELATION = YES
-
-# If the REFERENCES_RELATION tag is set to YES (the default)
-# then for each documented function all documented entities
-# called/used by that function will be listed.
-
-REFERENCES_RELATION = YES
-
-# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
-# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
-# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
-# link to the source code. Otherwise they will link to the documentstion.
-
-REFERENCES_LINK_SOURCE = YES
-
-# If the USE_HTAGS tag is set to YES then the references to source code
-# will point to the HTML generated by the htags(1) tool instead of doxygen
-# built-in source browser. The htags tool is part of GNU's global source
-# tagging system (see http://www.gnu.org/software/global/global.html). You
-# will need version 4.8.6 or higher.
-
-USE_HTAGS = NO
-
-# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
-# will generate a verbatim copy of the header file for each class for
-# which an include is specified. Set to NO to disable this.
-
-VERBATIM_HEADERS = YES
-
-#---------------------------------------------------------------------------
-# configuration options related to the alphabetical class index
-#---------------------------------------------------------------------------
-
-# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
-# of all compounds will be generated. Enable this if the project
-# contains a lot of classes, structs, unions or interfaces.
-
-ALPHABETICAL_INDEX = NO
-
-# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
-# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
-# in which this list will be split (can be a number in the range [1..20])
-
-COLS_IN_ALPHA_INDEX = 5
-
-# In case all classes in a project start with a common prefix, all
-# classes will be put under the same header in the alphabetical index.
-# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
-# should be ignored while generating the index headers.
-
-IGNORE_PREFIX =
-
-#---------------------------------------------------------------------------
-# configuration options related to the HTML output
-#---------------------------------------------------------------------------
-
-# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
-# generate HTML output.
-
-GENERATE_HTML = YES
-
-# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
-# put in front of it. If left blank `html' will be used as the default path.
-
-HTML_OUTPUT = html
-
-# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
-# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
-# doxygen will generate files with .html extension.
-
-HTML_FILE_EXTENSION = .html
-
-# The HTML_HEADER tag can be used to specify a personal HTML header for
-# each generated HTML page. If it is left blank doxygen will generate a
-# standard header.
-
-HTML_HEADER =
-
-# The HTML_FOOTER tag can be used to specify a personal HTML footer for
-# each generated HTML page. If it is left blank doxygen will generate a
-# standard footer.
-
-HTML_FOOTER =
-
-# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
-# style sheet that is used by each HTML page. It can be used to
-# fine-tune the look of the HTML output. If the tag is left blank doxygen
-# will generate a default style sheet. Note that doxygen will try to copy
-# the style sheet file to the HTML output directory, so don't put your own
-# stylesheet in the HTML output directory as well, or it will be erased!
-
-HTML_STYLESHEET =
-
-# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
-# files or namespaces will be aligned in HTML using tables. If set to
-# NO a bullet list will be used.
-
-HTML_ALIGN_MEMBERS = YES
-
-# If the GENERATE_HTMLHELP tag is set to YES, additional index files
-# will be generated that can be used as input for tools like the
-# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
-# of the generated HTML documentation.
-
-GENERATE_HTMLHELP = NO
-
-# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
-# be used to specify the file name of the resulting .chm file. You
-# can add a path in front of the file if the result should not be
-# written to the html output directory.
-
-CHM_FILE =
-
-# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
-# be used to specify the location (absolute path including file name) of
-# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
-# the HTML help compiler on the generated index.hhp.
-
-HHC_LOCATION =
-
-# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
-# controls if a separate .chi index file is generated (YES) or that
-# it should be included in the master .chm file (NO).
-
-GENERATE_CHI = NO
-
-# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
-# controls whether a binary table of contents is generated (YES) or a
-# normal table of contents (NO) in the .chm file.
-
-BINARY_TOC = NO
-
-# The TOC_EXPAND flag can be set to YES to add extra items for group members
-# to the contents of the HTML help documentation and to the tree view.
-
-TOC_EXPAND = NO
-
-# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
-# top of each HTML page. The value NO (the default) enables the index and
-# the value YES disables it.
-
-DISABLE_INDEX = NO
-
-# This tag can be used to set the number of enum values (range [1..20])
-# that doxygen will group on one line in the generated HTML documentation.
-
-ENUM_VALUES_PER_LINE = 4
-
-# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
-# generated containing a tree-like index structure (just like the one that
-# is generated for HTML Help). For this to work a browser that supports
-# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
-# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
-# probably better off using the HTML help feature.
-
-GENERATE_TREEVIEW = NO
-
-# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
-# used to set the initial width (in pixels) of the frame in which the tree
-# is shown.
-
-TREEVIEW_WIDTH = 250
-
-#---------------------------------------------------------------------------
-# configuration options related to the LaTeX output
-#---------------------------------------------------------------------------
-
-# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
-# generate Latex output.
-
-GENERATE_LATEX = NO
-
-# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
-# put in front of it. If left blank `latex' will be used as the default path.
-
-LATEX_OUTPUT = latex
-
-# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
-# invoked. If left blank `latex' will be used as the default command name.
-
-LATEX_CMD_NAME = latex
-
-# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
-# generate index for LaTeX. If left blank `makeindex' will be used as the
-# default command name.
-
-MAKEINDEX_CMD_NAME = makeindex
-
-# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
-# LaTeX documents. This may be useful for small projects and may help to
-# save some trees in general.
-
-COMPACT_LATEX = NO
-
-# The PAPER_TYPE tag can be used to set the paper type that is used
-# by the printer. Possible values are: a4, a4wide, letter, legal and
-# executive. If left blank a4wide will be used.
-
-PAPER_TYPE = a4wide
-
-# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
-# packages that should be included in the LaTeX output.
-
-EXTRA_PACKAGES =
-
-# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
-# the generated latex document. The header should contain everything until
-# the first chapter. If it is left blank doxygen will generate a
-# standard header. Notice: only use this tag if you know what you are doing!
-
-LATEX_HEADER =
-
-# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
-# is prepared for conversion to pdf (using ps2pdf). The pdf file will
-# contain links (just like the HTML output) instead of page references
-# This makes the output suitable for online browsing using a pdf viewer.
-
-PDF_HYPERLINKS = NO
-
-# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
-# plain latex in the generated Makefile. Set this option to YES to get a
-# higher quality PDF documentation.
-
-USE_PDFLATEX = NO
-
-# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
-# command to the generated LaTeX files. This will instruct LaTeX to keep
-# running if errors occur, instead of asking the user for help.
-# This option is also used when generating formulas in HTML.
-
-LATEX_BATCHMODE = NO
-
-# If LATEX_HIDE_INDICES is set to YES then doxygen will not
-# include the index chapters (such as File Index, Compound Index, etc.)
-# in the output.
-
-LATEX_HIDE_INDICES = NO
-
-#---------------------------------------------------------------------------
-# configuration options related to the RTF output
-#---------------------------------------------------------------------------
-
-# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
-# The RTF output is optimized for Word 97 and may not look very pretty with
-# other RTF readers or editors.
-
-GENERATE_RTF = NO
-
-# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
-# put in front of it. If left blank `rtf' will be used as the default path.
-
-RTF_OUTPUT = rtf
-
-# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
-# RTF documents. This may be useful for small projects and may help to
-# save some trees in general.
-
-COMPACT_RTF = NO
-
-# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
-# will contain hyperlink fields. The RTF file will
-# contain links (just like the HTML output) instead of page references.
-# This makes the output suitable for online browsing using WORD or other
-# programs which support those fields.
-# Note: wordpad (write) and others do not support links.
-
-RTF_HYPERLINKS = NO
-
-# Load stylesheet definitions from file. Syntax is similar to doxygen's
-# config file, i.e. a series of assignments. You only have to provide
-# replacements, missing definitions are set to their default value.
-
-RTF_STYLESHEET_FILE =
-
-# Set optional variables used in the generation of an rtf document.
-# Syntax is similar to doxygen's config file.
-
-RTF_EXTENSIONS_FILE =
-
-#---------------------------------------------------------------------------
-# configuration options related to the man page output
-#---------------------------------------------------------------------------
-
-# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
-# generate man pages
-
-GENERATE_MAN = NO
-
-# The MAN_OUTPUT tag is used to specify where the man pages will be put.
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be
-# put in front of it. If left blank `man' will be used as the default path.
-
-MAN_OUTPUT = man
-
-# The MAN_EXTENSION tag determines the extension that is added to
-# the generated man pages (default is the subroutine's section .3)
-
-MAN_EXTENSION = .3
-
-# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
-# then it will generate one additional man file for each entity
-# documented in the real man page(s). These additional files
-# only source the real man page, but without them the man command
-# would be unable to find the correct page. The default is NO.
-
-MAN_LINKS = NO
-
-#----------------------------------------------------...
[truncated message content] |
