# This is Doxygen configuration file
#
# Doxygen provides over 260 configuration statements
# To make this file easier to follow,
# it contains only statements that are non-default
#
# NOTE:
# It is recommended not to change defaults unless specifically required
# Test any changes how they affect generated documentation
# Make sure that correct warnings are generated to flag issues with documented code
#
# For the complete list of configuration statements see:
# https://www.stack.nl/~dimitri/doxygen/manual/config.html


PROJECT_NAME = "Espressif DSP Library"

## The 'INPUT' statement below is used as input by script 'gen-df-input.py'
## to automatically generate API reference list files heder_file.inc
## These files are placed in '_inc' directory
## and used to include in API reference documentation

INPUT = \
    ##
    ## Common - API Reference
    ##
    ../modules/common/include/dsp_common.h \
    ## Dot Product - API Reference
    ../modules/dotprod/include/dsps_dotprod.h \
    ## FFT - API Reference
    ../modules/fft/include/dsps_fft2r.h \
    ## DCT - API Reference
    ../modules/dct/include/dsps_dct.h \
    ## FIR Filter - API Reference
    ../modules/fir/include/dsps_fir.h \
    ## IIR Filter - API Reference
    ../modules/iir/include/dsps_biquad_gen.h \
    ../modules/iir/include/dsps_biquad.h \
    ## Math - API Reference
    ../modules/math/mulc/include/dsps_mulc.h \
    ../modules/math/addc/include/dsps_addc.h \
    ../modules/math/add/include/dsps_add.h \
    ../modules/math/sub/include/dsps_sub.h \
    ../modules/math/mul/include/dsps_mul.h \
    ## Matrix - API Reference
    ../modules/matrix/include/dspm_mult.h \
    ../modules/matrix/include/mat.h \
    ## Convolution/Cprrelation - API Reference
    ../modules/conv/include/dsps_conv.h \
    ../modules/conv/include/dsps_corr.h \
    ## Support - API Reference
    ../modules/support/include/dsps_view.h \
    ../modules/support/include/dsps_tone_gen.h \
    ../modules/support/include/dsps_snr.h \
    ../modules/support/include/dsps_sfdr.h \
    ../modules/support/include/dsps_d_gen.h \
    ../modules/support/include/dsps_h_gen.h \
    ## Windows - API Reference
    ../modules/windows/hann/include/dsps_wind_hann.h \
    ../modules/windows/blackman/include/dsps_wind_blackman.h \
    ../modules/windows/blackman_harris/include/dsps_wind_blackman_harris.h \
    ../modules/windows/blackman_nuttall/include/dsps_wind_blackman_nuttall.h \
    ../modules/windows/nuttall/include/dsps_wind_nuttall.h \
    ../modules/windows/flat_top/include/dsps_wind_flat_top.h


## Get warnings for functions that have no documentation for their parameters or return value
##
WARN_NO_PARAMDOC = YES

## Enable preprocessing and remove __attribute__(...) expressions from the INPUT files
##
ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
PREDEFINED             = \
    __attribute__(x)= \
    IRAM_ATTR= \
    configSUPPORT_DYNAMIC_ALLOCATION=1 \
    configSUPPORT_STATIC_ALLOCATION=1 \
    configQUEUE_REGISTRY_SIZE=1 \
    configUSE_RECURSIVE_MUTEXES=1 \
    configTHREAD_LOCAL_STORAGE_DELETE_CALLBACKS=1 \
    configNUM_THREAD_LOCAL_STORAGE_POINTERS=1 \
    configUSE_APPLICATION_TASK_TAG=1 \
    configTASKLIST_INCLUDE_COREID=1

## Do not complain about not having dot
##
HAVE_DOT = NO

## Generate XML that is required for Breathe
##
GENERATE_XML    = YES
XML_OUTPUT      = xml

GENERATE_HTML   = NO
HAVE_DOT        = NO
GENERATE_LATEX  = NO
GENERATE_MAN    = YES
GENERATE_RTF    = NO

## Skip distracting progress messages
##
QUIET = YES
## Log warnings in a file for further review
##
WARN_LOGFILE = "doxygen-warning-log.txt"