# 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 = "Beken Armino Development Framework"

## 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 = \
    ## Multi-Media
    ../../../bk_idk/include/driver/aud_adc.h \
    ../../../bk_idk/include/driver/aud_adc_types.h \
    ../../../bk_idk/include/driver/aud_dac.h \
    ../../../bk_idk/include/driver/aud_dac_types.h \
    ../../../bk_idk/include/driver/hal/hal_aud_types.h \
    ../../../bk_idk/include/driver/lcd.h \
    ../../../bk_idk/include/driver/lcd_types.h \
    ../../../bk_idk/include/driver/dma2d.h \
    ../../../bk_idk/include/driver/dma2d_types.h \
    ../../../bk_idk/include/driver/jpeg_dec.h \
    ../../../bk_idk/include/driver/jpeg_dec_types.h \
    ../../../bk_idk/include/driver/sbc.h \
    ../../../bk_idk/include/driver/sbc_types.h \
    ../../../bk_idk/include/driver/jpeg_enc.h \
    ../../../bk_idk/include/driver/jpeg_enc_types.h \
    ../../../bk_idk/include/driver/hal/hal_jpeg_types.h \
    ../../../bk_idk/include/driver/dvp_camera.h \
    ../../../bk_idk/include/driver/dvp_camera_types.h \
    ../../../bk_idk/include/driver/uvc_camera.h \
    ../../../bk_idk/include/driver/uvc_camera_types.h \
    ../../../bk_idk/include/driver/media_types.h \
    ../../../bk_idk/include/components/video_transfer.h \
    ../../../bk_idk/include/components/video_types.h \
    ../../../bk_idk/include/modules/jpeg_decode_sw.h \
    ../../../bk_idk/include/modules/jpeg_enc_sw.h \
    ../../../bk_idk/include/modules/aec.h \
    ../../../bk_idk/include/modules/g711.h \
    ../../../bk_idk/include/driver/rott_driver.h \
    ../../../bk_idk/include/driver/rott_types.h \
    ../../../bk_idk/include/modules/mp3dec.h \
    ../../../bk_idk/include/modules/image_scale.h \
    ../../../bk_idk/include/driver/hw_scale.h \
    ../../../bk_idk/include/driver/hw_scale_types.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 \


## 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"